feat(baseclass): updated description format

Author: Dinesh Sajwan

src/common/base-class/base-class.ts

@@ -15,6 +15,7 @@ import * as appsync from 'aws-cdk-lib/aws-appsync';
 import * as lambda from 'aws-cdk-lib/aws-lambda';
 import * as logs from 'aws-cdk-lib/aws-logs';
 import { Construct } from 'constructs';
+import { ConstructName } from './construct-name-enum';
 import { version } from '../helpers/utils';
 
 
@@ -43,7 +44,7 @@ export interface BaseClassProps {
    * name of the construct.
    *
    */
-  readonly constructorName: string;
+  readonly constructName: ConstructName;
 
   /**
    * construct id.
@@ -62,8 +63,17 @@ export interface BaseClassProps {
 
 export class BaseClass extends Construct {
 
-  static constructIdsStr: string='';
-  static constructNamesStr: string='';
+  protected static usageMetricMap : Record<string, number> ={
+    [ConstructName.AWSRAGAPPSYNCSTEPFNOPENSEARCH]: 0,
+    [ConstructName.AWSQAAPPSYNCOPENSEARCH]: 0,
+    [ConstructName.AWSSUMMARIZATIONAPPSYNCSTEPFN]: 0,
+    [ConstructName.AWSMODELDEPLOYMENTSAGEMAKER]: 0,
+    [ConstructName.CUSTOMSAGEMAKERENDPOINT]: 0,
+    [ConstructName.HUGGINGFACESAGEMAKERENDPOINT]: 0,
+    [ConstructName.JUMPSTARTSAGEMAKERENDPOINT]: 0,
+    [ConstructName.AWSCONTENTGENAPPSYNCLAMBDA]: 0,
+  };
+  
 
   /**
    * construct usage metric , added in template description
@@ -123,7 +133,7 @@ export class BaseClass extends Construct {
   */
   protected updateConstructUsageMetricCode(props: BaseClassProps, scope: Construct, lambdaFunctions: lambda.DockerImageFunction[],
   ) {
-    const solutionId = `genai_cdk_${version}/${props.constructorName}/${props.constructId}`;
+    const solutionId = `genai_cdk_${version}/${props.constructName}/${props.constructId}`;
 
     const enableOperationalMetric =
       props.enableOperationalMetric !== undefined &&
@@ -138,14 +148,19 @@ export class BaseClass extends Construct {
           );
         }
       }
-      // ADD unique key in template description 
-      // format  (usage metric id:usbxxxx) (version:1.xx) (construct name:awsappsyncXX1,awsappsyncXX2,awsappsyncXX3) (construct id:awsappsyncxxxx1,awsappsyncxxx2,awsappsyncxxx3)
-      BaseClass.constructIdsStr=BaseClass.constructIdsStr+', '+props.constructId;
-      BaseClass.constructNamesStr=BaseClass.constructNamesStr+', '+props.constructorName;
-
+     
+      if (props && BaseClass.usageMetricMap.hasOwnProperty(props.constructName)) {
+      BaseClass.usageMetricMap[props.constructName]=BaseClass.usageMetricMap[props.constructName]+1;
+       }
+       else{
+        throw Error('construct name is not present in usageMetricMap ')
+       }
+     
+      const usageMetricMapSerialized = JSON.stringify(BaseClass.usageMetricMap);
+
+  
       Stack.of(scope).templateOptions.description =
-      `(usage id :${this.constructUsageMetric})(version:${version}) (construct name:::${ BaseClass.constructIdsStr}) (construct id:::${ BaseClass.constructNamesStr})`;
-
+      `(usage id :${this.constructUsageMetric})(version:${version}) (constructs :::${ usageMetricMapSerialized}) `;
 
     };
   }

src/common/base-class/construct-name-enum.ts

@@ -0,0 +1,23 @@
+/**
+ *  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
+ *  with the License. A copy of the License is located at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
+ *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
+ *  and limitations under the License.
+ */
+export enum ConstructName {
+  AWSRAGAPPSYNCSTEPFNOPENSEARCH='C1',
+  AWSQAAPPSYNCOPENSEARCH='C2',
+  AWSSUMMARIZATIONAPPSYNCSTEPFN='C3',
+  AWSMODELDEPLOYMENTSAGEMAKER='C4',
+  CUSTOMSAGEMAKERENDPOINT='C5',
+  HUGGINGFACESAGEMAKERENDPOINT='C6',
+  JUMPSTARTSAGEMAKERENDPOINT='C7',
+  AWSCONTENTGENAPPSYNCLAMBDA='C8'
+
+}

