Interface CfnLifecyclePolicy.ParametersProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnLifecyclePolicy.ParametersProperty.Jsii$Proxy
- Enclosing class:
CfnLifecyclePolicy
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 .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.dlm.*; ParametersProperty parametersProperty = ParametersProperty.builder() .excludeBootVolume(false) .excludeDataVolumeTags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .noReboot(false) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnLifecyclePolicy.ParametersProperty
static final class
An implementation forCfnLifecyclePolicy.ParametersProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
[Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets.default Object
CfnLifecyclePolicy.ParametersProperty.ExcludeDataVolumeTags
.default Object
[AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getExcludeBootVolume
[Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets.The default is
false
. If you specifytrue
, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy. -
getExcludeDataVolumeTags
CfnLifecyclePolicy.ParametersProperty.ExcludeDataVolumeTags
. -
getNoReboot
[AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs.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 istrue
(instances are not rebooted). -
builder
-