AWS::Backup::BackupPlan

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Backup::BackupPlan",
  "Properties" : {
      "BackupPlan" : BackupPlanResourceType,
      "BackupPlanTags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::Backup::BackupPlan
Properties:
  BackupPlan: 
    BackupPlanResourceType
  BackupPlanTags: 
    Key: Value

Properties

BackupPlan

Uniquely identifies the backup plan to be associated with the selection of resources.

Required: Yes

Type: BackupPlanResourceType

Update requires: No interruption

BackupPlanTags

The tags to assign to the backup plan.

Required: No

Type: Object of String

Pattern: ^.{1,128}$

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns BackupPlanId.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

BackupPlanArn

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

BackupPlanId

Uniquely identifies a backup plan.

VersionId

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.