Skip to content

recovery.oracle.com/v1beta1

Back to API Reference

APIVersion: recovery.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes recovery.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
ProtectedDatabase Namespaced Sample -
ProtectionPolicy Namespaced Sample -
RecoveryServiceSubnet Namespaced Sample -

ProtectedDatabase

ProtectedDatabase is the Schema for the protecteddatabases API.

  • Plural: protecteddatabases
  • Scope: Namespaced
  • APIVersion: recovery.oracle.com/v1beta1
  • Sample: Sample (config/samples/recovery_v1beta1_protecteddatabase.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ProtectedDatabaseSpec defines the desired state of ProtectedDatabase.

Field Description Type Required Default Enum
changeRate The percentage of data changes that exist in the database between successive incremental backups. number No - -
compartmentId The OCID of the compartment that contains the protected database. string Yes - -
compressionRatio The compression ratio of the protected database. The compression ratio represents the ratio of compressed block size to expanded block size. number No - -
databaseId The OCID of the protected database. string No - -
databaseSize The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB. string No - -
databaseSizeInGBs The size of the database, in gigabytes. integer No - -
dbUniqueName The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) map[string, map[string, string]] No - -
displayName The protected database name. You can change the displayName. Avoid entering confidential information. string Yes - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
isRedoLogsShipped The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. boolean No - -
password Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (#) or hyphen (-). The password must not contain the username "admin", regardless of casing. string Yes - -
protectionPolicyId The OCID of the protection policy associated with the protected database. string Yes - -
recoveryServiceSubnets List of recovery service subnet resources associated with the protected database. list[object] Yes - -
subscriptionId The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure. string No - -

Spec.recoveryServiceSubnets[]

Back to ProtectedDatabase spec

ProtectedDatabaseRecoveryServiceSubnet defines nested fields for ProtectedDatabase.RecoveryServiceSubnet.

Field Description Type Required Default Enum
recoveryServiceSubnetId The recovery service subnet OCID. string Yes - -

Status

ProtectedDatabaseStatus defines the observed state of ProtectedDatabase.

Field Description Type Required Default Enum
changeRate The percentage of data changes that exist in the database between successive incremental backups. number No - -
compartmentId The OCID of the compartment that contains the protected database. string No - -
compressionRatio The compression ratio of the protected database. The compression ratio represents the ratio of compressed block size to expanded block size. number No - -
databaseId The OCID of the protected database. string No - -
databaseSize The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB. string No - -
databaseSizeInGBs The size of the database in GBs, in gigabytes. integer No - -
dbUniqueName The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) map[string, map[string, string]] No - -
displayName The protected database name. You can change the displayName. Avoid entering confidential information. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
health Indicates the protection status of the database. A 'PROTECTED' status indicates that Recovery Service can ensure database recovery to any point in time within the entire recovery window. The potential data loss exposure since the last backup is: - Less than 10 seconds, if Real-time data protection is enabled - Less than 70 minutes if Real-time data protection is disabled A 'WARNING' status indicates that Recovery Service can ensure database recovery within the current recovery window - 1 day. The potential data loss exposure since the last backup is: - Greater than 10 seconds, if Real-time data protection is enabled - Greater than 60 minutes, if if Real-time data protection is disabled An 'ALERT' status indicates that Recovery Service cannot recover the database within the current recovery window. string No - -
healthDetails A message describing the current health of the protected database. string No - -
id The OCID of the protected database. string No - -
isReadOnlyResource Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database. boolean No - -
isRedoLogsShipped The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. For this to be effective, additional configuration is needed on client side. boolean No - -
lifecycleDetails Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state. string No - -
lifecycleState The current state of the Protected Database. string No - -
metrics ProtectedDatabaseMetrics defines nested fields for ProtectedDatabase.Metrics. object No - -
policyLockedDateTime An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy. The retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups. Recovery Service enforces a 14-day delay before the retention lock set for a policy can take effect. string No - -
protectionPolicyId The OCID of the protection policy associated with the protected database. string No - -
recoveryServiceSubnets List of recovery service subnet resources associated with the protected database. list[object] No - -
status - object Yes - -
subscriptionId The OCID of the cloud service subscription to which the protected database is linked. string No - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) map[string, map[string, string]] No - -
timeCreated An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z' string No - -
timeUpdated An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z' string No - -
vpcUserName The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service. string No - -

