software.amazon.awscdk.services.backup

Interface BackupPlanRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BackupPlanRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.849Z")
 @Stability(value=Stable)
public interface BackupPlanRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for a BackupPlanRule.

Example:

 BackupPlan plan;
 plan.addRule(BackupPlanRule.Builder.create()
         .completionWindow(Duration.hours(2))
         .startWindow(Duration.hours(1))
         .scheduleExpression(Schedule.cron(CronOptions.builder() // Only cron expressions are supported
                 .day("15")
                 .hour("3")
                 .minute("30").build()))
         .moveToColdStorageAfter(Duration.days(30))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static BackupPlanRuleProps.Builder	builder()
default IBackupVault	getBackupVault() The backup vault where backups are.
default Duration	getCompletionWindow() The duration after a backup job is successfully started before it must be completed or it is canceled by AWS Backup.
default Duration	getDeleteAfter() Specifies the duration after creation that a recovery point is deleted.
default Boolean	getEnableContinuousBackup() Enables continuous backup and point-in-time restores (PITR).
default Duration	getMoveToColdStorageAfter() Specifies the duration after creation that a recovery point is moved to cold storage.
default String	getRuleName() A display name for the backup rule.
default Schedule	getScheduleExpression() A CRON expression specifying when AWS Backup initiates a backup job.
default Duration	getStartWindow() The duration after a backup is scheduled before a job is canceled if it doesn't start successfully.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBackupVault

@Stability(value=Stable)
 @Nullable
default IBackupVault getBackupVault()

The backup vault where backups are.

Default: - use the vault defined at the plan level. If not defined a new common vault for the plan will be created

getCompletionWindow

@Stability(value=Stable)
 @Nullable
default Duration getCompletionWindow()

The duration after a backup job is successfully started before it must be completed or it is canceled by AWS Backup.

Default: - 8 hours

getDeleteAfter

@Stability(value=Stable)
 @Nullable
default Duration getDeleteAfter()

Specifies the duration after creation that a recovery point is deleted.

Must be greater than moveToColdStorageAfter.

Default: - recovery point is never deleted

getEnableContinuousBackup

@Stability(value=Stable)
 @Nullable
default Boolean getEnableContinuousBackup()

Enables continuous backup and point-in-time restores (PITR).

Property deleteAfter defines the retention period for the backup. It is mandatory if PITR is enabled. If no value is specified, the retention period is set to 35 days which is the maximum retention period supported by PITR.

Property moveToColdStorageAfter must not be specified because PITR does not support this option.

Default: false

getMoveToColdStorageAfter

@Stability(value=Stable)
 @Nullable
default Duration getMoveToColdStorageAfter()

Specifies the duration after creation that a recovery point is moved to cold storage.

Default: - recovery point is never moved to cold storage

getRuleName

@Stability(value=Stable)
 @Nullable
default String getRuleName()

A display name for the backup rule.

Default: - a CDK generated name

getScheduleExpression

@Stability(value=Stable)
 @Nullable
default Schedule getScheduleExpression()

A CRON expression specifying when AWS Backup initiates a backup job.

Default: - no schedule

getStartWindow

@Stability(value=Stable)
 @Nullable
default Duration getStartWindow()

The duration after a backup is scheduled before a job is canceled if it doesn't start successfully.

Default: - 8 hours

builder

@Stability(value=Stable)
static BackupPlanRuleProps.Builder builder()

Returns:

a BackupPlanRuleProps.Builder of BackupPlanRuleProps