> **Experimental**
>
> `@aws-cdk/aws-imagebuilder-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# LifecyclePolicy

Represents an EC2 Image Builder Lifecycle Policy.

Extends: Construct › Resource › LifecyclePolicy
Implements: ILifecyclePolicy, IResource, IEnvironmentAware, IConstruct, IDependable

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`lib/lifecycle-policy.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0-alpha.0/packages/@aws-cdk/aws-imagebuilder-alpha/lib/lifecycle-policy.ts#L370)

## Example

```ts
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

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

## Construct Props

- `description`: string = None — The description of the lifecycle policy.

- `details`: [LifecyclePolicyDetail](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.LifecyclePolicyDetail.html)[] (required) — Configuration details for the lifecycle policy rules.

- `executionRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The execution role that grants Image Builder access to run lifecycle actions.

  **Default:** an execution role will be generated

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

- `lifecyclePolicyName`: string — The name of the lifecycle policy.

  **Default:** a name is generated

- `resourceSelection`: [LifecyclePolicyResourceSelection](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.LifecyclePolicyResourceSelection.html) (required) — Selection criteria for the resources that the lifecycle policy applies to.

- `resourceType`: [LifecyclePolicyResourceType](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.LifecyclePolicyResourceType.html) (required) — The type of Image Builder resource that the lifecycle policy applies to.

- `status`: [LifecyclePolicyStatus](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.LifecyclePolicyStatus.html) = LifecyclePolicyStatus.ENABLED — The status of the lifecycle policy.

- `tags`: { [key: string]: string } = none — The tags to apply to the lifecycle policy.

## Properties

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — 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`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — 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](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — 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`).

- `fromLifecyclePolicyArn(scope: Construct, id: string, lifecyclePolicyArn: string): ILifecyclePolicy` (static) — Import an existing lifecycle policy given its ARN.

- `fromLifecyclePolicyName(scope: Construct, id: string, lifecyclePolicyName: string): ILifecyclePolicy` (static) — 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

- `grant(grantee: IGrantable, ...actions: string[]): Grant` — [disable-awslint:no-grants].

- `grantRead(grantee: IGrantable): Grant` — [disable-awslint:no-grants].

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isLifecyclePolicy(x: any): boolean` (static) — Return whether the given object is a LifecyclePolicy.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.