Package software.amazon.awscdk.services.backup

Class BackupPlanRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.backup.BackupPlanRule

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-03T13:58:16.766Z")
@Stability(Stable)
public class BackupPlanRule
extends software.amazon.jsii.JsiiObject

A backup plan rule.

Example:

 BackupPlan plan;
 plan.addRule(BackupPlanRule.Builder.create()
         .enableContinuousBackup(true)
         .deleteAfter(Duration.days(14))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BackupPlanRule.Builder	A fluent builder for BackupPlanRule.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
	BackupPlanRule(BackupPlanRuleProps props)
protected	BackupPlanRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BackupPlanRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static BackupPlanRule	daily()	Daily with 35 days retention.
static BackupPlanRule	daily(IBackupVaultRef backupVault)	Daily with 35 days retention.
BackupPlanRuleProps	getProps()	Properties of BackupPlanRule.
static BackupPlanRule	monthly1Year()	Monthly 1 year retention, move to cold storage after 1 month.
static BackupPlanRule	monthly1Year(IBackupVaultRef backupVault)	Monthly 1 year retention, move to cold storage after 1 month.
static BackupPlanRule	monthly5Year()	Monthly 5 year retention, move to cold storage after 3 months.
static BackupPlanRule	monthly5Year(IBackupVaultRef backupVault)	Monthly 5 year retention, move to cold storage after 3 months.
static BackupPlanRule	monthly7Year()	Monthly 7 year retention, move to cold storage after 3 months.
static BackupPlanRule	monthly7Year(IBackupVaultRef backupVault)	Monthly 7 year retention, move to cold storage after 3 months.
static BackupPlanRule	weekly()	Weekly with 3 months retention.
static BackupPlanRule	weekly(IBackupVaultRef backupVault)	Weekly with 3 months retention.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

BackupPlanRule

protected BackupPlanRule(software.amazon.jsii.JsiiObjectRef objRef)

BackupPlanRule

protected BackupPlanRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

BackupPlanRule

@Stability(Stable)
public BackupPlanRule(@NotNull
 BackupPlanRuleProps props)

Parameters:

props - Rule properties. This parameter is required.

Method Details

daily

@Stability(Stable)
@NotNull
public static BackupPlanRule daily(@Nullable
 IBackupVaultRef backupVault)

Daily with 35 days retention.

Parameters:

backupVault -

daily

@Stability(Stable)
@NotNull
public static BackupPlanRule daily()

Daily with 35 days retention.

monthly1Year

@Stability(Stable)
@NotNull
public static BackupPlanRule monthly1Year(@Nullable
 IBackupVaultRef backupVault)

Monthly 1 year retention, move to cold storage after 1 month.

Parameters:

backupVault -

monthly1Year

@Stability(Stable)
@NotNull
public static BackupPlanRule monthly1Year()

Monthly 1 year retention, move to cold storage after 1 month.

monthly5Year

@Stability(Stable)
@NotNull
public static BackupPlanRule monthly5Year(@Nullable
 IBackupVaultRef backupVault)

Monthly 5 year retention, move to cold storage after 3 months.

Parameters:

backupVault -

monthly5Year

@Stability(Stable)
@NotNull
public static BackupPlanRule monthly5Year()

Monthly 5 year retention, move to cold storage after 3 months.

monthly7Year

@Stability(Stable)
@NotNull
public static BackupPlanRule monthly7Year(@Nullable
 IBackupVaultRef backupVault)

Monthly 7 year retention, move to cold storage after 3 months.

Parameters:

backupVault -

monthly7Year

@Stability(Stable)
@NotNull
public static BackupPlanRule monthly7Year()

Monthly 7 year retention, move to cold storage after 3 months.

weekly

@Stability(Stable)
@NotNull
public static BackupPlanRule weekly(@Nullable
 IBackupVaultRef backupVault)

Weekly with 3 months retention.

Parameters:

backupVault -

weekly

@Stability(Stable)
@NotNull
public static BackupPlanRule weekly()

Weekly with 3 months retention.

getProps

@Stability(Stable)
@NotNull
public BackupPlanRuleProps getProps()

Properties of BackupPlanRule.