INTMDB-800: update field descriptions for CfnDatabaseUser (#57)

Author: maastha

API.md

@@ -21,24 +21,24 @@ MongoDB::Atlas::AlertConfiguration \
   --execution-role-arn <role-arn>
 ```
 ### Running unit tests:
-5. Ensure unit tests for each resource (located in `[resource-folder]/test/index.test.ts)` are updated and successful.
+5. Ensure unit tests for each resource (located in `/test/[resource-folder]/index.test.ts)` are updated and successful.
  - Run unit tests with `npx projen test` inside the resource folder
 ```
 # if you created an L1 resource
-cd cdk/cdk-resouces/[resource-folder]
+cd test/l1-resources/[resource-folder]
 
 # if you created an L2 resource
-cd cdk/l2-cdk-resources/[resource-folder]
+cd test/l2-resources/[resource-folder]
 
 # if you created an L3 resource
-cd cdk/l3-cdk-resources/[resource-folder]
+cd test/l3-resources/[resource-folder]
 
 npx projen test 
 ```
 
 ## Testing the resource in a CFN stack:
-1. Build the construct by running `npx projen build` inside the `[resource-folder]`.
-2. Navigate inside `/[resource-folder]/dist/js` and copy the`.tgz` file. You will use this in the next steps.
+1. Build the construct by running `npx projen build`.
+2. Navigate inside `/dist/js` and copy the`.tgz` file. You will use this in the next steps.
 3. Create a CDK test app: We will be using a CDK app to test our construct by using the app to create, update and delete AWS CloudFormation stacks.
 Create the CDK app by running the following in a terminal: ([refer AWS walkthrough for details](https://docs.aws.amazon.com/cdk/v2/guide/hello_world.html#hello_world_tutorial_create_app)):
 ```

TESTING.md

@@ -16,14 +16,14 @@ export interface CfnDatabaseUserProps {
   readonly deleteAfterDate?: string;
 
   /**
-   * Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role.
+   * Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role. Default value is `NONE`.
    *
    * @schema CfnDatabaseUserProps#AWSIAMType
    */
   readonly awsiamType?: CfnDatabaseUserPropsAwsiamType;
 
   /**
-   * MongoDB database against which the MongoDB database user authenticates. MongoDB database users must provide both a username and authentication database to log into MongoDB.
+   * MongoDB database against which the MongoDB database user authenticates. MongoDB database users must provide both a username and authentication database to log into MongoDB.  Default value is `admin`.
    *
    * @schema CfnDatabaseUserProps#DatabaseName
    */
@@ -37,14 +37,14 @@ export interface CfnDatabaseUserProps {
   readonly labels?: LabelDefinition[];
 
   /**
-   * Method by which the provided username is authenticated. If no value is given, Atlas uses the default value of NONE.
+   * Method by which the provided username is authenticated. Default value is `NONE`.
    *
    * @schema CfnDatabaseUserProps#LdapAuthType
    */
   readonly ldapAuthType?: CfnDatabaseUserPropsLdapAuthType;
 
   /**
-   * Method that briefs who owns the certificate provided. If no value is given while using X509Type, Atlas uses the default value of MANAGED.
+   * Method that briefs who owns the certificate provided. Default value is `NONE`.
    *
    * @schema CfnDatabaseUserProps#X509Type
    */
@@ -58,7 +58,7 @@ export interface CfnDatabaseUserProps {
   readonly password?: string;
 
   /**
-   * Unique identifier of the Atlas project to which the user belongs.
+   * Unique 24-hexadecimal digit string that identifies your Atlas Project.
    *
    * @schema CfnDatabaseUserProps#ProjectId
    */
@@ -79,14 +79,14 @@ export interface CfnDatabaseUserProps {
   readonly scopes?: ScopeDefinition[];
 
   /**
-   * Human-readable label that represents the user that authenticates to MongoDB.
+   * Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication. This will be USER_ARN or ROLE_ARN if AWSIAMType is USER or ROLE. Refer https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Database-Users/operation/createDatabaseUser for details.
    *
    * @schema CfnDatabaseUserProps#Username
    */
   readonly username: string;
 
   /**
-   * Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used
+   * Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided `default` is used
    *
    * @schema CfnDatabaseUserProps#Profile
    */
@@ -177,7 +177,7 @@ export function toJson_LabelDefinition(
 /* eslint-enable max-len, quote-props */
 
 /**
- * Method by which the provided username is authenticated. If no value is given, Atlas uses the default value of NONE.
+ * Method by which the provided username is authenticated. Default value is `NONE`.
  *
  * @schema CfnDatabaseUserPropsLdapAuthType
  */
@@ -191,7 +191,7 @@ export enum CfnDatabaseUserPropsLdapAuthType {
 }
 
 /**
- * Method that briefs who owns the certificate provided. If no value is given while using X509Type, Atlas uses the default value of MANAGED.
+ * Method that briefs who owns the certificate provided. Default value is `NONE`.
  *
  * @schema CfnDatabaseUserPropsX509Type
  */

src/l1-resources/database-user/index.ts

@@ -79,7 +79,7 @@ export interface AtlasBasicPrivateEndpointProps {
   readonly profile?: string;
 
   /**
-   * @description
+   * @description AWS Region
    * @type {string}
    * @default us-east-1
    * @memberof AtlasPrivateEndpointProps
@@ -106,25 +106,25 @@ export interface AtlasBasicPrivateEndpointProps {
  */
 export interface PrivateEndpointProps {
   /**
-   * @description
+   * @description Name of the AWS PrivateLink endpoint service. Atlas returns null while it is creating the endpoint service.
    * @type {string}
    * @memberof PrivateEndpointProps
    */
   readonly endpointServiceName?: string;
   /**
-   * @description
+   * @description Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.
    * @type {string}
    * @memberof PrivateEndpointProps
    */
   readonly errorMessage?: string;
   /**
-   * @description
+   * @description Status of the Atlas PrivateEndpoint service connection
    * @type {string}
    * @memberof PrivateEndpointProps
    */
   readonly status?: string;
   /**
-   * @description
+   * @description Unique 24-hexadecimal digit string that identifies your project.
    * @type {string}
    * @memberof PrivateEndpointProps
    */