BackupProps

class aws_cdk.aws_docdb.BackupProps(*, retention, preferred_window=None)

Bases: object

Backup configuration for DocumentDB databases.

Parameters
Default

  • 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.

See

https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshots.html#backup-restore.backup-window

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_docdb as docdb
import aws_cdk.core as cdk

backup_props = docdb.BackupProps(
    retention=cdk.Duration.minutes(30),

    # the properties below are optional
    preferred_window="preferredWindow"
)

Attributes

preferred_window

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’

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/documentdb/latest/developerguide/backup-restore.db-cluster-snapshots.html#backup-restore.backup-window

Return type

Optional[str]

retention

How many days to retain the backup.

Return type

Duration