Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DbBackupConfig

Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Properties

Optional autoBackupEnabled

autoBackupEnabled: undefined | false | true

If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

Optional autoBackupWindow

autoBackupWindow: AutoBackupWindow

Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive).

Example: {@code SLOT_TWO}

Optional autoFullBackupDay

autoFullBackupDay: AutoFullBackupDay

Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.

Optional autoFullBackupWindow

autoFullBackupWindow: AutoFullBackupWindow

Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive).

Example: {@code SLOT_TWO}

Optional backupDeletionPolicy

backupDeletionPolicy: BackupDeletionPolicy

This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.

Optional backupDestinationDetails

backupDestinationDetails: Array<BackupDestinationDetails>

Backup destination details.

Optional recoveryWindowInDays

recoveryWindowInDays: undefined | number

Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional runImmediateFullBackup

runImmediateFullBackup: undefined | false | true

If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

Functions

getDeserializedJsonObj

getJsonObj