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(value=Stable)
public static interface CfnLifecyclePolicy.CrossRegionCopyRuleProperty
extends software.amazon.jsii.JsiiSerializable

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEncrypted

@Stability(value=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(value=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(value=Stable)
 @Nullable
default Object getCopyTags()

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

getDeprecateRule

@Stability(value=Stable)
 @Nullable
default Object getDeprecateRule()

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

getRetainRule

@Stability(value=Stable)
 @Nullable
default Object getRetainRule()

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

getTarget

@Stability(value=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(value=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(value=Stable)
static CfnLifecyclePolicy.CrossRegionCopyRuleProperty.Builder builder()

Returns:

a CfnLifecyclePolicy.CrossRegionCopyRuleProperty.Builder of CfnLifecyclePolicy.CrossRegionCopyRuleProperty