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

[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 .

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 or AMI to the cross-Region copy.
default Object	getDeprecateRule()	[Custom AMI policies only] 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 the cross-Region snapshot or AMI copies are to be retained in the destination Region.
default String	getTarget()
default String	getTargetRegion()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-encrypted

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-cmkarn

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-copytags

getDeprecateRule

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-retainrule

getTarget

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-target

getTargetRegion

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

Use this parameter for AMI policies only.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-targetregion

builder

@Stability(Stable)
static CfnLifecyclePolicy.CrossRegionCopyRuleProperty.Builder builder()

Returns:

a CfnLifecyclePolicy.CrossRegionCopyRuleProperty.Builder of CfnLifecyclePolicy.CrossRegionCopyRuleProperty