1.204.0

interface ParametersProperty

LanguageType name
.NETAmazon.CDK.AWS.DLM.CfnLifecyclePolicy.ParametersProperty
Javasoftware.amazon.awscdk.services.dlm.CfnLifecyclePolicy.ParametersProperty
Pythonaws_cdk.aws_dlm.CfnLifecyclePolicy.ParametersProperty
TypeScript @aws-cdk/aws-dlm » CfnLifecyclePolicy » ParametersProperty

[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 * as dlm from '@aws-cdk/aws-dlm';
const parametersProperty: dlm.CfnLifecyclePolicy.ParametersProperty = {
  excludeBootVolume: false,
  excludeDataVolumeTags: [{
    key: 'key',
    value: 'value',
  }],
  noReboot: false,
};

Properties

NameTypeDescription
excludeBootVolume?boolean | IResolvable[Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets.
excludeDataVolumeTags?IResolvable | IResolvable | CfnTag[]CfnLifecyclePolicy.ParametersProperty.ExcludeDataVolumeTags.
noReboot?boolean | IResolvable[AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs.

excludeBootVolume?

Type: boolean | IResolvable (optional)

[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.

excludeDataVolumeTags?

Type: IResolvable | IResolvable | CfnTag[] (optional)

CfnLifecyclePolicy.ParametersProperty.ExcludeDataVolumeTags.

noReboot?

Type: boolean | IResolvable (optional)

[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).

← PreviousNext →