Documentation

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

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

See: newCrossRegionCopyRule smart constructor.

Create a value of CrossRegionCopyRule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cmkArn:CrossRegionCopyRule', crossRegionCopyRule_cmkArn - The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.

$sel:copyTags:CrossRegionCopyRule', crossRegionCopyRule_copyTags - Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.

$sel:deprecateRule:CrossRegionCopyRule', crossRegionCopyRule_deprecateRule - [AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.

$sel:retainRule:CrossRegionCopyRule', crossRegionCopyRule_retainRule - The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.

$sel:target:CrossRegionCopyRule', crossRegionCopyRule_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.

$sel:targetRegion:CrossRegionCopyRule', crossRegionCopyRule_targetRegion - 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.

$sel:encrypted:CrossRegionCopyRule', crossRegionCopyRule_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.

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

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

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

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

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.

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.

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.