fix: docs and unit tests

aws · May 11, 2024 · ec3ebd4 · ec3ebd4
1 parent a48bc2d
commit ec3ebd4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 27 deletions.
diff --git a/packages/aws-cdk-lib/aws-docdb/lib/cluster.ts b/packages/aws-cdk-lib/aws-docdb/lib/cluster.ts
@@ -221,7 +221,7 @@ export interface DatabaseClusterProps {
   /**
    * Whether to copy tags to the snapshot when a snapshot is created.
    *
-   * @default - not copy tags to the snapshot
+   * @default - false
    */
   readonly copyTagsToSnapshot?: boolean;
 }

diff --git a/packages/aws-cdk-lib/aws-docdb/test/cluster.test.ts b/packages/aws-cdk-lib/aws-docdb/test/cluster.test.ts
@@ -1136,30 +1136,7 @@ describe('DatabaseCluster', () => {
     });
   });
 
-  test('cluster with copyTagsToSnapshot disabled', () => {
-    // GIVEN
-    const stack = testStack();
-    const vpc = new ec2.Vpc(stack, 'VPC');
-
-    // WHEN
-    new DatabaseCluster(stack, 'Database', {
-      masterUser: {
-        username: 'admin',
-        password: cdk.SecretValue.unsafePlainText('tooshort'),
-      },
-      instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.SMALL),
-      vpc,
-      copyTagsToSnapshot: false,
-    });
-
-    // THEN
-    Template.fromStack(stack).hasResourceProperties('AWS::DocDB::DBCluster', {
-      CopyTagsToSnapshot: false,
-    });
-  });
-
-  test('cluster with copyTagsToSnapshot enabled', () => {
-    // GIVEN
+  test.each([false, true])('cluster with copyTagsToSnapshot set', (value) => {
     const stack = testStack();
     const vpc = new ec2.Vpc(stack, 'VPC');
 
@@ -1171,12 +1148,12 @@ describe('DatabaseCluster', () => {
       },
       instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.SMALL),
       vpc,
-      copyTagsToSnapshot: true,
+      copyTagsToSnapshot: value,
     });
 
     // THEN
     Template.fromStack(stack).hasResourceProperties('AWS::DocDB::DBCluster', {
-      CopyTagsToSnapshot: true,
+      CopyTagsToSnapshot: value,
     });
   });
 });