Package 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.104.0 (build e79254c)",
           date="2024-11-27T16:50:55.892Z")
@Stability(Stable)
public interface BackupProps
extends software.amazon.jsii.JsiiSerializable

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.*;
 import software.amazon.awscdk.services.docdb.*;
 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	Description
static final class	BackupProps.Builder	A builder for BackupProps
static final class	BackupProps.Jsii$Proxy	An implementation for BackupProps

Method Summary

Modifier and Type	Method	Description
static BackupProps.Builder	builder()
default 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRetention

@Stability(Stable)
@NotNull
Duration getRetention()

How many days to retain the backup.

getPreferredWindow

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
static BackupProps.Builder builder()

Returns:

a BackupProps.Builder of BackupProps