CrossRegionCopyRule - Amazon Data Lifecycle Manager

CrossRegionCopyRule

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

Note

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

Contents

CmkArn

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

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

Required: No

CopyTags

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

Type: Boolean

Required: No

DeprecateRule

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

Type: CrossRegionCopyDeprecateRule object

Required: No

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.

Type: Boolean

Required: Yes

RetainRule

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

Type: CrossRegionCopyRetainRule object

Required: No

Target

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

Use this parameter instead of TargetRegion. Do not specify both.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

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

Required: No

TargetRegion
Note

Avoid using this parameter when creating new policies. Instead, use Target to specify a target Region or a target Outpost for snapshot copies.

For policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 16.

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

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: