Class BackupPlan

A backup plan.

Inheritance

System.Object

Resource

BackupPlan

Implements

IBackupPlan

IResource

Constructs.IConstruct

Constructs.IDependable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Backup

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class BackupPlan : Resource, IBackupPlan, IResource

Syntax (vb)

Public Class BackupPlan
    Inherits Resource
    Implements IBackupPlan, IResource

Remarks

ExampleMetadata: infused

Examples

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

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	The ARN of the backup plan.
BackupPlanId	The identifier of the backup plan.
BackupVault	The backup vault where backups are stored if not defined at the rule level.
VersionId	Version Id.

Methods

AddRule(BackupPlanRule)	Adds a rule to a plan.
AddSelection(String, IBackupSelectionOptions)	Adds a selection to this plan.
Daily35DayRetention(Construct, String, IBackupVault)	Daily with 35 day retention.
DailyMonthly1YearRetention(Construct, String, IBackupVault)	Daily and monthly with 1 year retention.
DailyWeeklyMonthly5YearRetention(Construct, String, IBackupVault)	Daily, weekly and monthly with 5 year retention.
DailyWeeklyMonthly7YearRetention(Construct, String, IBackupVault)	Daily, weekly and monthly with 7 year retention.
FromBackupPlanId(Construct, String, String)	Import an existing backup plan.

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

Properties

BackupPlanArn

The ARN of the backup plan.

public virtual string BackupPlanArn { get; }

Property Value

System.String

Remarks

Attribute: true

BackupPlanId

The identifier of the backup plan.

public virtual string BackupPlanId { get; }

Property Value

System.String

BackupVault

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

public virtual IBackupVault BackupVault { get; }

Property Value

IBackupVault

VersionId

Version Id.

public virtual string VersionId { get; }

Property Value

System.String

Remarks

Attribute: true

Methods

AddRule(BackupPlanRule)

Adds a rule to a plan.

public virtual void AddRule(BackupPlanRule rule)

Parameters

rule BackupPlanRule: the rule to add.

AddSelection(String, IBackupSelectionOptions)

Adds a selection to this plan.

public virtual BackupSelection AddSelection(string id, IBackupSelectionOptions options)

Parameters

id System.String
options IBackupSelectionOptions

Returns

BackupSelection

Daily35DayRetention(Construct, String, IBackupVault)

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

DailyMonthly1YearRetention(Construct, String, IBackupVault)

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

DailyWeeklyMonthly5YearRetention(Construct, String, IBackupVault)

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

DailyWeeklyMonthly7YearRetention(Construct, String, IBackupVault)

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

FromBackupPlanId(Construct, String, String)

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

Implements

IBackupPlan

IResource

Constructs.IConstruct

Constructs.IDependable