Class CfnLifecyclePolicyPropsMixin.CrossRegionCopyRuleProperty

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

Inheritance

object

CfnLifecyclePolicyPropsMixin.CrossRegionCopyRuleProperty

Implements

CfnLifecyclePolicyPropsMixin.ICrossRegionCopyRuleProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.DLM

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnLifecyclePolicyPropsMixin.CrossRegionCopyRuleProperty : CfnLifecyclePolicyPropsMixin.ICrossRegionCopyRuleProperty

Syntax (vb)

Public Class CfnLifecyclePolicyPropsMixin.CrossRegionCopyRuleProperty Implements CfnLifecyclePolicyPropsMixin.ICrossRegionCopyRuleProperty

Remarks

To specify a cross-Region copy action for event-based polices, use <a href="https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyAction.html">CrossRegionCopyAction</a> .

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.DLM;

             var crossRegionCopyRuleProperty = new CrossRegionCopyRuleProperty {
                 CmkArn = "cmkArn",
                 CopyTags = false,
                 DeprecateRule = new CrossRegionCopyDeprecateRuleProperty {
                     Interval = 123,
                     IntervalUnit = "intervalUnit"
                 },
                 Encrypted = false,
                 RetainRule = new CrossRegionCopyRetainRuleProperty {
                     Interval = 123,
                     IntervalUnit = "intervalUnit"
                 },
                 Target = "target",
                 TargetRegion = "targetRegion"
             };

Synopsis

Constructors

CrossRegionCopyRuleProperty()

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

Properties

CmkArn	The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption.
CopyTags	Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
DeprecateRule	[Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
Encrypted	To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.
RetainRule	The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
Target	Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead.
TargetRegion	Use this parameter for AMI policies only.

Constructors

CrossRegionCopyRuleProperty()

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

public CrossRegionCopyRuleProperty()

Remarks

To specify a cross-Region copy action for event-based polices, use <a href="https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyAction.html">CrossRegionCopyAction</a> .

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.DLM;

             var crossRegionCopyRuleProperty = new CrossRegionCopyRuleProperty {
                 CmkArn = "cmkArn",
                 CopyTags = false,
                 DeprecateRule = new CrossRegionCopyDeprecateRuleProperty {
                     Interval = 123,
                     IntervalUnit = "intervalUnit"
                 },
                 Encrypted = false,
                 RetainRule = new CrossRegionCopyRetainRuleProperty {
                     Interval = 123,
                     IntervalUnit = "intervalUnit"
                 },
                 Target = "target",
                 TargetRegion = "targetRegion"
             };

Properties

CmkArn

The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption.

public string? CmkArn { get; set; }

Property Value

string

Remarks

If this parameter is not specified, the default KMS key for the account is used.

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

CopyTags

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

public object? CopyTags { get; set; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

DeprecateRule

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

public object? DeprecateRule { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnLifecyclePolicyPropsMixin.ICrossRegionCopyDeprecateRuleProperty

Encrypted

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.

public object? Encrypted { get; set; }

Property Value

object

Remarks

Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.

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

Type union: either bool or IResolvable

RetainRule

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

public object? RetainRule { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnLifecyclePolicyPropsMixin.ICrossRegionCopyRetainRuleProperty

Target

Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead.

public string? Target { get; set; }

Property Value

string

Remarks

[Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

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

TargetRegion

Use this parameter for AMI policies only.

public string? TargetRegion { get; set; }

Property Value

string

Remarks

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

Implements

CfnLifecyclePolicyPropsMixin.ICrossRegionCopyRuleProperty