Package software.amazon.awscdk.services.dlm

Interface CfnLifecyclePolicy.CrossRegionCopyRuleProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnLifecyclePolicy.CrossRegionCopyRuleProperty.Jsii$Proxy
Enclosing class:
CfnLifecyclePolicy
@Stability(Stable) public static interface CfnLifecyclePolicy.CrossRegionCopyRuleProperty extends software.amazon.jsii.JsiiSerializable
[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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dlm.*;
 CrossRegionCopyRuleProperty crossRegionCopyRuleProperty = CrossRegionCopyRuleProperty.builder()
         .encrypted(false)
         // the properties below are optional
         .cmkArn("cmkArn")
         .copyTags(false)
         .deprecateRule(CrossRegionCopyDeprecateRuleProperty.builder()
                 .interval(123)
                 .intervalUnit("intervalUnit")
                 .build())
         .retainRule(CrossRegionCopyRetainRuleProperty.builder()
                 .interval(123)
                 .intervalUnit("intervalUnit")
                 .build())
         .target("target")
         .targetRegion("targetRegion")
         .build();

  • Method Details

    • getEncrypted

      @Stability(Stable) @NotNull Object getEncrypted()
      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.

    • getCmkArn

      @Stability(Stable) @Nullable default String getCmkArn()
      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.

    • getCopyTags

      @Stability(Stable) @Nullable default Object getCopyTags()
      Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.

    • getDeprecateRule

      @Stability(Stable) @Nullable default Object getDeprecateRule()
      CfnLifecyclePolicy.CrossRegionCopyRuleProperty.DeprecateRule.

    • getRetainRule

      @Stability(Stable) @Nullable default Object getRetainRule()
      The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.

    • getTarget

      @Stability(Stable) @Nullable default String getTarget()
      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.

    • getTargetRegion

      @Stability(Stable) @Nullable default String getTargetRegion()

      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.

    • builder

      @Stability(Stable) static CfnLifecyclePolicy.CrossRegionCopyRuleProperty.Builder builder()
      Returns:
      a CfnLifecyclePolicy.CrossRegionCopyRuleProperty.Builder of CfnLifecyclePolicy.CrossRegionCopyRuleProperty