Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ProtectedDatabaseSummary

A protected database is an Oracle Cloud Database whose backups are managed by Oracle Database Autonomous Recovery Service. Each protected database requires a recovery service subnet and a protection policy to use Recovery Service as the backup destination for centralized backup and recovery.

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

For information about access control and compartments, see [Overview of the Identity Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains the protected database.

Optional databaseId

databaseId: undefined | string

The OCID of the protected database.

databaseSize

databaseSize: DatabaseSizes

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.

dbUniqueName

dbUniqueName: string

The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}. For more information, see Resource Tags

Optional displayName

displayName: undefined | string

The protected database name. You can change the displayName. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

Optional health

health: model.Health

The health of the Protected Database.

Optional healthDetails

healthDetails: undefined | string

A message describing the current health of the protected database.

id

id: string

The OCID of the protected database.

Optional isReadOnlyResource

isReadOnlyResource: undefined | false | true

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.

Optional lifecycleDetails

lifecycleDetails: undefined | string

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.

Optional lifecycleState

lifecycleState: model.LifecycleState

The current state of the Protected Database.

Optional metrics

metrics: model.MetricsSummary

Optional policyLockedDateTime

policyLockedDateTime: undefined | string

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.

protectionPolicyId

protectionPolicyId: string

The OCID of the protection policy associated with the protected database.

Optional recoveryServiceSubnets

recoveryServiceSubnets: Array<RecoveryServiceSubnetDetails>

List of recovery service subnet resources associated with the protected database.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}. For more information, see Resource Tags

Optional timeCreated

timeCreated: Date

An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'

Optional timeUpdated

timeUpdated: Date

An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'

vpcUserName

vpcUserName: string

The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.

Functions

getDeserializedJsonObj

getJsonObj