software.amazon.awscdk.services.dlm

Interface CfnLifecyclePolicy.ParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLifecyclePolicy.ParametersProperty.Jsii$Proxy

Enclosing class:

CfnLifecyclePolicy

@Stability(value=Stable)
public static interface CfnLifecyclePolicy.ParametersProperty
extends software.amazon.jsii.JsiiSerializable

Specifies optional parameters to add to a policy.

The set of valid parameters depends on the combination of policy type and resource type.

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 Classes

Modifier and Type	Interface and Description
static class	CfnLifecyclePolicy.ParametersProperty.Builder A builder for CfnLifecyclePolicy.ParametersProperty
static class	CfnLifecyclePolicy.ParametersProperty.Jsii$Proxy An implementation for CfnLifecyclePolicy.ParametersProperty

Method Summary

Modifier and Type	Method and Description
static CfnLifecyclePolicy.ParametersProperty.Builder	builder()
default Object	getExcludeBootVolume() [EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using [CreateSnapshots](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSnapshots.html) .
default Object	getExcludeDataVolumeTags() `CfnLifecyclePolicy.ParametersProperty.ExcludeDataVolumeTags`.
default Object	getNoReboot() Applies to AMI lifecycle policies only.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getExcludeBootVolume

@Stability(value=Stable)
 @Nullable
default Object getExcludeBootVolume()

[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using [CreateSnapshots](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSnapshots.html) . The default is false.

getExcludeDataVolumeTags

@Stability(value=Stable)
 @Nullable
default Object getExcludeDataVolumeTags()

`CfnLifecyclePolicy.ParametersProperty.ExcludeDataVolumeTags`.

getNoReboot

@Stability(value=Stable)
 @Nullable
default Object getNoReboot()

Applies to AMI lifecycle 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 is true (instances are not rebooted).

builder

@Stability(value=Stable)
static CfnLifecyclePolicy.ParametersProperty.Builder builder()

Returns:

a CfnLifecyclePolicy.ParametersProperty.Builder of CfnLifecyclePolicy.ParametersProperty