software.amazon.awscdk.services.rds

Interface BackupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BackupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:36.051Z")
 @Stability(value=Experimental)
public interface BackupProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Backup configuration for RDS 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.core.*;
 import software.amazon.awscdk.services.rds.*;
 Duration duration;
 BackupProps backupProps = BackupProps.builder()
         .retention(duration)
         // the properties below are optional
         .preferredWindow("preferredWindow")
         .build();
 

See Also:

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow

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/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow

builder

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

Returns:

a BackupProps.Builder of BackupProps