AWS::DLM::LifecyclePolicy CrossRegionCopyRule - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::DLM::LifecyclePolicy CrossRegionCopyRule

[Custom snapshot and AMI policies only] Specifies a cross-Region copy rule for a snapshot and AMI policies.

Note

To specify a cross-Region copy action for event-based polices, use CrossRegionCopyAction.

Syntax

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

JSON

{
  "CmkArn" : String,
  "CopyTags" : Boolean,
  "DeprecateRule" : CrossRegionCopyDeprecateRule,
  "Encrypted" : Boolean,
  "RetainRule" : CrossRegionCopyRetainRule,
  "Target" : String,
  "TargetRegion" : String
}

Properties

CmkArn

The Amazon Resource Name (ARN) of the Amazon KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.

Required: No

Type: String

Pattern: arn:aws(-[a-z]{1,3}){0,2}:kms:([a-z]+-){2,3}\d:\d+:key/.*

Minimum: 0

Maximum: 2048

Update requires: No interruption

CopyTags

Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.

Required: No

Type: Boolean

Update requires: No interruption

DeprecateRule

[Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.

Required: No

Type: CrossRegionCopyDeprecateRule

Update requires: No interruption

Encrypted

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.

Required: Yes

Type: Boolean

Update requires: No interruption

RetainRule

The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.

Required: No

Type: CrossRegionCopyRetainRule

Update requires: No interruption

Target
Note

Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead.

[Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

Required: No

Type: String

Pattern: ^[\w:\-\/\*]+$

Minimum: 0

Maximum: 2048

Update requires: No interruption

TargetRegion
Note

Use this parameter for AMI policies only. For snapshot policies, use Target instead. For snapshot policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.

[Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

Required: No

Type: String

Pattern: ([a-z]+-){2,3}\d

Minimum: 0

Maximum: 16

Update requires: No interruption