Package software.amazon.awscdk.services.backup

Class BackupPlan

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.backup.BackupPlan

All Implemented Interfaces:

IConstruct, IDependable, IResource, IBackupPlan, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.593Z")
@Stability(Stable)
public class BackupPlan
extends Resource
implements IBackupPlan

A backup plan.

Example:

 // Daily, weekly and monthly with 5 year retention
 BackupPlan plan = BackupPlan.dailyWeeklyMonthly5YearRetention(this, "Plan");
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.backup.IBackupPlan

IBackupPlan.Jsii$Default, IBackupPlan.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BackupPlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BackupPlan(software.amazon.jsii.JsiiObjectRef objRef)
	BackupPlan(software.constructs.Construct scope, String id)
	BackupPlan(software.constructs.Construct scope, String id, BackupPlanProps props)

Method Summary

Modifier and Type	Method	Description
void	addRule(BackupPlanRule rule)	Adds a rule to a plan.
BackupSelection	addSelection(String id, BackupSelectionOptions options)	Adds a selection to this plan.
static BackupPlan	daily35DayRetention(software.constructs.Construct scope, String id)	Daily with 35 day retention.
static BackupPlan	daily35DayRetention(software.constructs.Construct scope, String id, IBackupVault backupVault)	Daily with 35 day retention.
static BackupPlan	dailyMonthly1YearRetention(software.constructs.Construct scope, String id)	Daily and monthly with 1 year retention.
static BackupPlan	dailyMonthly1YearRetention(software.constructs.Construct scope, String id, IBackupVault backupVault)	Daily and monthly with 1 year retention.
static BackupPlan	dailyWeeklyMonthly5YearRetention(software.constructs.Construct scope, String id)	Daily, weekly and monthly with 5 year retention.
static BackupPlan	dailyWeeklyMonthly5YearRetention(software.constructs.Construct scope, String id, IBackupVault backupVault)	Daily, weekly and monthly with 5 year retention.
static BackupPlan	dailyWeeklyMonthly7YearRetention(software.constructs.Construct scope, String id)	Daily, weekly and monthly with 7 year retention.
static BackupPlan	dailyWeeklyMonthly7YearRetention(software.constructs.Construct scope, String id, IBackupVault backupVault)	Daily, weekly and monthly with 7 year retention.
static IBackupPlan	fromBackupPlanId(software.constructs.Construct scope, String id, String backupPlanId)	Import an existing backup plan.
String	getBackupPlanArn()	The ARN of the backup plan.
String	getBackupPlanId()	The identifier of the backup plan.
IBackupVault	getBackupVault()	The backup vault where backups are stored if not defined at the rule level.
String	getVersionId()	Version Id.
protected List<String>	validate()	Validate the current construct.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class software.constructs.Construct

toString

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, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

BackupPlan

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

BackupPlan

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

BackupPlan

@Stability(Stable)
public BackupPlan(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 BackupPlanProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

BackupPlan

@Stability(Stable)
public BackupPlan(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

daily35DayRetention

@Stability(Stable)
@NotNull
public static BackupPlan daily35DayRetention(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 IBackupVault backupVault)

Daily with 35 day retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

backupVault -

daily35DayRetention

@Stability(Stable)
@NotNull
public static BackupPlan daily35DayRetention(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Daily with 35 day retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

dailyMonthly1YearRetention

@Stability(Stable)
@NotNull
public static BackupPlan dailyMonthly1YearRetention(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 IBackupVault backupVault)

Daily and monthly with 1 year retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

backupVault -

dailyMonthly1YearRetention

@Stability(Stable)
@NotNull
public static BackupPlan dailyMonthly1YearRetention(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Daily and monthly with 1 year retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

dailyWeeklyMonthly5YearRetention

@Stability(Stable)
@NotNull
public static BackupPlan dailyWeeklyMonthly5YearRetention(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 IBackupVault backupVault)

Daily, weekly and monthly with 5 year retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

backupVault -

dailyWeeklyMonthly5YearRetention

@Stability(Stable)
@NotNull
public static BackupPlan dailyWeeklyMonthly5YearRetention(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Daily, weekly and monthly with 5 year retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

dailyWeeklyMonthly7YearRetention

@Stability(Stable)
@NotNull
public static BackupPlan dailyWeeklyMonthly7YearRetention(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 IBackupVault backupVault)

Daily, weekly and monthly with 7 year retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

backupVault -

dailyWeeklyMonthly7YearRetention

@Stability(Stable)
@NotNull
public static BackupPlan dailyWeeklyMonthly7YearRetention(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Daily, weekly and monthly with 7 year retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

fromBackupPlanId

@Stability(Stable)
@NotNull
public static IBackupPlan fromBackupPlanId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String backupPlanId)

Import an existing backup plan.

Parameters:

scope - This parameter is required.

id - This parameter is required.

backupPlanId - This parameter is required.

addRule

@Stability(Stable)
public void addRule(@NotNull
 BackupPlanRule rule)

Adds a rule to a plan.

Parameters:

rule - the rule to add. This parameter is required.

addSelection

@Stability(Stable)
@NotNull
public BackupSelection addSelection(@NotNull
 String id,
 @NotNull
 BackupSelectionOptions options)

Adds a selection to this plan.

Parameters:

id - This parameter is required.

options - This parameter is required.

validate

@Stability(Stable)
@NotNull
protected List<String> validate()

Validate the current construct.

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Overrides:

validate in class Construct

Returns:

An array of validation error messages, or an empty array if the construct is valid.

getBackupPlanArn

@Stability(Stable)
@NotNull
public String getBackupPlanArn()

The ARN of the backup plan.

getBackupPlanId

@Stability(Stable)
@NotNull
public String getBackupPlanId()

The identifier of the backup plan.

Specified by:

getBackupPlanId in interface IBackupPlan

getBackupVault

@Stability(Stable)
@NotNull
public IBackupVault getBackupVault()

The backup vault where backups are stored if not defined at the rule level.

getVersionId

@Stability(Stable)
@NotNull
public String getVersionId()

Version Id.