Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ProtectionPolicySummary

Recovery Service enables policy driven backup storage management.

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

backupRetentionPeriodInDays

backupRetentionPeriodInDays: number

The maximum number of days to retain backups for a protected database. 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

The time the Protection Policy was created. An RFC3339 formatted datetime string

Optional timeUpdated

timeUpdated: Date

The time the Protection Policy was updated. An RFC3339 formatted datetime string

Functions

getDeserializedJsonObj

getJsonObj