Class CfnLifecyclePolicy.CrossRegionCopyRuleProperty
[Custom snapshot and AMI policies only] Specifies a cross-Region copy rule for a snapshot and AMI policies.
Inheritance
Namespace: Amazon.CDK.AWS.DLM
Assembly: Amazon.CDK.Lib.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 .
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 | [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()
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.
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
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
System.Object
Remarks
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.
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
Target
Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead.
public string Target { get; set; }
Property Value
System.String
Remarks
[Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
TargetRegion
Use this parameter for AMI policies only.
public string TargetRegion { get; set; }
Property Value
System.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.