PolicyDetails - Amazon Data Lifecycle Manager

PolicyDetails

[All policy types] 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

EventSource

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

Type: EventSource object

Required: No

Parameters

[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

PolicyType

[All policy types] The valid target resource types and actions a policy can manage. 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.

Type: String

Valid Values: EBS_SNAPSHOT_MANAGEMENT | IMAGE_MANAGEMENT | EVENT_BASED_POLICY

Required: No

ResourceLocations

[Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an AWS 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

ResourceTypes

[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

Schedules

[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

[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 AWS SDKs, see the following: