Interface OptOut

interface OptOut {
    backupRetention?: Duration;
    enabled: false;
    optOutReason: string;
    preferredBackupWindow?: string;
}

Hierarchy

  • Pick<DatabaseInstanceProps, "backupRetention" | "preferredBackupWindow">
    • OptOut

Properties

backupRetention? enabled optOutReason preferredBackupWindow?

Properties

Optional Readonly backupRetention

backupRetention?: Duration

The number of days during which automatic DB snapshots are retained. Set to zero to disable backups. When creating a read replica, you must enable automatic backups on the source database instance by setting the backup retention to a value other than zero.

Default

- Duration.days(1) for source instances, disabled for read replicas

enabled

enabled: false

optOutReason

optOutReason: string

We recommend using DevX Backups where possible. If it is not suitable for your use-case please document this here so that we can understand why this is switched off when performing security audits.

Optional Readonly preferredBackupWindow

preferredBackupWindow?: string

The daily time range during which automated backups are performed.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

Default

- a 30-minute window selected at random from an 8-hour block of
time for each AWS Region. To see the time blocks available, see
https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow

Settings

Member Visibility

Theme

On This Page

backupRetentionenabledoptOutReasonpreferredBackupWindow