Class CfnBackupPlan

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnBackupPlan
Inherited Members
Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnBackupPlan : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnBackupPlan Inherits CfnResource Implements IInspectable, ITaggableV2
Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html

CloudformationResource: AWS::Backup::BackupPlan

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,
                                 OptInToArchiveForSupportedResources = false
                             }
                         } },
                         EnableContinuousBackup = false,
                         IndexActions = new [] { new IndexActionsResourceTypeProperty {
                             ResourceTypes = new [] { "resourceTypes" }
                         } },
                         Lifecycle = new LifecycleResourceTypeProperty {
                             DeleteAfterDays = 123,
                             MoveToColdStorageAfterDays = 123,
                             OptInToArchiveForSupportedResources = false
                         },
                         RecoveryPointTags = new Dictionary<string, string> {
                             { "recoveryPointTagsKey", "recoveryPointTags" }
                         },
                         ScheduleExpression = "scheduleExpression",
                         ScheduleExpressionTimezone = "scheduleExpressionTimezone",
                         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)

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule.

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

The tags to assign to the backup plan.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule.

Constructors

CfnBackupPlan(Construct, string, ICfnBackupPlanProps)

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule.

public CfnBackupPlan(Construct scope, string id, ICfnBackupPlanProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnBackupPlanProps

Resource properties.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html

CloudformationResource: AWS::Backup::BackupPlan

ExampleMetadata: fixture=_generated

Properties

AttrBackupPlanArn

An Amazon Resource Name (ARN) that uniquely identifies a backup plan;

public virtual string AttrBackupPlanArn { get; }
Property Value

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

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

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

object

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html

CloudformationResource: AWS::Backup::BackupPlan

ExampleMetadata: fixture=_generated

BackupPlanTags

The tags to assign to the backup plan.

public virtual IDictionary<string, string>? BackupPlanTags { get; set; }
Property Value

IDictionary<string, string>

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html

CloudformationResource: AWS::Backup::BackupPlan

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html

CloudformationResource: AWS::Backup::BackupPlan

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html

CloudformationResource: AWS::Backup::BackupPlan

ExampleMetadata: fixture=_generated

CfnProperties

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html

CloudformationResource: AWS::Backup::BackupPlan

ExampleMetadata: fixture=_generated

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.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html

CloudformationResource: AWS::Backup::BackupPlan

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html

CloudformationResource: AWS::Backup::BackupPlan

ExampleMetadata: fixture=_generated

Implements