Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ProtectionPolicy

The details of a protection policy.A policy defines the exact number of days to retain protected database backups created by Recovery Service. Each protected database must be associated with one protection policy. You can use Oracle-defined protection policies or create custom policies to suit your internal backup storage regulation demands.

Properties

backupRetentionPeriodInDays

backupRetentionPeriodInDays: number

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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

compartmentId

compartmentId: string

The OCID of the compartment that contains the protection policy.

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

A user provided name for the protection policy.

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"}}

id

id: string

The protection policy OCID.

isPredefinedPolicy

isPredefinedPolicy: boolean

Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You can modify only the custom policies.

Optional lifecycleDetails

lifecycleDetails: undefined | string

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.

Optional lifecycleState

lifecycleState: model.LifecycleState

The current state of the protection policy.

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.

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 the protection policy. For example: '2020-05-22T21:10:29.600Z'.

Optional timeUpdated

timeUpdated: Date

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

Functions

getDeserializedJsonObj

getJsonObj