CreateLifecyclePolicy

Creates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data Lifecycle Manager supports the following policy types:

• Custom EBS snapshot policy

• Custom EBS-backed AMI policy

• Cross-account copy event policy

• Default policy for EBS snapshots

• Default policy for EBS-backed AMIs

For more information, see Default policies vs custom policies.

Important

If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

Request Syntax

POST /policies HTTP/1.1
Content-type: application/json

{
   "CopyTags": boolean,
   "CreateInterval": number,
   "CrossRegionCopyTargets": [ 
      { 
         "TargetRegion": "string"
      }
   ],
   "DefaultPolicy": "string",
   "Description": "string",
   "Exclusions": { 
      "ExcludeBootVolumes": boolean,
      "ExcludeTags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "ExcludeVolumeTypes": [ "string" ]
   },
   "ExecutionRoleArn": "string",
   "ExtendDeletion": boolean,
   "PolicyDetails": { 
      "Actions": [ 
         { 
            "CrossRegionCopy": [ 
               { 
                  "EncryptionConfiguration": { 
                     "CmkArn": "string",
                     "Encrypted": boolean
                  },
                  "RetainRule": { 
                     "Interval": number,
                     "IntervalUnit": "string"
                  },
                  "Target": "string"
               }
            ],
            "Name": "string"
         }
      ],
      "CopyTags": boolean,
      "CreateInterval": number,
      "CrossRegionCopyTargets": [ 
         { 
            "TargetRegion": "string"
         }
      ],
      "EventSource": { 
         "Parameters": { 
            "DescriptionRegex": "string",
            "EventType": "string",
            "SnapshotOwner": [ "string" ]
         },
         "Type": "string"
      },
      "Exclusions": { 
         "ExcludeBootVolumes": boolean,
         "ExcludeTags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "ExcludeVolumeTypes": [ "string" ]
      },
      "ExtendDeletion": boolean,
      "Parameters": { 
         "ExcludeBootVolume": boolean,
         "ExcludeDataVolumeTags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "NoReboot": boolean
      },
      "PolicyLanguage": "string",
      "PolicyType": "string",
      "ResourceLocations": [ "string" ],
      "ResourceType": "string",
      "ResourceTypes": [ "string" ],
      "RetainInterval": number,
      "Schedules": [ 
         { 
            "ArchiveRule": { 
               "RetainRule": { 
                  "RetentionArchiveTier": { 
                     "Count": number,
                     "Interval": number,
                     "IntervalUnit": "string"
                  }
               }
            },
            "CopyTags": boolean,
            "CreateRule": { 
               "CronExpression": "string",
               "Interval": number,
               "IntervalUnit": "string",
               "Location": "string",
               "Scripts": [ 
                  { 
                     "ExecuteOperationOnScriptFailure": boolean,
                     "ExecutionHandler": "string",
                     "ExecutionHandlerService": "string",
                     "ExecutionTimeout": number,
                     "MaximumRetryCount": number,
                     "Stages": [ "string" ]
                  }
               ],
               "Times": [ "string" ]
            },
            "CrossRegionCopyRules": [ 
               { 
                  "CmkArn": "string",
                  "CopyTags": boolean,
                  "DeprecateRule": { 
                     "Interval": number,
                     "IntervalUnit": "string"
                  },
                  "Encrypted": boolean,
                  "RetainRule": { 
                     "Interval": number,
                     "IntervalUnit": "string"
                  },
                  "Target": "string",
                  "TargetRegion": "string"
               }
            ],
            "DeprecateRule": { 
               "Count": number,
               "Interval": number,
               "IntervalUnit": "string"
            },
            "FastRestoreRule": { 
               "AvailabilityZones": [ "string" ],
               "Count": number,
               "Interval": number,
               "IntervalUnit": "string"
            },
            "Name": "string",
            "RetainRule": { 
               "Count": number,
               "Interval": number,
               "IntervalUnit": "string"
            },
            "ShareRules": [ 
               { 
                  "TargetAccounts": [ "string" ],
                  "UnshareInterval": number,
                  "UnshareIntervalUnit": "string"
               }
            ],
            "TagsToAdd": [ 
               { 
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "VariableTags": [ 
               { 
                  "Key": "string",
                  "Value": "string"
               }
            ]
         }
      ],
      "TargetTags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   },
   "RetainInterval": number,
   "State": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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

DefaultPolicy

[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

Description

A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Pattern: [0-9A-Za-z _-]+

Required: Yes

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

ExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: arn:aws(-[a-z]{1,3}){0,2}:iam::\d+:role/.*

Required: Yes

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

PolicyDetails

The configuration details of the lifecycle policy.

Important

If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

Type: PolicyDetails object

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

State

The activation state of the lifecycle policy after creation.

Type: String

Valid Values: ENABLED | DISABLED

Required: Yes

Tags

The tags to apply to the lifecycle policy during creation.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Value Pattern: [\p{all}]*

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "PolicyId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PolicyId

The identifier of the lifecycle policy.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: policy-[a-f0-9]+

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The service failed in an unexpected way.

HTTP Status Code: 500

InvalidRequestException

Bad request. The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400

LimitExceededException

The request failed because a limit was exceeded.

HTTP Status Code: 429

Examples

Example 1: Default policy for EBS snapshots

The following example creates a default policy for EBS snapshots that uses the default IAM role for managing EBS snapshots. The policy creates snapshots daily, retains snapshots for 3 days, and excludes st1 volumes, boot volumes, and volumes tagged with purpose=testing.

Sample Request

POST /policies HTTP/1.1
Content-type: application/json
{
   "CopyTags": true,
   "CreateInterval": 1,
   "CrossRegionCopyTargets": [ 
      { 
         "TargetRegion": "us-east-1"
      }
   ],
   "DefaultPolicy": "VOLUME",
   "Description": "Daily default snapshot policy",
   "Exclusions": { 
      "ExcludeBootVolumes": true,
      "ExcludeTags": [ 
         { 
            "Key": "purpose",
            "Value": "testing"
         }
      ],
      "ExcludeVolumeTypes": [ "st1" ]
   },
   "ExecutionRoleArn": "arn:aws:iam::123456789012:role/AWSDataLifecycleManagerDefaultRole",
   "ExtendDeletion": true,
   "RetainInterval": 3,
   "State": "ENABLED",
   "Tags": { 
      "environment" : "prod" 
   }
}

Example 2: Default policy for EBS snapshots with default settings

The example creates a default EBS snapshots policy using the default settings. The policy uses the default role for managing EBS snapshots, creates snapshots daily, and retains snapshots for 7 days.

Sample Request

POST /policies HTTP/1.1
Content-type: application/json
{
   "DefaultPolicy": "VOLUME",
   "Description": "Daily default snapshot policy",
   "ExecutionRoleArn": "arn:aws:iam::123456789012:role/AWSDataLifecycleManagerDefaultRole",
   "State": "ENABLED"
}

Example 3: Custom EBS-backed AMI policy

The following example creates a custom age-based EBS-backed AMI policy that targets instances tagged with environment=prod, but excludes volumes attached as boot volumes. The policy uses the default IAM role for managing EBS-backed AMIs. It creates AMIs every 12 hours, starting at 17:00 UTC, retains AMIs for 7 days, and deprecates the oldest AMI after 2 days. The policy also copies encrypted AMIs to the us-east-1 Region, and retains those copies for 2 days.

Sample Request

POST /policies HTTP/1.1
Content-type: application/json

{
   "Description": "Custom AMI policy",
   "ExecutionRoleArn": "arn:aws:iam::12345678910:role/AWSDataLifecycleManagerDefaultRoleForAMIManagement",
   "PolicyDetails": { 
      "Parameters": { 
         "ExcludeBootVolume": false,
         "NoReboot": false
      },
      "PolicyType": "IMAGE_MANAGEMENT",
      "ResourceTypes": [ "INSTANCE" ],
      "Schedules": [ 
         { 
            "CopyTags": true,
            "CreateRule": { 
               "Interval": 12,
               "IntervalUnit": "HOURS",
               "Times": [ "17:30" ]
            },
            "CrossRegionCopyRules": [ 
               { 
                  "CopyTags": true,
                  "Encrypted": true,
                  "RetainRule": { 
                     "Interval": 2,
                     "IntervalUnit": "DAYS"
                  },
                  "Target": "us-east-1"
               }
            ],
            "DeprecateRule": { 
               "Interval": 2,
               "IntervalUnit": "DAYS"
            },
            "Name": "Schedule1",
            "RetainRule": { 
               "Interval": 7,
               "IntervalUnit": "DAYS"
            }
         }
      ],
      "TargetTags": [ 
         { 
            "Key": "environment",
            "Value": "prod"
         }
      ]
   },
   "State": "ENABLED"
}

See Also

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

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3