Interface CfnLifecyclePolicy.ICrossRegionCopyRuleProperty
[Snapshot and AMI policies only] Specifies a cross-Region copy rule for snapshot and AMI policies.
Namespace: Amazon.CDK.AWS.DLM
Assembly: Amazon.CDK.AWS.DLM.dll
Syntax (csharp)
public interface ICrossRegionCopyRuleProperty
Syntax (vb)
Public Interface 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
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 |
|
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. |
Properties
CmkArn
The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption.
virtual string CmkArn { get; }
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.
virtual object CopyTags { get; }
Property Value
System.Object
Remarks
DeprecateRule
CfnLifecyclePolicy.CrossRegionCopyRuleProperty.DeprecateRule
.
virtual object DeprecateRule { get; }
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.
object Encrypted { get; }
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.
virtual object RetainRule { get; }
Property Value
System.Object
Remarks
Target
The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
virtual string Target { get; }
Property Value
System.String
Remarks
Use this parameter instead of TargetRegion . Do not specify both.
TargetRegion
Avoid using this parameter when creating new policies.
virtual string TargetRegion { get; }
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.