Class BackupPlan

(experimental) A backup plan.

Inheritance
System.Object
Construct
Resource
BackupPlan
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.AWS.Backup.dll
Syntax (csharp)
public class BackupPlan : Resource, IBackupPlan, IResource, IConstruct, IConstruct, IDependable
Syntax (vb)
Public Class BackupPlan
    Inherits Resource
    Implements IBackupPlan, IResource, IConstruct, IConstruct, IDependable
Remarks

Stability: Experimental

Synopsis

Constructors

BackupPlan(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
BackupPlan(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
BackupPlan(Construct, String, IBackupPlanProps)

Properties

BackupPlanArn

(experimental) The ARN of the backup plan.
BackupPlanId

(experimental) The identifier of the backup plan.
BackupVault

(experimental) The backup vault where backups are stored if not defined at the rule level.
VersionId

(experimental) Version Id.

Methods

AddRule(BackupPlanRule)

(experimental) Adds a rule to a plan.
AddSelection(String, IBackupSelectionOptions)

(experimental) Adds a selection to this plan.
Daily35DayRetention(Construct, String, IBackupVault)

(experimental) Daily with 35 day retention.
DailyMonthly1YearRetention(Construct, String, IBackupVault)

(experimental) Daily and monthly with 1 year retention.
DailyWeeklyMonthly5YearRetention(Construct, String, IBackupVault)

(experimental) Daily, weekly and monthly with 5 year retention.
DailyWeeklyMonthly7YearRetention(Construct, String, IBackupVault)

(experimental) Daily, weekly and monthly with 7 year retention.
FromBackupPlanId(Construct, String, String)

(experimental) Import an existing backup plan.
Validate()

(experimental) Validate the current construct.

Constructors

BackupPlan(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected BackupPlan(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

BackupPlan(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected BackupPlan(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

BackupPlan(Construct, String, IBackupPlanProps)

public BackupPlan(Construct scope, string id, IBackupPlanProps props = null)
Parameters
scope Constructs.Construct
id System.String
props IBackupPlanProps
Remarks

Stability: Experimental

Properties

BackupPlanArn

(experimental) The ARN of the backup plan.

public virtual string BackupPlanArn { get; }
Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

BackupPlanId

(experimental) The identifier of the backup plan.

public virtual string BackupPlanId { get; }
Property Value

System.String

Remarks

Stability: Experimental

BackupVault

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

public virtual IBackupVault BackupVault { get; }
Property Value

IBackupVault

Remarks

Stability: Experimental

VersionId

(experimental) Version Id.

public virtual string VersionId { get; }
Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

Methods

AddRule(BackupPlanRule)

(experimental) Adds a rule to a plan.

public virtual void AddRule(BackupPlanRule rule)
Parameters
rule BackupPlanRule

the rule to add.

Remarks

Stability: Experimental

AddSelection(String, IBackupSelectionOptions)

(experimental) Adds a selection to this plan.

public virtual BackupSelection AddSelection(string id, IBackupSelectionOptions options)
Parameters
id System.String
options IBackupSelectionOptions
Returns

BackupSelection

Remarks

Stability: Experimental

Daily35DayRetention(Construct, String, IBackupVault)

(experimental) Daily with 35 day retention.

public static BackupPlan Daily35DayRetention(Construct scope, string id, IBackupVault backupVault = null)
Parameters
scope Constructs.Construct
id System.String
backupVault IBackupVault
Returns

BackupPlan

Remarks

Stability: Experimental

DailyMonthly1YearRetention(Construct, String, IBackupVault)

(experimental) Daily and monthly with 1 year retention.

public static BackupPlan DailyMonthly1YearRetention(Construct scope, string id, IBackupVault backupVault = null)
Parameters
scope Constructs.Construct
id System.String
backupVault IBackupVault
Returns

BackupPlan

Remarks

Stability: Experimental

DailyWeeklyMonthly5YearRetention(Construct, String, IBackupVault)

(experimental) Daily, weekly and monthly with 5 year retention.

public static BackupPlan DailyWeeklyMonthly5YearRetention(Construct scope, string id, IBackupVault backupVault = null)
Parameters
scope Constructs.Construct
id System.String
backupVault IBackupVault
Returns

BackupPlan

Remarks

Stability: Experimental

DailyWeeklyMonthly7YearRetention(Construct, String, IBackupVault)

(experimental) Daily, weekly and monthly with 7 year retention.

public static BackupPlan DailyWeeklyMonthly7YearRetention(Construct scope, string id, IBackupVault backupVault = null)
Parameters
scope Constructs.Construct
id System.String
backupVault IBackupVault
Returns

BackupPlan

Remarks

Stability: Experimental

FromBackupPlanId(Construct, String, String)

(experimental) Import an existing backup plan.

public static IBackupPlan FromBackupPlanId(Construct scope, string id, string backupPlanId)
Parameters
scope Constructs.Construct
id System.String
backupPlanId System.String
Returns

IBackupPlan

Remarks

Stability: Experimental

Validate()

(experimental) Validate the current construct.

protected override string[] Validate()
Returns

System.String[]

Overrides
Remarks

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

Stability: Experimental

Implements

Constructs.IConstruct