Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace BackupPolicy

The Backup policy for the DB System.

Properties

Optional copyPolicies

copyPolicies: Array<CopyPolicy>

List of policies of a DB system to schedule cross-region DB system backup copy.

The policy includes the name of the destination region to which the DB system backup will be copied, and an optional parameter which specifies the retention period of the copied DB system backup in days.

*Note:** Currently, only one policy can be specified in the list.

Optional definedTags

definedTags: undefined | object

Usage of predefined tag keys. These predefined keys are scoped to namespaces.

Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.

Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.

Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.

Example: {@code {\"bar-key\": \"value\"}}

isEnabled

isEnabled: boolean

If automated backups are enabled or disabled.

Optional pitrPolicy

pitrPolicy: model.PitrPolicy

retentionInDays

retentionInDays: number

The number of days automated backups are retained. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional softDelete

softDelete: model.SoftDelete

Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it.

windowStartTime

windowStartTime: string

The start of a 30-minute window of time in which daily, automated backups occur.

This should be in the format of the \"Time\" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.

At some point in the window, the system may incur a brief service disruption as the backup is performed.

If not defined, a window is selected from the following Region-based time-spans: - eu-frankfurt-1: 20:00 - 04:00 UTC - us-ashburn-1: 03:00 - 11:00 UTC - uk-london-1: 06:00 - 14:00 UTC - ap-tokyo-1: 13:00 - 21:00 - us-phoenix-1: 06:00 - 14:00

Functions

getDeserializedJsonObj

getJsonObj