src/common/base-class/index.ts

@@ -10,4 +10,5 @@
  *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
  *  and limitations under the License.
  */
-export * from './base-class';
+export * from './base-class';
+export * from './construct-name-enum';

src/index.ts

@@ -24,4 +24,5 @@ export { version } from './common/helpers/utils';
 export * from './common/props/DockerLambdaCustomProps';
 export * from './common/props/LangchainProps';
 export * from './common/props/AdapterProps';
-export * from './common/base-class';
+export * from './common/base-class/base-class';
+export * from './common/base-class/construct-name-enum';

src/patterns/gen-ai/aws-contentgen-appsync-lambda/index.ts

@@ -23,7 +23,7 @@ import * as logs from 'aws-cdk-lib/aws-logs';
 import * as s3 from 'aws-cdk-lib/aws-s3';
 import { NagSuppressions } from 'cdk-nag';
 import { Construct } from 'constructs';
-import { BaseClass, BaseClassProps } from '../../../common/base-class';
+import { BaseClass, BaseClassProps, ConstructName } from '../../../common/base-class';
 import { buildDockerLambdaFunction } from '../../../common/helpers/lambda-builder-helper';
 import * as s3_bucket_helper from '../../../common/helpers/s3-bucket-helper';
 import { lambdaMemorySizeLimiter } from '../../../common/helpers/utils';
