feat: Adds optional description field to CfnDatabaseUserProps and update documentation of using empty string for custom db role (#446)

Author: EspenAlbert

API.md

@@ -21,14 +21,12 @@ export class CdkTestingStack extends cdk.Stack {
       profile: atlasProps.profile,
       actions:[
         {
-          action: "GROUP_READ",
+          action: "FIND",
           resources: [
             {
               collection: atlasProps.collectionName,
-            },
-            {
               db: atlasProps.dbName,
-            }
+            },
           ]
         }
       ],

examples/l1-resources/custom-db-role.ts

@@ -10,6 +10,7 @@ interface AtlasStackProps {
   readonly dbName: string;
   readonly username: string;
   readonly password: string;
+  readonly description: string;
 }
 
 export class CdkTestingStack extends cdk.Stack {
@@ -23,6 +24,7 @@ export class CdkTestingStack extends cdk.Stack {
       username: atlasProps.username,
       password: atlasProps.password,
       databaseName: atlasProps.dbName,
+      description: atlasProps.description,
       roles: [ 
         {
           roleName: atlasProps.roleName,
@@ -43,6 +45,7 @@ export class CdkTestingStack extends cdk.Stack {
     const dbName = this.node.tryGetContext('dbName');
     const username = this.node.tryGetContext('username');
     const password = this.node.tryGetContext('password');
+    const description = this.node.tryGetContext('userDescription');
 
 
     return {
@@ -51,7 +54,8 @@ export class CdkTestingStack extends cdk.Stack {
       roleName,
       dbName,
       username,
-      password
+      password,
+      description
     }
   }
 }

examples/l1-resources/database-user.ts

@@ -154,14 +154,14 @@ export function toJson_InheritedRole(
  */
 export interface Resource {
   /**
-   * Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the actions.resources.db parameter. If you set "actions.resources.cluster" : true, MongoDB Cloud ignores this parameter.
+   * Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the actions.resources.db parameter. If you set "actions.resources.cluster" : true, MongoDB Cloud ignores this parameter. Use the empty string ("") to allow an action on all collections.
    *
    * @schema Resource#Collection
    */
   readonly collection?: string;
 
   /**
-   * Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set "actions.resources.cluster" : true, MongoDB Cloud ignores this parameter.
+   * Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set "actions.resources.cluster" : true, MongoDB Cloud ignores this parameter. Use the empty string ("") to allow an action on all databases.
    *
    * @schema Resource#DB
    */

src/l1-resources/custom-db-role/index.ts

@@ -29,6 +29,13 @@ export interface CfnDatabaseUserProps {
    */
   readonly databaseName: string;
 
+  /**
+   * Description of this database user.
+   *
+   * @schema CfnDatabaseUserProps#Description
+   */
+  readonly description?: string;
+
   /**
    * List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.
    *
@@ -107,6 +114,7 @@ export function toJson_CfnDatabaseUserProps(
     DeleteAfterDate: obj.deleteAfterDate,
     AWSIAMType: obj.awsiamType,
     DatabaseName: obj.databaseName,
+    Description: obj.description,
     Labels: obj.labels?.map((y) => toJson_LabelDefinition(y)),
     LdapAuthType: obj.ldapAuthType,
     X509Type: obj.x509Type,