AWS CDK Reference

Appearance

v2.274.0

CrossRegionCopyRuleProperty Struct ​

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

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

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dlm as dlm } from 'aws-cdk-lib';
const crossRegionCopyRuleProperty: dlm.CfnLifecyclePolicy.CrossRegionCopyRuleProperty = {
  encrypted: false,

  // the properties below are optional
  cmkArn: 'cmkArn',
  copyTags: false,
  deprecateRule: {
    interval: 123,
    intervalUnit: 'intervalUnit',
  },
  retainRule: {
    interval: 123,
    intervalUnit: 'intervalUnit',
  },
  target: 'target',
  targetRegion: 'targetRegion',
};

Properties ​

cmkArnoptionalstringcmk_arnoptionalstrcmkArnoptionalStringCmkArnoptionalstringCmkArnoptional*string#
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.

copyTagsoptionalboolean | IResolvablecopy_tagsoptionaltyping.Union[bool, IResolvable]copyTagsoptionalBooleanCopyTagsoptionalboolCopyTagsoptionalinterface{}#
Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
deprecateRuleoptionalIResolvable | CfnLifecyclePolicy.CrossRegionCopyDeprecateRulePropertydeprecate_ruleoptionaltyping.Union[IResolvable, CrossRegionCopyDeprecateRuleProperty]deprecateRuleoptionalIResolvableDeprecateRuleoptionalIResolvableDeprecateRuleoptionalinterface{}#
*[Custom AMI policies only]* The AMI deprecation rule for cross-Region AMI copies created by the rule.
encryptedboolean | IResolvableencryptedtyping.Union[bool, IResolvable]encryptedBooleanEncryptedboolEncryptedinterface{}required#
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.

retainRuleoptionalIResolvable | CfnLifecyclePolicy.CrossRegionCopyRetainRulePropertyretain_ruleoptionaltyping.Union[IResolvable, CrossRegionCopyRetainRuleProperty]retainRuleoptionalIResolvableRetainRuleoptionalIResolvableRetainRuleoptionalinterface{}#
The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
targetoptionalstringtargetoptionalstrtargetoptionalStringTargetoptionalstringTargetoptional*string#
> 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.

targetRegionoptionalstringtarget_regionoptionalstrtargetRegionoptionalStringTargetRegionoptionalstringTargetRegionoptional*string#
> Use this parameter for AMI policies only.
notes

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.