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.
Contents
- 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
- 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
-
[Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
Type: CrossRegionCopyDeprecateRule object
Required: No
- 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
-
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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^[\w:\-\/\*]+$Required: No
- 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.
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:
