CrossRegionCopyRule
Specifies a rule for cross-Region snapshot copies.
Contents
- 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.
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
-
Copy all user-defined tags from the source snapshot to the copied snapshot.
Type: Boolean
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.
Type: CrossRegionCopyRetainRule object
Required: No
- 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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^[\w:\-\/\*]+$Required: No
- 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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 16.
Pattern:
([a-z]+-){2,3}\dRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
