Class CfnLifecyclePolicy.ParametersProperty
[Custom snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.DLM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ParametersProperty : Object, CfnLifecyclePolicy.IParametersProperty
Syntax (vb)
Public Class ParametersProperty
Inherits Object
Implements CfnLifecyclePolicy.IParametersProperty
Remarks
The set of valid parameters depends on the combination of policy type and target resource type.
If you choose to exclude boot volumes and you specify tags that consequently exclude all of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create any snapshots for the affected instance, and it will emit a SnapshotsCreateFailed
Amazon CloudWatch metric. For more information, see Monitor your policies using Amazon CloudWatch .
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 parametersProperty = new ParametersProperty {
ExcludeBootVolume = false,
ExcludeDataVolumeTags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
NoReboot = false
};
Synopsis
Constructors
ParametersProperty() |
Properties
ExcludeBootVolume | [Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. |
ExcludeDataVolumeTags | [Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets. |
NoReboot | [Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. |
Constructors
ParametersProperty()
public ParametersProperty()
Properties
ExcludeBootVolume
[Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets.
public object ExcludeBootVolume { get; set; }
Property Value
System.Object
Remarks
The default is false
. If you specify true
, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
ExcludeDataVolumeTags
[Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
public object ExcludeDataVolumeTags { get; set; }
Property Value
System.Object
Remarks
If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
NoReboot
[Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs.
public object NoReboot { get; set; }
Property Value
System.Object
Remarks
true
indicates that targeted instances are not rebooted when the policy runs. false
indicates that target instances are rebooted when the policy runs. The default is true
(instances are not rebooted).