LifecyclePolicy - EC2 Image Builder
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).

LifecyclePolicy

The configuration details for a lifecycle policy resource.

Contents

arn

The Amazon Resource Name (ARN) of the lifecycle policy resource.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):lifecycle-policy/[a-z0-9-_]+$

Required: No

dateCreated

The timestamp when Image Builder created the lifecycle policy resource.

Type: Timestamp

Required: No

dateLastRun

The timestamp for the last time Image Builder ran the lifecycle policy.

Type: Timestamp

Required: No

dateUpdated

The timestamp when Image Builder updated the lifecycle policy resource.

Type: Timestamp

Required: No

description

Optional description for the lifecycle policy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

executionRole

The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy. This is a custom role that you create.

Type: String

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

Pattern: ^(?:arn:aws(?:-[a-z]+)*:iam::[0-9]{12}:role/)?[a-zA-Z_0-9+=,.@\-_/]+$

Required: No

name

The name of the lifecycle policy.

Type: String

Pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$

Required: No

policyDetails

The configuration details for a lifecycle policy resource.

Type: Array of LifecyclePolicyDetail objects

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

Required: No

resourceSelection

Resource selection criteria used to run the lifecycle policy.

Type: LifecyclePolicyResourceSelection object

Required: No

resourceType

The type of resources the lifecycle policy targets.

Type: String

Valid Values: AMI_IMAGE | CONTAINER_IMAGE

Required: No

status

Indicates whether the lifecycle policy resource is enabled.

Type: String

Valid Values: DISABLED | ENABLED

Required: No

tags

To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define.

Type: String to string map

Map Entries: Maximum number of 50 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.

Required: No

See Also

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