class LifecyclePolicy (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.Alpha.LifecyclePolicy
Go	github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2#LifecyclePolicy
Java	software.amazon.awscdk.services.imagebuilder.alpha.LifecyclePolicy
Python	aws_cdk.aws_imagebuilder_alpha.LifecyclePolicy
TypeScript (source)	@aws-cdk/aws-imagebuilder-alpha » LifecyclePolicy

Implements IConstruct, IDependable, IResource, IEnvironmentAware, ILifecyclePolicy

Represents an EC2 Image Builder Lifecycle Policy.

See also: https://docs.aws.amazon.com/imagebuilder/latest/userguide/manage-image-lifecycles.html

Example

const disabledPolicy = new imagebuilder.LifecyclePolicy(this, 'DisabledPolicy', {
  lifecyclePolicyName: 'my-disabled-policy',
  description: 'A lifecycle policy that is temporarily disabled',
  status: imagebuilder.LifecyclePolicyStatus.DISABLED,
  resourceType: imagebuilder.LifecyclePolicyResourceType.AMI_IMAGE,
  details: [
    {
      action: { type: imagebuilder.LifecyclePolicyActionType.DELETE },
      filter: { ageFilter: { age: Duration.days(30) } }
    }
  ],
  resourceSelection: {
    tags: { Environment: 'testing' }
  },
  tags: {
    Owner: 'DevOps',
    CostCenter: 'Engineering'
  }
});

Initializer

new LifecyclePolicy(scope: Construct, id: string, props: LifecyclePolicyProps)

Parameters

• scope Construct
• id string
• props LifecyclePolicyProps

Construct Props

Name	Type	Description
details🔹	LifecyclePolicyDetail[]	Configuration details for the lifecycle policy rules.
resourceSelection🔹	LifecyclePolicyResourceSelection	Selection criteria for the resources that the lifecycle policy applies to.
resourceType🔹	LifecyclePolicyResourceType	The type of Image Builder resource that the lifecycle policy applies to.
description?🔹	string	The description of the lifecycle policy.
executionRole?🔹	IRole	The execution role that grants Image Builder access to run lifecycle actions.
lifecyclePolicyName?🔹	string	The name of the lifecycle policy.
status?🔹	LifecyclePolicyStatus	The status of the lifecycle policy.
tags?🔹	{ [string]: string }	The tags to apply to the lifecycle policy.

---

details🔹

Type: LifecyclePolicyDetail[]

Configuration details for the lifecycle policy rules.

---

resourceSelection🔹

Type: LifecyclePolicyResourceSelection

Selection criteria for the resources that the lifecycle policy applies to.

---

resourceType🔹

Type: LifecyclePolicyResourceType

The type of Image Builder resource that the lifecycle policy applies to.

---

description?🔹

Type: string (optional, default: None)

The description of the lifecycle policy.

---

executionRole?🔹

Type: IRole (optional, default: an execution role will be generated)

The execution role that grants Image Builder access to run lifecycle actions.

By default, an execution role will be created with the minimal permissions needed to execute the lifecycle policy actions.

---

lifecyclePolicyName?🔹

Type: string (optional, default: a name is generated)

The name of the lifecycle policy.

---

status?🔹

Type: LifecyclePolicyStatus (optional, default: LifecyclePolicyStatus.ENABLED)

The status of the lifecycle policy.

---

tags?🔹

Type: { [string]: string } (optional, default: none)

The tags to apply to the lifecycle policy.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
executionRole🔹	IRole	The execution role used for lifecycle policy executions.
lifecyclePolicyArn🔹	string	The ARN of the lifecycle policy.
lifecyclePolicyName🔹	string	The name of the lifecycle policy.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

executionRole🔹

Type: IRole

The execution role used for lifecycle policy executions.

---

lifecyclePolicyArn🔹

Type: string

The ARN of the lifecycle policy.

---

lifecyclePolicyName🔹

Type: string

The name of the lifecycle policy.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹	Grant custom actions to the given grantee for the lifecycle policy.
grantRead(grantee)🔹	Grant read permissions to the given grantee for the lifecycle policy.
toString()🔹	Returns a string representation of this construct.
static fromLifecyclePolicyArn(scope, id, lifecyclePolicyArn)🔹	Import an existing lifecycle policy given its ARN.
static fromLifecyclePolicyName(scope, id, lifecyclePolicyName)🔹	Import an existing lifecycle policy given its name.
static isLifecyclePolicy(x)🔹	Return whether the given object is a LifecyclePolicy.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grant(grantee, ...actions)🔹

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable
• actions string

Returns

• Grant

Grant custom actions to the given grantee for the lifecycle policy.

---

grantRead(grantee)🔹

public grantRead(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grant read permissions to the given grantee for the lifecycle policy.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromLifecyclePolicyArn(scope, id, lifecyclePolicyArn)🔹

public static fromLifecyclePolicyArn(scope: Construct, id: string, lifecyclePolicyArn: string): ILifecyclePolicy

Parameters

• scope Construct
• id string
• lifecyclePolicyArn string

Returns

• ILifecyclePolicy

Import an existing lifecycle policy given its ARN.

---

static fromLifecyclePolicyName(scope, id, lifecyclePolicyName)🔹

public static fromLifecyclePolicyName(scope: Construct, id: string, lifecyclePolicyName: string): ILifecyclePolicy

Parameters

• scope Construct
• id string
• lifecyclePolicyName string

Returns

• ILifecyclePolicy

Import an existing lifecycle policy given its name.

If the name is a token representing a dynamic CloudFormation expression, you must ensure all alphabetic characters in the expression are already lowercased

---

static isLifecyclePolicy(x)🔹

public static isLifecyclePolicy(x: any): boolean

Parameters

• x any

Returns

• boolean

Return whether the given object is a LifecyclePolicy.