feat(custom-resource): expose removalPolicy (#25235)

Added `removalPolicy` property to `AwsCustomResource`.

Closes #25220.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: lpizzinidev

packages/aws-cdk-lib/custom-resources/README.md

@@ -513,7 +513,7 @@ In both the cases, you will get a synth time error if you attempt to use it in c
 
 ### Customizing the Lambda function implementing the custom resource
 
-Use the `role`, `timeout`, `logRetention` and `functionName` properties to customize
+Use the `role`, `timeout`, `logRetention`, `functionName` and `removalPolicy` properties to customize
 the Lambda function implementing the custom resource:
 
 ```ts
@@ -523,6 +523,7 @@ new cr.AwsCustomResource(this, 'Customized', {
   timeout: Duration.minutes(10), // defaults to 2 minutes
   logRetention: logs.RetentionDays.ONE_WEEK, // defaults to never delete logs
   functionName: 'my-custom-name', // defaults to a CloudFormation generated name
+  removalPolicy: cdk.RemovalPolicy.RETAIN, // defaults to `cdk.RemovalPolicy.DESTROY`
   policy: cr.AwsCustomResourcePolicy.fromSdkCalls({
     resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE,
   }),

packages/aws-cdk-lib/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts

@@ -325,6 +325,13 @@ export interface AwsCustomResourceProps {
    */
   readonly functionName?: string;
 
+  /**
+   * The policy to apply when this resource is removed from the application.
+   *
+   * @default cdk.RemovalPolicy.Destroy
+   */
+  readonly removalPolicy?: cdk.RemovalPolicy;
+
   /**
    * The vpc to provision the lambda function in.
    *
@@ -440,6 +447,7 @@ export class AwsCustomResource extends Construct implements iam.IGrantable {
       resourceType: props.resourceType || 'Custom::AWS',
       serviceToken: provider.functionArn,
       pascalCaseProperties: true,
+      removalPolicy: props.removalPolicy,
       properties: {
         create: create && this.encodeJson(create),
         update: props.onUpdate && this.encodeJson(props.onUpdate),

packages/aws-cdk-lib/custom-resources/test/aws-custom-resource/aws-custom-resource.test.ts

@@ -1237,4 +1237,45 @@ test.each([
   Template.fromStack(stack).hasResourceProperties('Custom::LogRetentionPolicy', {
     'InstallLatestAwsSdk': expected,
   });
-});
+});
+
+test('default removal policy is DESTROY', () => {
+  // GIVEN
+  const stack = new cdk.Stack();
+
+  // WHEN
+  new AwsCustomResource(stack, 'AwsSdk', {
+    onCreate: {
+      service: 'service',
+      action: 'action',
+      physicalResourceId: PhysicalResourceId.of('id'),
+    },
+    policy: AwsCustomResourcePolicy.fromSdkCalls({ resources: AwsCustomResourcePolicy.ANY_RESOURCE }),
+  });
+
+  // THEN
+  Template.fromStack(stack).hasResource('Custom::AWS', {
+    DeletionPolicy: 'Delete',
+  });
+});
+
+test('can specify removal policy', () => {
+  // GIVEN
+  const stack = new cdk.Stack();
+
+  // WHEN
+  new AwsCustomResource(stack, 'AwsSdk', {
+    onCreate: {
+      service: 'service',
+      action: 'action',
+      physicalResourceId: PhysicalResourceId.of('id'),
+    },
+    policy: AwsCustomResourcePolicy.fromSdkCalls({ resources: AwsCustomResourcePolicy.ANY_RESOURCE }),
+    removalPolicy: cdk.RemovalPolicy.RETAIN,
+  });
+
+  // THEN
+  Template.fromStack(stack).hasResource('Custom::AWS', {
+    DeletionPolicy: 'Retain',
+  });
+});