@@ -174,7 +174,7 @@ export class ContentGenerationAppSyncLambda extends BaseClass {
     const baseProps: BaseClassProps={
       stage: props.stage,
       enableOperationalMetric: props.enableOperationalMetric,
-      constructorName: this.constructor.name,
+      constructName: ConstructName.AWSCONTENTGENAPPSYNCLAMBDA,
       constructId: id,
       observability: props.observability,
     };

src/patterns/gen-ai/aws-model-deployment-sagemaker/custom-sagemaker-endpoint.ts

@@ -17,6 +17,7 @@ import { Construct } from 'constructs';
 import { ContainerImage } from './container-image';
 import { SageMakerEndpointBase } from './sagemaker-endpoint-base';
 import { SageMakerInstanceType } from './sagemaker-instance-type';
+import { ConstructName } from '../../../common/base-class';
 import { BaseClassProps } from '../../../common/base-class/base-class';
 
 export interface CustomSageMakerEndpointProps {
@@ -57,7 +58,7 @@ export class CustomSageMakerEndpoint extends SageMakerEndpointBase implements ia
 
     const baseProps: BaseClassProps={
       enableOperationalMetric: props.enableOperationalMetric,
-      constructorName: this.constructor.name,
+      constructName: ConstructName.CUSTOMSAGEMAKERENDPOINT,
       constructId: id,
     };
 

src/patterns/gen-ai/aws-model-deployment-sagemaker/huggingface-sagemaker-endpoint.ts

@@ -17,6 +17,7 @@ import { Construct } from 'constructs';
 import { ContainerImage } from './container-image';
 import { SageMakerEndpointBase } from './sagemaker-endpoint-base';
 import { SageMakerInstanceType } from './sagemaker-instance-type';
+import { ConstructName } from '../../../common/base-class';
 import { BaseClassProps } from '../../../common/base-class/base-class';
 
 export interface HuggingFaceSageMakerEndpointProps {
@@ -55,7 +56,7 @@ export class HuggingFaceSageMakerEndpoint extends SageMakerEndpointBase implemen
 
     const baseProps: BaseClassProps={
       enableOperationalMetric: props.enableOperationalMetric,
-      constructorName: this.constructor.name,
+      constructName: ConstructName.HUGGINGFACESAGEMAKERENDPOINT,
       constructId: id,
     };
 

src/patterns/gen-ai/aws-model-deployment-sagemaker/jumpstart-sagemaker-endpoint.ts

@@ -20,6 +20,7 @@ import { JumpStartConstants } from './private/jumpstart-constants';
 import { SageMakerEndpointBase } from './sagemaker-endpoint-base';
 import { SageMakerInstanceType } from './sagemaker-instance-type';
 import { BaseClassProps } from '../../../common/base-class/base-class';
+import { ConstructName } from '../../../common/base-class/construct-name-enum';
 
 export interface JumpStartSageMakerEndpointProps {
   readonly model: JumpStartModel;
@@ -61,7 +62,7 @@ export class JumpStartSageMakerEndpoint extends SageMakerEndpointBase {
 
     const baseProps: BaseClassProps={
       enableOperationalMetric: props.enableOperationalMetric,
-      constructorName: this.constructor.name,
+      constructName: ConstructName.JUMPSTARTSAGEMAKERENDPOINT,
       constructId: id,
     };
 

src/patterns/gen-ai/aws-qa-appsync-opensearch/index.ts

@@ -26,7 +26,7 @@ import * as s3 from 'aws-cdk-lib/aws-s3';
 import * as secret from 'aws-cdk-lib/aws-secretsmanager';
 import { NagSuppressions } from 'cdk-nag';
 import { Construct } from 'constructs';
-import { BaseClass, BaseClassProps } from '../../../common/base-class';
+import { BaseClass, BaseClassProps, ConstructName } from '../../../common/base-class';
 import { buildDockerLambdaFunction } from '../../../common/helpers/lambda-builder-helper';
 import * as opensearch_helper from '../../../common/helpers/opensearch-helper';
 import * as s3_bucket_helper from '../../../common/helpers/s3-bucket-helper';
@@ -204,7 +204,7 @@ export class QaAppsyncOpensearch extends BaseClass {
     const baseProps: BaseClassProps={
       stage: props.stage,
       enableOperationalMetric: props.enableOperationalMetric,
-      constructorName: this.constructor.name,
+      constructName: ConstructName.AWSQAAPPSYNCOPENSEARCH,
       constructId: id,
       observability: props.observability,
     };

src/patterns/gen-ai/aws-rag-appsync-stepfn-opensearch/index.ts

@@ -29,6 +29,7 @@ import * as stepfn_task from 'aws-cdk-lib/aws-stepfunctions-tasks';
 import { NagSuppressions } from 'cdk-nag';
 import { Construct } from 'constructs';
 import { BaseClass, BaseClassProps } from '../../../common/base-class';
+import { ConstructName } from '../../../common/base-class/construct-name-enum';
 import { buildDockerLambdaFunction } from '../../../common/helpers/lambda-builder-helper';
 import * as opensearch_helper from '../../../common/helpers/opensearch-helper';
 import * as s3_bucket_helper from '../../../common/helpers/s3-bucket-helper';
@@ -243,10 +244,11 @@ export class RagAppsyncStepfnOpensearch extends BaseClass {
   constructor(scope: Construct, id: string, props: RagAppsyncStepfnOpensearchProps) {
     super(scope, id);
 
+
     const baseProps: BaseClassProps={
       stage: props.stage,
       enableOperationalMetric: props.enableOperationalMetric,
-      constructorName: this.constructor.name,
+      constructName: ConstructName.AWSRAGAPPSYNCSTEPFNOPENSEARCH,
       constructId: id,
       observability: props.observability,
     };

src/patterns/gen-ai/aws-summarization-appsync-stepfn/index.ts

@@ -28,6 +28,7 @@ import * as sfnTask from 'aws-cdk-lib/aws-stepfunctions-tasks';
 import { NagSuppressions } from 'cdk-nag';
 import { Construct } from 'constructs';
 import { BaseClass, BaseClassProps } from '../../../common/base-class/base-class';
+import { ConstructName } from '../../../common/base-class/construct-name-enum';
 import * as eventBridge from '../../../common/helpers/eventbridge-helper';
 import { buildDockerLambdaFunction } from '../../../common/helpers/lambda-builder-helper';
 import * as redisHelper from '../../../common/helpers/redis-helper';
@@ -268,7 +269,7 @@ export class SummarizationAppsyncStepfn extends BaseClass {
     const baseProps: BaseClassProps={
       stage: props.stage,
       enableOperationalMetric: props.enableOperationalMetric,
-      constructorName: this.constructor.name,
+      constructName: ConstructName.AWSSUMMARIZATIONAPPSYNCSTEPFN,
       constructId: id,
       observability: props.observability,
     };