Package software.amazon.awscdk.services.dlm

Interface CfnLifecyclePolicy.PolicyDetailsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLifecyclePolicy.PolicyDetailsProperty.Jsii$Proxy

Enclosing class:

CfnLifecyclePolicy

@Stability(Stable)
public static interface CfnLifecyclePolicy.PolicyDetailsProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the configuration of a lifecycle policy.

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.*;
 Object crossRegionCopyTargets;
 Object excludeTags;
 Object excludeVolumeTypes;
 PolicyDetailsProperty policyDetailsProperty = PolicyDetailsProperty.builder()
         .actions(List.of(ActionProperty.builder()
                 .crossRegionCopy(List.of(CrossRegionCopyActionProperty.builder()
                         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                                 .encrypted(false)
                                 // the properties below are optional
                                 .cmkArn("cmkArn")
                                 .build())
                         .target("target")
                         // the properties below are optional
                         .retainRule(CrossRegionCopyRetainRuleProperty.builder()
                                 .interval(123)
                                 .intervalUnit("intervalUnit")
                                 .build())
                         .build()))
                 .name("name")
                 .build()))
         .copyTags(false)
         .createInterval(123)
         .crossRegionCopyTargets(crossRegionCopyTargets)
         .eventSource(EventSourceProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .parameters(EventParametersProperty.builder()
                         .eventType("eventType")
                         .snapshotOwner(List.of("snapshotOwner"))
                         // the properties below are optional
                         .descriptionRegex("descriptionRegex")
                         .build())
                 .build())
         .exclusions(ExclusionsProperty.builder()
                 .excludeBootVolumes(false)
                 .excludeTags(excludeTags)
                 .excludeVolumeTypes(excludeVolumeTypes)
                 .build())
         .extendDeletion(false)
         .parameters(ParametersProperty.builder()
                 .excludeBootVolume(false)
                 .excludeDataVolumeTags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .noReboot(false)
                 .build())
         .policyLanguage("policyLanguage")
         .policyType("policyType")
         .resourceLocations(List.of("resourceLocations"))
         .resourceType("resourceType")
         .resourceTypes(List.of("resourceTypes"))
         .retainInterval(123)
         .schedules(List.of(ScheduleProperty.builder()
                 .archiveRule(ArchiveRuleProperty.builder()
                         .retainRule(ArchiveRetainRuleProperty.builder()
                                 .retentionArchiveTier(RetentionArchiveTierProperty.builder()
                                         .count(123)
                                         .interval(123)
                                         .intervalUnit("intervalUnit")
                                         .build())
                                 .build())
                         .build())
                 .copyTags(false)
                 .createRule(CreateRuleProperty.builder()
                         .cronExpression("cronExpression")
                         .interval(123)
                         .intervalUnit("intervalUnit")
                         .location("location")
                         .scripts(List.of(ScriptProperty.builder()
                                 .executeOperationOnScriptFailure(false)
                                 .executionHandler("executionHandler")
                                 .executionHandlerService("executionHandlerService")
                                 .executionTimeout(123)
                                 .maximumRetryCount(123)
                                 .stages(List.of("stages"))
                                 .build()))
                         .times(List.of("times"))
                         .build())
                 .crossRegionCopyRules(List.of(CrossRegionCopyRuleProperty.builder()
                         .encrypted(false)
                         // the properties below are optional
                         .cmkArn("cmkArn")
                         .copyTags(false)
                         .deprecateRule(CrossRegionCopyDeprecateRuleProperty.builder()
                                 .interval(123)
                                 .intervalUnit("intervalUnit")
                                 .build())
                         .retainRule(CrossRegionCopyRetainRuleProperty.builder()
                                 .interval(123)
                                 .intervalUnit("intervalUnit")
                                 .build())
                         .target("target")
                         .targetRegion("targetRegion")
                         .build()))
                 .deprecateRule(DeprecateRuleProperty.builder()
                         .count(123)
                         .interval(123)
                         .intervalUnit("intervalUnit")
                         .build())
                 .fastRestoreRule(FastRestoreRuleProperty.builder()
                         .availabilityZones(List.of("availabilityZones"))
                         .count(123)
                         .interval(123)
                         .intervalUnit("intervalUnit")
                         .build())
                 .name("name")
                 .retainRule(RetainRuleProperty.builder()
                         .count(123)
                         .interval(123)
                         .intervalUnit("intervalUnit")
                         .build())
                 .shareRules(List.of(ShareRuleProperty.builder()
                         .targetAccounts(List.of("targetAccounts"))
                         .unshareInterval(123)
                         .unshareIntervalUnit("unshareIntervalUnit")
                         .build()))
                 .tagsToAdd(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .variableTags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         .targetTags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLifecyclePolicy.PolicyDetailsProperty.Builder	builder()
default Object	getActions()	[Event-based policies only] The actions to be performed when the event-based policy is activated.
default Object	getCopyTags()	[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.
default Number	getCreateInterval()	[Default policies only] Specifies how often the policy should run and create snapshots or AMIs.
default Object	getCrossRegionCopyTargets()	[Default policies only] Specifies destination Regions for snapshot or AMI copies.
default Object	getEventSource()	[Event-based policies only] The event that activates the event-based policy.
default Object	getExclusions()	[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.
default Object	getExtendDeletion()	[Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
default Object	getParameters()	[Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
default String	getPolicyLanguage()	The type of policy to create.
default String	getPolicyType()	The type of policy.
default List<String>	getResourceLocations()	[Custom snapshot and AMI policies only] The location of the resources to backup.
default String	getResourceType()	[Default policies only] Specify the type of default policy to create.
default List<String>	getResourceTypes()	[Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.
default Number	getRetainInterval()	[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.
default Object	getSchedules()	[Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies.
default Object	getTargetTags()	[Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActions

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

[Event-based policies only] The actions to be performed when the event-based policy is activated.

You can specify only one action per policy.

See Also:

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

getCopyTags

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

[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.

If you do not specify a value, the default is false .

Default: false

See Also:

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

getCreateInterval

@Stability(Stable)
@Nullable
default Number getCreateInterval()

[Default policies only] Specifies how often the policy should run and create snapshots or AMIs.

The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

Default: 1

See Also:

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

getCrossRegionCopyTargets

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

[Default policies only] Specifies destination Regions for snapshot or AMI copies.

You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.

See Also:

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

getEventSource

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

[Event-based policies only] The event that activates the event-based policy.

See Also:

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

getExclusions

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

[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.

The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.

See Also:

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

getExtendDeletion

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

[Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

By default ( ExtendDeletion=false ):

• If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true .
• If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true .

If you enable extended deletion ( ExtendDeletion=true ), you override both default behaviors simultaneously.

If you do not specify a value, the default is false .

Default: false

See Also:

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

getParameters

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

[Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

See Also:

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

getPolicyLanguage

@Stability(Stable)
@Nullable
default String getPolicyLanguage()

The type of policy to create. Specify one of the following:.

• SIMPLIFIED To create a default policy.
• STANDARD To create a custom policy.

See Also:

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

getPolicyType

@Stability(Stable)
@Nullable
default String getPolicyType()

The type of policy.

Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your AWS account .

The default is EBS_SNAPSHOT_MANAGEMENT .

See Also:

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

getResourceLocations

@Stability(Stable)
@Nullable
default List<String> getResourceLocations()

[Custom snapshot and AMI policies only] The location of the resources to backup.

• If the source resources are located in a Region, specify CLOUD . In this case, the policy targets all resources of the specified type with matching target tags across all Availability Zones in the Region.
• [Custom snapshot policies only] If the source resources are located in a Local Zone, specify LOCAL_ZONE . In this case, the policy targets all resources of the specified type with matching target tags across all Local Zones in the Region.
• If the source resources are located on an Outpost in your account, specify OUTPOST . In this case, the policy targets all resources of the specified type with matching target tags across all of the Outposts in your account.

See Also:

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

getResourceType

@Stability(Stable)
@Nullable
default String getResourceType()

[Default policies only] Specify the type of default policy to create.

• To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME .
• To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE .

See Also:

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

getResourceTypes

@Stability(Stable)
@Nullable
default List<String> getResourceTypes()

[Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.

Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

See Also:

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

getRetainInterval

@Stability(Stable)
@Nullable
default Number getRetainInterval()

[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.

The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

Default: 7

See Also:

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

getSchedules

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

[Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies.

A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

See Also:

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

getTargetTags

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

[Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

See Also:

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

builder

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

Returns:

a CfnLifecyclePolicy.PolicyDetailsProperty.Builder of CfnLifecyclePolicy.PolicyDetailsProperty