feat(ecr): Add emptyOnDelete CloudFormation property to L2 construct

aws · Dec 2, 2023 · bed2d07 · bed2d07
1 parent 116b933
commit bed2d07
Show file tree

Hide file tree

Showing 10 changed files with 73 additions and 10 deletions.
diff --git a/...framework-integ/test/aws-ecr/test/integ.basic.js.snapshot/aws-ecr-integ-stack.assets.json b/...framework-integ/test/aws-ecr/test/integ.basic.js.snapshot/aws-ecr-integ-stack.assets.json
diff --git a/...amework-integ/test/aws-ecr/test/integ.basic.js.snapshot/aws-ecr-integ-stack.template.json b/...amework-integ/test/aws-ecr/test/integ.basic.js.snapshot/aws-ecr-integ-stack.template.json
@@ -65,6 +65,14 @@
      }
     ]
    }
+  },
+  "RepoWithEmptyOnDeleteCA5C67FA": {
+   "Type": "AWS::ECR::Repository",
+   "Properties": {
+    "EmptyOnDelete": true
+   },
+   "UpdateReplacePolicy": "Retain",
+   "DeletionPolicy": "Retain"
   }
  },
  "Outputs": {

diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-ecr/test/integ.basic.js.snapshot/cdk.out b/packages/@aws-cdk-testing/framework-integ/test/aws-ecr/test/integ.basic.js.snapshot/cdk.out
diff --git a/...t/integ.basic.js.snapshot/cdkecrintegtestbasicDefaultTestDeployAssert4F7FBFB4.assets.json b/...t/integ.basic.js.snapshot/cdkecrintegtestbasicDefaultTestDeployAssert4F7FBFB4.assets.json
diff --git a/...ges/@aws-cdk-testing/framework-integ/test/aws-ecr/test/integ.basic.js.snapshot/integ.json b/...ges/@aws-cdk-testing/framework-integ/test/aws-ecr/test/integ.basic.js.snapshot/integ.json
diff --git a/.../@aws-cdk-testing/framework-integ/test/aws-ecr/test/integ.basic.js.snapshot/manifest.json b/.../@aws-cdk-testing/framework-integ/test/aws-ecr/test/integ.basic.js.snapshot/manifest.json
diff --git a/...ages/@aws-cdk-testing/framework-integ/test/aws-ecr/test/integ.basic.js.snapshot/tree.json b/...ages/@aws-cdk-testing/framework-integ/test/aws-ecr/test/integ.basic.js.snapshot/tree.json
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-ecr/test/integ.basic.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-ecr/test/integ.basic.ts
@@ -17,6 +17,10 @@ const user = new iam.User(stack, 'MyUser');
 repo.grantRead(user);
 repo.grantPullPush(user);
 
+new ecr.Repository(stack, 'RepoWithEmptyOnDelete', {
+  emptyOnDelete: true,
+});
+
 new cdk.CfnOutput(stack, 'RepositoryURI', {
   value: repo.repositoryUri,
 });

diff --git a/packages/aws-cdk-lib/aws-ecr/lib/repository.ts b/packages/aws-cdk-lib/aws-ecr/lib/repository.ts
@@ -569,6 +569,13 @@ export interface RepositoryProps {
    * @default false
    */
   readonly autoDeleteImages?: boolean;
+
+  /**
+   * If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it.
+   *
+   * @default false
+   */
+  readonly emptyOnDelete?: boolean;
 }
 
 export interface RepositoryAttributes {
@@ -706,6 +713,7 @@ export class Repository extends RepositoryBase {
       imageScanningConfiguration: props.imageScanOnPush !== undefined ? { scanOnPush: props.imageScanOnPush } : undefined,
       imageTagMutability: props.imageTagMutability || undefined,
       encryptionConfiguration: this.parseEncryption(props),
+      emptyOnDelete: props.emptyOnDelete,
     });
     this._resource = resource;
 

diff --git a/packages/aws-cdk-lib/aws-ecr/test/repository.test.ts b/packages/aws-cdk-lib/aws-ecr/test/repository.test.ts
@@ -77,6 +77,17 @@ describe('repository', () => {
     });
   });
 
+  test('emptyOnDelete can be set', () => {
+    // GIVEN
+    const stack = new cdk.Stack();
+    new ecr.Repository(stack, 'Repo', { emptyOnDelete: true });
+
+    // THEN
+    Template.fromStack(stack).hasResourceProperties('AWS::ECR::Repository', {
+      EmptyOnDelete: true,
+    });
+  });
+
   test('add day-based lifecycle policy', () => {
     // GIVEN
     const stack = new cdk.Stack();