feat(glue): database description property (#27744)

Closes #27740. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Dec 30, 2023 · cbac240 · cbac240
1 parent a59dc0c
commit cbac240
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 7 deletions.
diff --git a/packages/@aws-cdk/aws-glue-alpha/README.md b/packages/@aws-cdk/aws-glue-alpha/README.md
@@ -202,7 +202,10 @@ See [documentation](https://docs.aws.amazon.com/glue/latest/dg/encryption-securi
 A `Database` is a logical grouping of `Tables` in the Glue Catalog.
 
 ```ts
-new glue.Database(this, 'MyDatabase');
+new glue.Database(this, 'MyDatabase', {
+  databaseName: 'my_database',
+  description: 'my_database_description',
+});
 ```
 
 ## Table

diff --git a/packages/@aws-cdk/aws-glue-alpha/lib/database.ts b/packages/@aws-cdk/aws-glue-alpha/lib/database.ts
@@ -43,6 +43,13 @@ export interface DatabaseProps {
    * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html
    */
   readonly locationUri?: string;
+
+  /**
+   * A description of the database.
+   *
+   * @default - no database description
+   */
+  readonly description?: string;
 }
 
 /**
@@ -96,8 +103,13 @@ export class Database extends Resource implements IDatabase {
         }),
     });
 
+    if (props.description !== undefined) {
+      validateDescription(props.description);
+    }
+
     let databaseInput: CfnDatabase.DatabaseInputProperty = {
       name: this.physicalName,
+      description: props.description,
     };
 
     if (props.locationUri !== undefined) {
@@ -133,6 +145,12 @@ export class Database extends Resource implements IDatabase {
 
 function validateLocationUri(locationUri: string): void {
   if (locationUri.length < 1 || locationUri.length > 1024) {
-    throw new Error(`locationUri length must be (inclusively) between 1 and 1024, but was ${locationUri.length}`);
+    throw new Error(`locationUri length must be (inclusively) between 1 and 1024, got ${locationUri.length}`);
+  }
+}
+
+function validateDescription(description: string): void {
+  if (description.length > 2048) {
+    throw new Error(`description length must be less than or equal to 2048, got ${description.length}`);
   }
 }
diff --git a/packages/@aws-cdk/aws-glue-alpha/test/database.test.ts b/packages/@aws-cdk/aws-glue-alpha/test/database.test.ts
@@ -58,6 +58,29 @@ test('explicit locationURI', () => {
 
 });
 
+test('explicit description', () => {
+  new glue.Database(stack, 'Database', {
+    description: 'database-description',
+  });
+
+  Template.fromStack(stack).templateMatches({
+    Resources: {
+      DatabaseB269D8BB: {
+        Type: 'AWS::Glue::Database',
+        Properties: {
+          CatalogId: {
+            Ref: 'AWS::AccountId',
+          },
+          DatabaseInput: {
+            Description: 'database-description',
+            Name: 'database',
+          },
+        },
+      },
+    },
+  });
+});
+
 test('fromDatabase', () => {
   // WHEN
   const database = glue.Database.fromDatabaseArn(stack, 'import', 'arn:aws:glue:us-east-1:123456789012:database/db1');
@@ -85,7 +108,15 @@ test('locationUri length must be <= 1024', () => {
     new glue.Database(stack, 'Database', {
       locationUri: 'a'.repeat(1025),
     }),
-  ).toThrow();
+  ).toThrow('locationUri length must be (inclusively) between 1 and 1024, got 1025');
+});
+
+test('description length must be <= 2048', () => {
+  expect(() =>
+    new glue.Database(stack, 'Database', {
+      description: 'a'.repeat(2049),
+    }),
+  ).toThrow('description length must be less than or equal to 2048, got 2049');
 });
 
 test('can specify a physical name', () => {

diff --git a/packages/@aws-cdk/aws-glue-alpha/test/integ.table.js.snapshot/aws-cdk-glue.assets.json b/packages/@aws-cdk/aws-glue-alpha/test/integ.table.js.snapshot/aws-cdk-glue.assets.json
diff --git a/packages/@aws-cdk/aws-glue-alpha/test/integ.table.js.snapshot/aws-cdk-glue.template.json b/packages/@aws-cdk/aws-glue-alpha/test/integ.table.js.snapshot/aws-cdk-glue.template.json
@@ -12,6 +12,7 @@
      "Ref": "AWS::AccountId"
     },
     "DatabaseInput": {
+     "Description": "my_database_description",
      "Name": "my_database"
     }
    }

diff --git a/packages/@aws-cdk/aws-glue-alpha/test/integ.table.js.snapshot/manifest.json b/packages/@aws-cdk/aws-glue-alpha/test/integ.table.js.snapshot/manifest.json
diff --git a/packages/@aws-cdk/aws-glue-alpha/test/integ.table.js.snapshot/tree.json b/packages/@aws-cdk/aws-glue-alpha/test/integ.table.js.snapshot/tree.json
diff --git a/packages/@aws-cdk/aws-glue-alpha/test/integ.table.ts b/packages/@aws-cdk/aws-glue-alpha/test/integ.table.ts
@@ -16,6 +16,7 @@ const bucket = new s3.Bucket(stack, 'DataBucket', {
 
 const database = new glue.Database(stack, 'MyDatabase', {
   databaseName: 'my_database',
+  description: 'my_database_description',
 });
 
 const columns = [{