aws-cdk-lib.RemovalPolicyProps

RemovalPolicyProps Struct

Properties for applying a removal policy.

Source

core/lib/removal-policies.ts

Type last changed

v2.183.0 · 12 Mar 2025

Example

declare const scope: Construct;
declare const parent: Construct;
declare const bucket: s3.CfnBucket;

// Apply DESTROY policy to all resources in a scope
RemovalPolicies.of(scope).destroy();

// Apply RETAIN policy to all resources in a scope
RemovalPolicies.of(scope).retain();

// Apply SNAPSHOT policy to all resources in a scope
RemovalPolicies.of(scope).snapshot();

// Apply RETAIN_ON_UPDATE_OR_DELETE policy to all resources in a scope
RemovalPolicies.of(scope).retainOnUpdateOrDelete();

// Apply RETAIN policy only to specific resource types
RemovalPolicies.of(parent).retain({
  applyToResourceTypes: [
    'AWS::DynamoDB::Table',
    bucket.cfnResourceType, // 'AWS::S3::Bucket'
    rds.CfnDBInstance.CFN_RESOURCE_TYPE_NAME, // 'AWS::RDS::DBInstance'
  ],
});

// Apply SNAPSHOT policy excluding specific resource types
RemovalPolicies.of(scope).snapshot({
  excludeResourceTypes: ['AWS::Test::Resource'],
});

Properties

applyToResourceTypes?optionalstring[]apply_to_resource_types?optionaltyping.List[str]applyToResourceTypes?optionalList<String>ApplyToResourceTypes?optionalstring[]ApplyToResourceTypes?optional*[]*string#

Apply the removal policy only to specific resource types.

Default: apply to all resources

Can be a CloudFormation resource type string (e.g., 'AWS::S3::Bucket').

excludeResourceTypes?optionalstring[]exclude_resource_types?optionaltyping.List[str]excludeResourceTypes?optionalList<String>ExcludeResourceTypes?optionalstring[]ExcludeResourceTypes?optional*[]*string#

Exclude specific resource types from the removal policy.

Default: no exclusions

Can be a CloudFormation resource type string (e.g., 'AWS::S3::Bucket').

priority?optionalnumberpriority?optionalint | floatpriority?optionalNumberPriority?optionaldoublePriority?optional*float64= AspectPriority.MUTATING#

The priority to use when applying this policy.

notes

The priority affects only the order in which aspects are applied during synthesis. For RemovalPolicies, the last applied policy will override previous ones.

NOTE: Priority does NOT determine which policy "wins" when there are conflicts. The order of application determines the final policy, with later policies overriding earlier ones.