Class BackupProps

(experimental) Backup configuration for DocumentDB databases.

Inheritance

System.Object

BackupProps

Implements

IBackupProps

Namespace: Amazon.CDK.AWS.DocDB

Assembly: Amazon.CDK.AWS.DocDB.dll

Syntax (csharp)

public class BackupProps : Object, IBackupProps

Syntax (vb)

Public Class BackupProps
    Inherits Object
    Implements IBackupProps

Remarks

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.

Stability: Experimental

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

Synopsis

Constructors

BackupProps()

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.

Constructors

BackupProps()

public BackupProps()

Properties

PreferredWindow

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

public string PreferredWindow { get; set; }

Property Value

System.String

Remarks

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

Stability: Experimental

Retention

(experimental) How many days to retain the backup.

public Duration Retention { get; set; }

Property Value

Duration

Remarks

Stability: Experimental

Implements

IBackupProps