# CfnLifecyclePolicy

Specifies a lifecycle policy, which is used to automate operations on Amazon EBS resources.

The properties are required when you add a lifecycle policy and optional when you update a lifecycle policy.

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnLifecyclePolicy
Implements: IInspectable, ITaggable, IEnvironmentAware, ILifecyclePolicyRef, IConstruct, IDependable

- CloudFormation: [`AWS::DLM::LifecyclePolicy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-dlm-lifecyclepolicy.html)
- Source: Generated code
- Type last changed: v2.272.0 · 30 Sep 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dlm as dlm } from 'aws-cdk-lib';
const cfnLifecyclePolicy = new dlm.CfnLifecyclePolicy(this, 'MyCfnLifecyclePolicy', /* all optional props */ {
  copyTags: false,
  createInterval: 123,
  crossRegionCopyTargets: [{
    targetRegion: 'targetRegion',
  }],
  defaultPolicy: 'defaultPolicy',
  description: 'description',
  exclusions: {
    excludeBootVolumes: false,
    excludeTags: [{
      key: 'key',
      value: 'value',
    }],
    excludeVolumeTypes: ['excludeVolumeTypes'],
  },
  executionRoleArn: 'executionRoleArn',
  extendDeletion: false,
  policyDetails: {
    actions: [{
      crossRegionCopy: [{
        encryptionConfiguration: {
          encrypted: false,

          // the properties below are optional
          cmkArn: 'cmkArn',
        },
        target: 'target',

        // the properties below are optional
        retainRule: {
          interval: 123,
          intervalUnit: 'intervalUnit',
        },
      }],
      name: 'name',
    }],
    copyTags: false,
    createInterval: 123,
    crossRegionCopyTargets: [{
      targetRegion: 'targetRegion',
    }],
    eventSource: {
      type: 'type',

      // the properties below are optional
      parameters: {
        eventType: 'eventType',
        snapshotOwner: ['snapshotOwner'],

        // the properties below are optional
        descriptionRegex: 'descriptionRegex',
      },
    },
    exclusions: {
      excludeBootVolumes: false,
      excludeTags: [{
        key: 'key',
        value: 'value',
      }],
      excludeVolumeTypes: ['excludeVolumeTypes'],
    },
    extendDeletion: false,
    parameters: {
      excludeBootVolume: false,
      excludeDataVolumeTags: [{
        key: 'key',
        value: 'value',
      }],
      noReboot: false,
    },
    policyLanguage: 'policyLanguage',
    policyType: 'policyType',
    resourceLocations: ['resourceLocations'],
    resourceType: 'resourceType',
    resourceTypes: ['resourceTypes'],
    retainInterval: 123,
    schedules: [{
      archiveRule: {
        retainRule: {
          retentionArchiveTier: {
            count: 123,
            interval: 123,
            intervalUnit: 'intervalUnit',
          },
        },
      },
      copyTags: false,
      createRule: {
        cronExpression: 'cronExpression',
        interval: 123,
        intervalUnit: 'intervalUnit',
        location: 'location',
        scripts: [{
          executeOperationOnScriptFailure: false,
          executionHandler: 'executionHandler',
          executionHandlerService: 'executionHandlerService',
          executionTimeout: 123,
          maximumRetryCount: 123,
          stages: ['stages'],
        }],
        times: ['times'],
      },
      crossRegionCopyRules: [{
        encrypted: false,

        // the properties below are optional
        cmkArn: 'cmkArn',
        copyTags: false,
        deprecateRule: {
          interval: 123,
          intervalUnit: 'intervalUnit',
        },
        retainRule: {
          interval: 123,
          intervalUnit: 'intervalUnit',
        },
        target: 'target',
        targetRegion: 'targetRegion',
      }],
      deprecateRule: {
        count: 123,
        interval: 123,
        intervalUnit: 'intervalUnit',
      },
      fastRestoreRule: {
        availabilityZoneIds: ['availabilityZoneIds'],
        availabilityZones: ['availabilityZones'],
        count: 123,
        interval: 123,
        intervalUnit: 'intervalUnit',
      },
      name: 'name',
      retainRule: {
        count: 123,
        interval: 123,
        intervalUnit: 'intervalUnit',
      },
      shareRules: [{
        targetAccounts: ['targetAccounts'],
        unshareInterval: 123,
        unshareIntervalUnit: 'unshareIntervalUnit',
      }],
      tagsToAdd: [{
        key: 'key',
        value: 'value',
      }],
      variableTags: [{
        key: 'key',
        value: 'value',
      }],
    }],
    targetTags: [{
      key: 'key',
      value: 'value',
    }],
  },
  retainInterval: 123,
  state: 'state',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});
```

## Initializer

```ts
new CfnLifecyclePolicy(scope: Construct, id: string, props?: CfnLifecyclePolicyProps)
```

## Construct Props

- `copyTags`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — *[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

- `createInterval`: number — *[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

- `crossRegionCopyTargets`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLifecyclePolicy.CrossRegionCopyTargetProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dlm.CfnLifecyclePolicy.CrossRegionCopyTargetProperty.html)[] — *[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.

- `defaultPolicy`: string — *[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` .

- `description`: string — A description of the lifecycle policy.

  The characters ^[0-9A-Za-z _-]+$ are supported.

- `exclusions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLifecyclePolicy.ExclusionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dlm.CfnLifecyclePolicy.ExclusionsProperty.html) — *[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.

- `executionRoleArn`: string — The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

- `extendDeletion`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — *[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

- `policyDetails`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLifecyclePolicy.PolicyDetailsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dlm.CfnLifecyclePolicy.PolicyDetailsProperty.html) — The configuration details of the lifecycle policy.

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

- `retainInterval`: number — *[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

- `state`: string — The activation state of the lifecycle policy.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — The tags to apply to the lifecycle policy during creation.

## Properties

- `attrArn`: string — The Amazon Resource Name (ARN) of the lifecycle policy.

- `attrPolicyId`: string — The identifier of the lifecycle policy.

- `CFN_RESOURCE_TYPE_NAME`: string (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string — AWS resource type.

- `copyTags`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — *[Default policies only]* Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.

- `createInterval`: number — *[Default policies only]* Specifies how often the policy should run and create snapshots or AMIs.

- `creationStack`: string[]

- `crossRegionCopyTargets`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLifecyclePolicy.CrossRegionCopyTargetProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dlm.CfnLifecyclePolicy.CrossRegionCopyTargetProperty.html)[] — *[Default policies only]* Specifies destination Regions for snapshot or AMI copies.

- `defaultPolicy`: string — *[Default policies only]* Specify the type of default policy to create.

- `description`: string — A description of the lifecycle policy.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html)

- `exclusions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLifecyclePolicy.ExclusionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dlm.CfnLifecyclePolicy.ExclusionsProperty.html) — *[Default policies only]* Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.

- `executionRoleArn`: string — The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

- `extendDeletion`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — *[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.

- `lifecyclePolicyRef`: [LifecyclePolicyReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_dlm.LifecyclePolicyReference.html) — A reference to a LifecyclePolicy resource.

- `logicalId`: string — The logical ID for this CloudFormation stack element.

  The logical ID of the element
  is calculated from the path of the resource node in the construct tree.

  To override this value, use `overrideLogicalId(newLogicalId)`.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `policyDetails`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLifecyclePolicy.PolicyDetailsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dlm.CfnLifecyclePolicy.PolicyDetailsProperty.html) — The configuration details of the lifecycle policy.

- `ref`: string — Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

  If, by any chance, the intrinsic reference of a resource is not a string, you could
  coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.

- `retainInterval`: number — *[Default policies only]* Specifies how long the policy should retain snapshots or AMIs before deleting them.

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

  CfnElements must be defined within a stack scope (directly or indirectly).

- `state`: string — The activation state of the lifecycle policy.

- `tags`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) — Tag Manager which manages the tags for this resource.

- `tagsRaw`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — The tags to apply to the lifecycle policy during creation.

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  This method has been renamed to `addResourceDependency` to more clearly
  set it apart from `construct.node.addDependency`. See the documentation
  of that function for more details.

- `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method has been renamed to `addResourceDependency`, which makes it
  more clear that this method operates at a different level from the
  construct-level `construct.node.addDependency()` mechanism.

- `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — Adds an override to the synthesized CloudFormation resource.

  To add a
  property override, either use `addPropertyOverride` or prefix `path` with
  "Properties." (i.e. `Properties.TopicName`).

  If the override is nested, separate each nested level using a dot (.) in the path parameter.
  If there is an array as part of the nesting, specify the index in the path.

  To include a literal `.` in the property name, prefix with a `\`. In most
  programming languages you will need to write this as `"\\."` because the
  `\` itself will need to be escaped.

  For example,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "Properties": {
    "GlobalSecondaryIndexes": [
      {
        "Projection": {
          "NonKeyAttributes": [ "myattribute" ]
          ...
        }
        ...
      },
      {
        "ProjectionType": "INCLUDE"
        ...
      },
    ]
    ...
  }
  ```

  The `value` argument to `addOverride` will not be processed or translated
  in any way. Pass raw JSON values in here with the correct capitalization
  for CloudFormation. If you pass CDK classes or structs, they will be
  rendered with lowercased key names, and CloudFormation will reject the
  template.

  **Parameters**

  - `path` — - The path of the property, you can use dot notation to override values in complex types.
  - `value` — - The value.

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

  Syntactic sugar for `addOverride("Properties.<...>", value)`.

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method only adds dependencies between L1 resources. If you are
  looking for a generic construct-to-construct dependency mechanism that works
  for all constructs including L2s, use `construct.node.addDependency` instead.

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

  When set, any cross-stack reference to this resource will use the specified
  strength instead of the global default from the consuming stack's context.

  **Parameters**

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

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — Sets the deletion policy of the resource based on the removal policy specified.

  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`). In some
  cases, a snapshot can be taken of the resource prior to deletion
  (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
  can be found in the following link:

- `arnForLifecyclePolicy(resource: ILifecyclePolicyRef): string` (static)

- `cfnPropertyName(cdkPropertyName: string): string`

- `fromLifecyclePolicyArn(scope: Construct, id: string, arn: string): ILifecyclePolicyRef` (static) — Creates a new ILifecyclePolicyRef from an ARN.

- `fromPolicyId(scope: Construct, id: string, policyId: string): ILifecyclePolicyRef` (static) — Creates a new ILifecyclePolicyRef from a policyId.

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference` — Returns a token for an runtime attribute of this resource.

  Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
  in case there is no generated attribute.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnLifecyclePolicy(x: any): boolean` (static) — Checks whether the given object is a CfnLifecyclePolicy.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

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

- `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on.

  For resources depended on directly, returns the `CfnResource` object. For
  dependencies on other stacks, returns the `Stack` object. The order of the
  array is not guaranteed.

- `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

  - `newLogicalId` — The new logical ID to use for this stack element.

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `removeResourceDependency(target: CfnResource): void` — Indicates that this resource no longer depends on another resource.

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `replaceDependency(target: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

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

  **Returns:** a string representation of this resource

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