Class CfnLifecyclePolicy.CrossRegionCopyRuleProperty

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

Inheritance

System.Object

CfnLifecyclePolicy.CrossRegionCopyRuleProperty

Implements

CfnLifecyclePolicy.ICrossRegionCopyRuleProperty

Namespace: Amazon.CDK.AWS.DLM

Assembly: Amazon.CDK.AWS.DLM.dll

Syntax (csharp)

public class CrossRegionCopyRuleProperty : Object, CfnLifecyclePolicy.ICrossRegionCopyRuleProperty

Syntax (vb)

Public Class CrossRegionCopyRuleProperty
    Inherits Object
    Implements CfnLifecyclePolicy.ICrossRegionCopyRuleProperty

Remarks

To specify a cross-Region copy action for event-based polices, use CrossRegionCopyAction .

Link: 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.AWS.DLM;

var crossRegionCopyRuleProperty = new CrossRegionCopyRuleProperty {
    Encrypted = false,

    // the properties below are optional
    CmkArn = "cmkArn",
    CopyTags = false,
    DeprecateRule = new CrossRegionCopyDeprecateRuleProperty {
        Interval = 123,
        IntervalUnit = "intervalUnit"
    },
    RetainRule = new CrossRegionCopyRetainRuleProperty {
        Interval = 123,
        IntervalUnit = "intervalUnit"
    },
    Target = "target",
    TargetRegion = "targetRegion"
};

Synopsis

Constructors

CrossRegionCopyRuleProperty()

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	`CfnLifecyclePolicy.CrossRegionCopyRuleProperty.DeprecateRule`.
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	The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
TargetRegion	Avoid using this parameter when creating new policies.

Constructors

CrossRegionCopyRuleProperty()

public CrossRegionCopyRuleProperty()

Properties

CmkArn

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

public string CmkArn { get; set; }

Property Value

System.String

Remarks

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

Link: 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

System.Object

Remarks

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

DeprecateRule

CfnLifecyclePolicy.CrossRegionCopyRuleProperty.DeprecateRule.

public object DeprecateRule { get; set; }

Property Value

System.Object

Remarks

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

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

System.Object

Remarks

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

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

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

System.Object

Remarks

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

Target

The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

public string Target { get; set; }

Property Value

System.String

Remarks

Use this parameter instead of TargetRegion . Do not specify both.

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

TargetRegion

Avoid using this parameter when creating new policies.

public string TargetRegion { get; set; }

Property Value

System.String

Remarks

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.

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

Implements

CfnLifecyclePolicy.ICrossRegionCopyRuleProperty