software.amazon.awscdk.services.backup

Class BackupPlan

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.606Z")
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 and Description
static class	BackupPlan.Builder A fluent builder for BackupPlan.

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

IBackupPlan.Jsii$Default, IBackupPlan.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

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

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

applyRemovalPolicy, getEnv, getStack

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

getNode

Constructor Detail

BackupPlan

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

BackupPlan

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

BackupPlan

public BackupPlan(software.constructs.Construct scope,
                  java.lang.String id,
                  BackupPlanProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

BackupPlan

public BackupPlan(software.constructs.Construct scope,
                  java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

daily35DayRetention

public static BackupPlan daily35DayRetention(software.constructs.Construct scope,
                                             java.lang.String id,
                                             IBackupVault backupVault)

Daily with 35 day retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

backupVault -

daily35DayRetention

public static BackupPlan daily35DayRetention(software.constructs.Construct scope,
                                             java.lang.String id)

Daily with 35 day retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

dailyMonthly1YearRetention

public static BackupPlan dailyMonthly1YearRetention(software.constructs.Construct scope,
                                                    java.lang.String id,
                                                    IBackupVault backupVault)

Daily and monthly with 1 year retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

backupVault -

dailyMonthly1YearRetention

public static BackupPlan dailyMonthly1YearRetention(software.constructs.Construct scope,
                                                    java.lang.String id)

Daily and monthly with 1 year retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

dailyWeeklyMonthly5YearRetention

public static BackupPlan dailyWeeklyMonthly5YearRetention(software.constructs.Construct scope,
                                                          java.lang.String id,
                                                          IBackupVault backupVault)

Daily, weekly and monthly with 5 year retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

backupVault -

dailyWeeklyMonthly5YearRetention

public static BackupPlan dailyWeeklyMonthly5YearRetention(software.constructs.Construct scope,
                                                          java.lang.String id)

Daily, weekly and monthly with 5 year retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

dailyWeeklyMonthly7YearRetention

public static BackupPlan dailyWeeklyMonthly7YearRetention(software.constructs.Construct scope,
                                                          java.lang.String id,
                                                          IBackupVault backupVault)

Daily, weekly and monthly with 7 year retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

backupVault -

dailyWeeklyMonthly7YearRetention

public static BackupPlan dailyWeeklyMonthly7YearRetention(software.constructs.Construct scope,
                                                          java.lang.String id)

Daily, weekly and monthly with 7 year retention.

Parameters:

scope - This parameter is required.

id - This parameter is required.

fromBackupPlanId

public static IBackupPlan fromBackupPlanId(software.constructs.Construct scope,
                                           java.lang.String id,
                                           java.lang.String backupPlanId)

Import an existing backup plan.

Parameters:

scope - This parameter is required.

id - This parameter is required.

backupPlanId - This parameter is required.

addRule

public void addRule(BackupPlanRule rule)

Adds a rule to a plan.

Parameters:

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

addSelection

public BackupSelection addSelection(java.lang.String id,
                                    BackupSelectionOptions options)

Adds a selection to this plan.

Parameters:

id - This parameter is required.

options - This parameter is required.

validate

protected java.util.List<java.lang.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

public java.lang.String getBackupPlanArn()

The ARN of the backup plan.

getBackupPlanId

public java.lang.String getBackupPlanId()

The identifier of the backup plan.

Specified by:

getBackupPlanId in interface IBackupPlan

getBackupVault

public IBackupVault getBackupVault()

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

getVersionId

public java.lang.String getVersionId()

Version Id.