Class CfnBackupPlan
A CloudFormation AWS::Backup::BackupPlan
.
Inherited Members
Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.AWS.Backup.dll
Syntax (csharp)
public class CfnBackupPlan : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnBackupPlan
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Contains an optional backup plan display name and an array of BackupRule
objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.
For a sample AWS CloudFormation template, see the AWS Backup Developer Guide .
CloudformationResource: AWS::Backup::BackupPlan
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Backup;
var backupOptions;
var cfnBackupPlan = new CfnBackupPlan(this, "MyCfnBackupPlan", new CfnBackupPlanProps {
BackupPlan = new BackupPlanResourceTypeProperty {
BackupPlanName = "backupPlanName",
BackupPlanRule = new [] { new BackupRuleResourceTypeProperty {
RuleName = "ruleName",
TargetBackupVault = "targetBackupVault",
// the properties below are optional
CompletionWindowMinutes = 123,
CopyActions = new [] { new CopyActionResourceTypeProperty {
DestinationBackupVaultArn = "destinationBackupVaultArn",
// the properties below are optional
Lifecycle = new LifecycleResourceTypeProperty {
DeleteAfterDays = 123,
MoveToColdStorageAfterDays = 123
}
} },
EnableContinuousBackup = false,
Lifecycle = new LifecycleResourceTypeProperty {
DeleteAfterDays = 123,
MoveToColdStorageAfterDays = 123
},
RecoveryPointTags = new Dictionary<string, string> {
{ "recoveryPointTagsKey", "recoveryPointTags" }
},
ScheduleExpression = "scheduleExpression",
StartWindowMinutes = 123
} },
// the properties below are optional
AdvancedBackupSettings = new [] { new AdvancedBackupSettingResourceTypeProperty {
BackupOptions = backupOptions,
ResourceType = "resourceType"
} }
},
// the properties below are optional
BackupPlanTags = new Dictionary<string, string> {
{ "backupPlanTagsKey", "backupPlanTags" }
}
});
Synopsis
Constructors
CfnBackupPlan(Construct, String, ICfnBackupPlanProps) | Create a new |
CfnBackupPlan(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnBackupPlan(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrBackupPlanArn | An Amazon Resource Name (ARN) that uniquely identifies a backup plan; |
AttrBackupPlanId | Uniquely identifies a backup plan. |
AttrVersionId | Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. |
BackupPlan | Uniquely identifies the backup plan to be associated with the selection of resources. |
BackupPlanTags | To help organize your resources, you can assign your own metadata to the resources that you create. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnBackupPlan(Construct, String, ICfnBackupPlanProps)
Create a new AWS::Backup::BackupPlan
.
public CfnBackupPlan(Construct scope, string id, ICfnBackupPlanProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnBackupPlanProps
- resource properties.
CfnBackupPlan(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnBackupPlan(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnBackupPlan(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnBackupPlan(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrBackupPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a backup plan;
public virtual string AttrBackupPlanArn { get; }
Property Value
System.String
Remarks
for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50
.
CloudformationAttribute: BackupPlanArn
AttrBackupPlanId
Uniquely identifies a backup plan.
public virtual string AttrBackupPlanId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: BackupPlanId
AttrVersionId
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.
public virtual string AttrVersionId { get; }
Property Value
System.String
Remarks
Version Ids cannot be edited.
CloudformationAttribute: VersionId
BackupPlan
Uniquely identifies the backup plan to be associated with the selection of resources.
public virtual object BackupPlan { get; set; }
Property Value
System.Object
Remarks
BackupPlanTags
To help organize your resources, you can assign your own metadata to the resources that you create.
public virtual object BackupPlanTags { get; set; }
Property Value
System.Object
Remarks
Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>