aws-cdk-lib.aws_docdb.BackupProps

BackupProps Struct

Backup configuration for DocumentDB databases.

Source

aws-docdb/lib/props.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_docdb as docdb } from 'aws-cdk-lib';
const backupProps: docdb.BackupProps = {
  retention: cdk.Duration.minutes(30),

  // the properties below are optional
  preferredWindow: 'preferredWindow',
};

Properties

preferredWindowstringpreferred_windowstrpreferredWindowStringPreferredWindowstringPreferredWindow*string= a 30-minute window selected at r…#

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

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

retentionDurationretentionDurationretentionDurationRetentionDurationRetentionDurationrequired#

How many days to retain the backup.