software.amazon.awscdk.services.docdb

Interface BackupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BackupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:16.882Z")
 @Stability(value=Experimental)
public interface BackupProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Backup configuration for DocumentDB databases.

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 Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BackupProps.Builder A builder for BackupProps
static class	BackupProps.Jsii$Proxy An implementation for BackupProps

Method Summary

Modifier and Type	Method and Description
static BackupProps.Builder	builder()
default String	getPreferredWindow() (experimental) A daily time range in 24-hours UTC format in which backups preferably execute.
Duration	getRetention() (experimental) How many days to retain the backup.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRetention

@Stability(value=Experimental)
 @NotNull
Duration getRetention()

(experimental) How many days to retain the backup.

getPreferredWindow

@Stability(value=Experimental)
 @Nullable
default String getPreferredWindow()

(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'

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

builder

@Stability(value=Experimental)
static BackupProps.Builder builder()

Returns:

a BackupProps.Builder of BackupProps