Status.metrics

Back to ProtectedDatabase status

ProtectedDatabaseMetrics defines nested fields for ProtectedDatabase.Metrics.

Field Description Type Required Default Enum
backupSpaceEstimateInGBs The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database. number No - -
backupSpaceUsedInGBs Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used. number No - -
currentRetentionPeriodInSeconds Number of seconds backups are currently retained for this database. number No - -
dbSizeInGBs The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs. number No - -
isRedoLogsEnabled The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. boolean No - -
minimumRecoveryNeededInDays Number of days of redo/archive to be applied to recover database. number No - -
retentionPeriodInDays The maximum number of days to retain backups for a protected database. number No - -
unprotectedWindowInSeconds This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. This is the time we received the last backup or last redo-log shipped. number No - -

Status.recoveryServiceSubnets[]

Back to ProtectedDatabase status

ProtectedDatabaseRecoveryServiceSubnet defines nested fields for ProtectedDatabase.RecoveryServiceSubnet.

Field Description Type Required Default Enum
recoveryServiceSubnetId The recovery service subnet OCID. string Yes - -

Status.status

Back to ProtectedDatabase status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to ProtectedDatabase status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to ProtectedDatabase status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to ProtectedDatabase status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

ProtectionPolicy

ProtectionPolicy is the Schema for the protectionpolicies API.

  • Plural: protectionpolicies
  • Scope: Namespaced
  • APIVersion: recovery.oracle.com/v1beta1
  • Sample: Sample (config/samples/recovery_v1beta1_protectionpolicy.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ProtectionPolicySpec defines the desired state of ProtectionPolicy.

Field Description Type Required Default Enum
backupRetentionPeriodInDays The maximum number of days to retain backups for a protected database. integer Yes - -
compartmentId Compartment Identifier string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) map[string, map[string, string]] No - -
displayName A user provided name for the protection policy. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information. string Yes - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
mustEnforceCloudLocality Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned. This parameter is applicable if your Oracle Database runs in a different cloud service environment, such as Microsoft Azure. If you set the mustEnforceCloudLocality parameter to TRUE, then Recovery Service stores the database backups locally in the same cloud service environment where the database resides. For example, if your Oracle Database is provisioned on Microsoft Azure, then Recovery Service stores the database backups in Azure. Note: You cannot change the mustEnforceCloudLocality setting for a protection policy after you create it. boolean No - -
policyLockedDateTime An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy. * The retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups. * Recovery Service enforces a 14-day delay before the retention lock set for a policy can take effect. Therefore, you must set policyLockedDateTime to a date that occurs 14 days after the current date. * For example, assuming that the current date is Aug 1, 2023 9 pm, you can set policyLockedDateTime to '2023-08-15T21:00:00.600Z' (Aug 15, 2023, 9:00 pm), or greater. * During the 14-day delay period, you can either increase or decrease the retention period in the policy. * However, you are only allowed to increase the retention period on or after the retention lock date. * You cannot change the value of policyLockedDateTime if the retention lock is already in effect. string No - -

Status

ProtectionPolicyStatus defines the observed state of ProtectionPolicy.

