Show / Hide Table of Contents

Interface BackupProps

(experimental) Backup configuration for DocumentDB databases.

  • The retention period for automated backups is 1 day. The preferred backup window will be a 30-minute window selected at random from an 8-hour block of time for each AWS Region. https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshots.html#backup-restore.backup-window

Synopsis

Properties

preferredWindow

(experimental) A daily time range in 24-hours UTC format in which backups preferably execute.

retention

(experimental) How many days to retain the backup.

Properties

preferredWindow

(experimental) A daily time range in 24-hours UTC format in which backups preferably execute.

Must be at least 30 minutes long.

Example: '01:00-02:00'

  • 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/documentdb/latest/developerguide/backup-restore.db-cluster-snapshots.html#backup-restore.backup-window
Declaration
readonly preferredWindow?: string;
Property Value

string

retention

(experimental) How many days to retain the backup.

Declaration
readonly retention: Duration;
Property Value

Duration

Back to top Generated by DocFX