feat(infra): Expose BucketDeploymentProps.retainOnDelete [CLK-255746] (#8)

* feat(infra): Expose retainOnDelete property from BucketDeploymentProps [CLK-255746]

* chore(infra): Add UTs [CLK-255746]

Author: Justinon

docs/interfaces/UploadProps.md

@@ -10,6 +10,7 @@
 - [fileName](UploadProps.md#filename)
 - [path](UploadProps.md#path)
 - [prune](UploadProps.md#prune)
+- [retainOnDelete](UploadProps.md#retainondelete)
 - [role](UploadProps.md#role)
 
 ## Properties
@@ -54,6 +55,25 @@ false
 
 ___
 
+### retainOnDelete
+
+• `Optional` `Readonly` **retainOnDelete**: `boolean`
+
+Whether or not to delete the objects from the bucket when this resource
+is deleted/updated from the stack.
+
+NOTE: Changing the logical ID of the `BucketDeployment` construct, without changing the destination
+(for example due to refactoring, or intentional ID change) **will result in the deletion of the objects**.
+This is because CloudFormation will first create the new resource, which will have no affect,
+followed by a deletion of the old resource, which will cause a deletion of the objects,
+since the destination hasn't changed, and `retainOnDelete` is `false`.
+
+**`Default`**
+
+true
+
+___
+
 ### role
 
 • `Optional` `Readonly` **role**: `IRole`

src/generator.ts

@@ -35,6 +35,19 @@ export interface UploadProps {
    * @default false
    */
   readonly prune?: boolean;
+  /**
+   * Whether or not to delete the objects from the bucket when this resource
+   * is deleted/updated from the stack.
+   *
+   * NOTE: Changing the logical ID of the `BucketDeployment` construct, without changing the destination
+   * (for example due to refactoring, or intentional ID change) **will result in the deletion of the objects**.
+   * This is because CloudFormation will first create the new resource, which will have no affect,
+   * followed by a deletion of the old resource, which will cause a deletion of the objects,
+   * since the destination hasn't changed, and `retainOnDelete` is `false`.
+   *
+   * @default true
+   */
+  readonly retainOnDelete?: boolean;
   /**
    * Used as the Lambda Execution Role for the BucketDeployment.
    * @default - role is created automatically by the Construct
@@ -163,6 +176,7 @@ export class Generator extends Construct {
       destinationKeyPrefix: this._uploadProps.path,
       sources: [Source.jsonData(this._uploadProps.fileName, contents)],
       prune: this._uploadProps.prune ?? false,
+      retainOnDelete: this._uploadProps.retainOnDelete,
       role: this._uploadProps.role,
     });
   }

test/generator.test.ts

@@ -1,7 +1,7 @@
 /* eslint-disable dot-notation */
 // ^ Helps us test private properties like functions and fields
 import { App, CfnElement, Stack } from 'aws-cdk-lib';
-import { Template } from 'aws-cdk-lib/assertions';
+import { Match, Template } from 'aws-cdk-lib/assertions';
 import { Role, ServicePrincipal } from 'aws-cdk-lib/aws-iam';
 import { schema } from './resources/test.schema';
 import { Generator, GeneratorFileType, GeneratorProps } from '../src';
@@ -90,6 +90,32 @@ describe('Generator', () => {
       });
     });
 
+    it('retains objects by default', () => {
+      new Generator(stack, 'Generator', actualProps);
+      const template = Template.fromStack(stack);
+      template.hasResourceProperties('Custom::CDKBucketDeployment', {
+        DestinationBucketKeyPrefix: actualProps.upload.path,
+        DestinationBucketName: actualProps.upload.bucketArn.split(':').pop(),
+        RetainOnDelete: Match.absent(),
+      });
+    });
+
+    it('does not retain objects when told not to', () => {
+      new Generator(stack, 'Generator', {
+        ...actualProps,
+        upload: {
+          ...actualProps.upload,
+          retainOnDelete: false,
+        },
+      });
+      const template = Template.fromStack(stack);
+      template.hasResourceProperties('Custom::CDKBucketDeployment', {
+        DestinationBucketKeyPrefix: actualProps.upload.path,
+        DestinationBucketName: actualProps.upload.bucketArn.split(':').pop(),
+        RetainOnDelete: false,
+      });
+    });
+
     it('uses custom Lambda execution role when set', () => {
       const testRole = new Role(stack, 'TestExecutionRole', { assumedBy: new ServicePrincipal('test.amazonaws.com') });
       new Generator(stack, 'Generator', {