@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:51.606Z") public class BackupPlan extends Resource implements IBackupPlan
Example:
// Daily, weekly and monthly with 5 year retention BackupPlan plan = BackupPlan.dailyWeeklyMonthly5YearRetention(this, "Plan");
Modifier and Type | Class and Description |
---|---|
static class |
BackupPlan.Builder
A fluent builder for
BackupPlan . |
IBackupPlan.Jsii$Default, IBackupPlan.Jsii$Proxy
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) |
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.
|
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
applyRemovalPolicy, getEnv, getStack
getNode
protected BackupPlan(software.amazon.jsii.JsiiObjectRef objRef)
protected BackupPlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public BackupPlan(software.constructs.Construct scope, java.lang.String id, BackupPlanProps props)
scope
- This parameter is required.id
- This parameter is required.props
- public BackupPlan(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.public static BackupPlan daily35DayRetention(software.constructs.Construct scope, java.lang.String id, IBackupVault backupVault)
scope
- This parameter is required.id
- This parameter is required.backupVault
- public static BackupPlan daily35DayRetention(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.public static BackupPlan dailyMonthly1YearRetention(software.constructs.Construct scope, java.lang.String id, IBackupVault backupVault)
scope
- This parameter is required.id
- This parameter is required.backupVault
- public static BackupPlan dailyMonthly1YearRetention(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.public static BackupPlan dailyWeeklyMonthly5YearRetention(software.constructs.Construct scope, java.lang.String id, IBackupVault backupVault)
scope
- This parameter is required.id
- This parameter is required.backupVault
- public static BackupPlan dailyWeeklyMonthly5YearRetention(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.public static BackupPlan dailyWeeklyMonthly7YearRetention(software.constructs.Construct scope, java.lang.String id, IBackupVault backupVault)
scope
- This parameter is required.id
- This parameter is required.backupVault
- public static BackupPlan dailyWeeklyMonthly7YearRetention(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.public static IBackupPlan fromBackupPlanId(software.constructs.Construct scope, java.lang.String id, java.lang.String backupPlanId)
scope
- This parameter is required.id
- This parameter is required.backupPlanId
- This parameter is required.public void addRule(BackupPlanRule rule)
rule
- the rule to add. This parameter is required.public BackupSelection addSelection(java.lang.String id, BackupSelectionOptions options)
id
- This parameter is required.options
- This parameter is required.protected java.util.List<java.lang.String> validate()
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
public java.lang.String getBackupPlanArn()
public java.lang.String getBackupPlanId()
getBackupPlanId
in interface IBackupPlan
public IBackupVault getBackupVault()
public java.lang.String getVersionId()