AWS::DLM::LifecyclePolicy PolicyDetails - AWS CloudFormation

AWS::DLM::LifecyclePolicy PolicyDetails

Specifies the configuration of a lifecycle policy.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Actions" : [ Action, ... ], "EventSource" : EventSource, "Parameters" : Parameters, "PolicyType" : String, "ResourceLocations" : [ String, ... ], "ResourceTypes" : [ String, ... ], "Schedules" : [ Schedule, ... ], "TargetTags" : [ Tag, ... ] }

Properties

Actions

The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.

This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.

Required: No

Type: List of Action

Maximum: 1

Update requires: No interruption

EventSource

The event that triggers the event-based policy.

This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.

Required: No

Type: EventSource

Update requires: No interruption

Parameters

A set of optional parameters for snapshot and AMI lifecycle policies.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

Required: No

Type: Parameters

Update requires: No interruption

PolicyType

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.

Required: No

Type: String

Allowed values: EBS_SNAPSHOT_MANAGEMENT | EVENT_BASED_POLICY | IMAGE_MANAGEMENT

Update requires: No interruption

ResourceLocations

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.

Required: No

Type: List of String

Maximum: 1

Update requires: No interruption

ResourceTypes

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.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

Required: No

Type: List of String

Maximum: 1

Update requires: No interruption

Schedules

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.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

Required: No

Type: List of Schedule

Maximum: 4

Update requires: No interruption

TargetTags

The single tag that identifies targeted resources for this policy.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

Required: No

Type: List of Tag

Maximum: 50

Update requires: No interruption

See also

  • PolicyDetails in the Amazon Data Lifecycle Manager API Reference