software.amazon.awscdk.services.dlm

Interface CfnLifecyclePolicy.CrossRegionCopyRuleProperty

All Known Implementing Classes:

CfnLifecyclePolicy.CrossRegionCopyRuleProperty.Jsii$Proxy

Enclosing class:

CfnLifecyclePolicy

public static interface CfnLifecyclePolicy.CrossRegionCopyRuleProperty

Specifies a rule for cross-Region snapshot copies.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnLifecyclePolicy.CrossRegionCopyRuleProperty.Builder A builder for CfnLifecyclePolicy.CrossRegionCopyRuleProperty
static class	CfnLifecyclePolicy.CrossRegionCopyRuleProperty.Jsii$Proxy An implementation for CfnLifecyclePolicy.CrossRegionCopyRuleProperty

Method Summary

Modifier and Type	Method and Description
static CfnLifecyclePolicy.CrossRegionCopyRuleProperty.Builder	builder()
default java.lang.String	getCmkArn() The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption.
default java.lang.Object	getCopyTags() Indicates whether to copy all user-defined tags from the source snapshot to the cross-Region snapshot copy.
default java.lang.Object	getDeprecateRule() The AMI deprecation rule for cross-Region AMI copies created by the rule.
java.lang.Object	getEncrypted() To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.
default java.lang.Object	getRetainRule() The retention rule that indicates how long snapshot copies are to be retained in the destination Region.
default java.lang.String	getTarget() The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
default java.lang.String	getTargetRegion() Avoid using this parameter when creating new policies.

Method Detail

getEncrypted

java.lang.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

default java.lang.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

default java.lang.Object getCopyTags()

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

getDeprecateRule

default java.lang.Object getDeprecateRule()

The AMI deprecation rule for cross-Region AMI copies created by the rule.

getRetainRule

default java.lang.Object getRetainRule()

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

getTarget

default java.lang.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

default java.lang.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

static CfnLifecyclePolicy.CrossRegionCopyRuleProperty.Builder builder()

Returns:

a CfnLifecyclePolicy.CrossRegionCopyRuleProperty.Builder of CfnLifecyclePolicy.CrossRegionCopyRuleProperty