PolicyDetails - Amazon Data Lifecycle Manager
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

PolicyDetails

Specifies the configuration of a lifecycle policy.

Contents

Actions

[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

Type: Array of Action objects

Array Members: Fixed number of 1 item.

Required: No

CopyTags

[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

Type: Boolean

Required: No

CreateInterval

[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

Type: Integer

Valid Range: Minimum value of 1.

Required: No

CrossRegionCopyTargets

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

Type: Array of CrossRegionCopyTarget objects

Array Members: Minimum number of 0 items. Maximum number of 3 items.

Required: No

EventSource

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

Type: EventSource object

Required: No

Exclusions

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

Type: Exclusions object

Required: No

ExtendDeletion

[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

Type: Boolean

Required: No

Parameters

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

Note

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.

Type: Parameters object

Required: No

PolicyLanguage

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

  • SIMPLIFIED To create a default policy.

  • STANDARD To create a custom policy.

Type: String

Valid Values: SIMPLIFIED | STANDARD

Required: No

PolicyType

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 Amazon Web Services account.

The default is EBS_SNAPSHOT_MANAGEMENT.

Type: String

Valid Values: EBS_SNAPSHOT_MANAGEMENT | IMAGE_MANAGEMENT | EVENT_BASED_POLICY

Required: No

ResourceLocations

[Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

Type: Array of strings

Array Members: Fixed number of 1 item.

Valid Values: CLOUD | OUTPOST

Required: No

ResourceType

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

Type: String

Valid Values: VOLUME | INSTANCE

Required: No

ResourceTypes

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

Type: Array of strings

Array Members: Fixed number of 1 item.

Valid Values: VOLUME | INSTANCE

Required: No

RetainInterval

[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

Type: Integer

Valid Range: Minimum value of 1.

Required: No

Schedules

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

Type: Array of Schedule objects

Array Members: Minimum number of 1 item. Maximum number of 4 items.

Required: No

TargetTags

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

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: