software.amazon.awscdk.services.docdb

Interface BackupProps

All Known Implementing Classes:

BackupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-27T16:28:01.837Z")
public interface BackupProps

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.docdb.*;
 import software.amazon.awscdk.core.*;
 BackupProps backupProps = BackupProps.builder()
         .retention(Duration.minutes(30))
         // the properties below are optional
         .preferredWindow("preferredWindow")
         .build();
 

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 java.lang.String	getPreferredWindow() A daily time range in 24-hours UTC format in which backups preferably execute.
Duration	getRetention() How many days to retain the backup.

Method Detail

getRetention

Duration getRetention()

How many days to retain the backup.

getPreferredWindow

default java.lang.String getPreferredWindow()

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

static BackupProps.Builder builder()

Returns:

a BackupProps.Builder of BackupProps