AWS::DLM::LifecyclePolicy PolicyDetails - Amazon CloudFormation
SyntaxPropertiesSee 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).

AWS::DLM::LifecyclePolicy PolicyDetails

[All policy types] Specifies the configuration of a lifecycle policy.

Syntax

To declare this entity in your Amazon 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

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

Required: No

Type: List of Action

Maximum: 1

Update requires: No interruption

EventSource

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

Required: No

Type: EventSource

Update requires: No interruption

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.

Required: No

Type: Parameters

Update requires: No interruption

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

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

Required: No

Type: List of String

Maximum: 1

Update requires: No interruption

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.

Required: No

Type: List of String

Maximum: 1

Update requires: No interruption

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.

Required: No

Type: List of Schedule

Maximum: 4

Update requires: No interruption

TargetTags

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

Required: No

Type: List of Tag

Maximum: 50

Update requires: No interruption

See also

  • PolicyDetails in the Amazon Data Lifecycle Manager API Reference