Field Description Type Required Default Enum
backupRetentionPeriodInDays The maximum number of days to retain backups for a protected database. Specify a period ranging from a minimum 14 days to a maximum 95 days. For example, specify the value 55 if you want to retain backups for 55 days. integer No - -
compartmentId The OCID of the compartment that contains the protection policy. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) map[string, map[string, string]] No - -
displayName A user provided name for the protection policy. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id The protection policy OCID. string No - -
isPredefinedPolicy Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You can modify only the custom policies. boolean No - -
lifecycleDetails Detailed description about the current lifecycle state of the protection policy. For example, it can be used to provide actionable information for a resource in a Failed state. string No - -
lifecycleState The current state of the protection policy. string No - -
mustEnforceCloudLocality Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned. boolean No - -
policyLockedDateTime An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy. string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) map[string, map[string, string]] No - -
timeCreated An RFC3339 formatted datetime string that indicates the created time for the protection policy. For example: '2020-05-22T21:10:29.600Z'. string No - -
timeUpdated An RFC3339 formatted datetime string that indicates the updated time for the protection policy. For example: '2020-05-22T21:10:29.600Z'. string No - -

Status.status

Back to ProtectionPolicy status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to ProtectionPolicy status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to ProtectionPolicy status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to ProtectionPolicy status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

RecoveryServiceSubnet

RecoveryServiceSubnet is the Schema for the recoveryservicesubnets API.

  • Plural: recoveryservicesubnets
  • Scope: Namespaced
  • APIVersion: recovery.oracle.com/v1beta1
  • Sample: Sample (config/samples/recovery_v1beta1_recoveryservicesubnet.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

RecoveryServiceSubnetSpec defines the desired state of RecoveryServiceSubnet.

Field Description Type Required Default Enum
compartmentId The compartment OCID. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) map[string, map[string, string]] No - -
displayName A user-provided name for the recovery service subnet. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information. string Yes - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
nsgIds A list of network security group (NSG) OCIDs that are associated with the Recovery Service subnet. You can specify a maximum of 5 unique OCIDs, which implies that you can associate a maximum of 5 NSGs to each Recovery Service subnet. Specify an empty array if you want to remove all the associated NSGs from a Recovery Service subnet. See NetworkSecurityGroup for more information. list[string] No - -
subnetId Deprecated. One of the subnets associated with the Recovery Service subnet. string No - -
subnets A list of OCIDs of the subnets associated with the Recovery Service subnet. list[string] No - -
vcnId The OCID of the virtual cloud network (VCN) that contains the recovery service subnet. You can create a single recovery service subnet per VCN. string Yes - -

Status

RecoveryServiceSubnetStatus defines the observed state of RecoveryServiceSubnet.

Field Description Type Required Default Enum
compartmentId The compartment OCID. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) map[string, map[string, string]] No - -
displayName A user-provided name for the recovery service subnet. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id The recovery service subnet OCID. string No - -
lifecycleDetails Detailed description about the current lifecycle state of the recovery service subnet. For example, it can be used to provide actionable information for a resource in a Failed state string No - -
lifecycleState The current state of the recovery service subnet. string No - -
nsgIds A list of network security group (NSG) OCIDs that are associated with the Recovery Service subnet. You can specify a maximum of 5 unique OCIDs, which implies that you can associate a maximum of 5 NSGs to each Recovery Service subnet. Specify an empty array if you want to remove all the associated NSGs from a Recovery Service subnet. See NetworkSecurityGroup for more information. list[string] No - -
status - object Yes - -
subnetId Deprecated. One of the subnets associated with the Recovery Service subnet. string No - -
subnets A list of OCIDs of all the subnets associated with the Recovery Service subnet. list[string] No - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) map[string, map[string, string]] No - -
timeCreated An RFC3339 formatted datetime string that indicates the last created time for a recovery service subnet. For example: '2020-05-22T21:10:29.600Z'. string No - -
timeUpdated An RFC3339 formatted datetime string that indicates the last updated time for a recovery service subnet. For example: '2020-05-22T21:10:29.600Z'. string No - -
vcnId VCN Identifier. string No - -

Status.status

Back to RecoveryServiceSubnet status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to RecoveryServiceSubnet status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to RecoveryServiceSubnet status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to RecoveryServiceSubnet status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -