AWS::DLM::LifecyclePolicy CrossRegionCopyRule

Specifies a rule for cross-Region snapshot copies.

Syntax

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

JSON

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

YAML

  CmkArn: String
  CopyTags: Boolean
  Encrypted: Boolean
  RetainRule: 
    CrossRegionCopyRetainRule
  Target: String
  TargetRegion: String

Properties

CmkArn

The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.

Required: No

Type: String

Minimum: 0

Maximum: 2048

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

Update requires: No interruption

CopyTags

Copy all user-defined tags from the source snapshot to the copied snapshot.

Required: No

Type: Boolean

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.

Required: No

Type: CrossRegionCopyRetainRule

Update requires: No interruption

Target

The Amazon Resource Name (ARN) of the target AWS Outpost for the snapshot copies.

If you specify an ARN, you must omit TargetRegion. You cannot specify a target Region and a target Outpost in the same rule.

Required: No

Type: String

Minimum: 0

Maximum: 2048

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

Update requires: No interruption

TargetRegion

The target Region for the snapshot copies.

If you specify a target Region, you must omit Target. You cannot specify a target Region and a target Outpost in the same rule.

Required: No

Type: String

Minimum: 0

Maximum: 16

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

Update requires: No interruption