Interface BackupProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
BackupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.95.0 (build f1ff514)", date="2024-03-26T18:09:22.073Z") @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:
  • 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