Package 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(Stable)
public static interface CfnLifecyclePolicy.ParametersProperty
extends software.amazon.jsii.JsiiSerializable

[Custom snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies.

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLifecyclePolicy.ParametersProperty.Builder	builder()
default Object	getExcludeBootVolume()	[Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets.
default Object	getExcludeDataVolumeTags()	[Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
default Object	getNoReboot()	[Custom 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

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

[Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html#cfn-dlm-lifecyclepolicy-parameters-excludebootvolume

getExcludeDataVolumeTags

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

[Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html#cfn-dlm-lifecyclepolicy-parameters-excludedatavolumetags

getNoReboot

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

[Custom 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 is true (instances are not rebooted).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html#cfn-dlm-lifecyclepolicy-parameters-noreboot

builder

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

Returns:

a CfnLifecyclePolicy.ParametersProperty.Builder of CfnLifecyclePolicy.ParametersProperty