@gradientedge/cdk-utils 9.11.0 → 9.13.0

package/dist/src/lib/aws/common/index.d.ts

@@ -1,3 +1,4 @@
 export * from './construct';
+export * from './resource-name-formatter';
 export * from './stack';
 export * from './types';

package/dist/src/lib/aws/common/index.js

@@ -15,5 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./construct"), exports);
+__exportStar(require("./resource-name-formatter"), exports);
 __exportStar(require("./stack"), exports);
 __exportStar(require("./types"), exports);

package/dist/src/lib/aws/common/resource-name-formatter.js

@@ -16,9 +16,11 @@ class ResourceNameFormatter extends constructs_1.Construct {
      */
     format(resourceName, options) {
         const resourceNameElements = [];
+        resourceNameElements.push(options?.globalPrefix ? this.props.globalPrefix : undefined);
         resourceNameElements.push(options?.prefix ?? this.props.resourcePrefix);
         resourceNameElements.push(resourceName);
         resourceNameElements.push(options?.suffix ?? this.props.resourceSuffix);
+        resourceNameElements.push(options?.globalSuffix ? this.props.globalSuffix : undefined);
         resourceNameElements.push(this.props.stage);
         return resourceNameElements.filter(resourceNameElement => resourceNameElement != undefined).join('-');
     }

package/dist/src/lib/aws/common/stack.d.ts

@@ -33,6 +33,8 @@ export declare class CommonStack extends Stack {
         name: string;
         nodejsRuntime: any;
         region: any;
+        globalPrefix: any;
+        globalSuffix: any;
         resourcePrefix: any;
         resourceSuffix: any;
         skipStageForARecords: any;

package/dist/src/lib/aws/common/stack.js

@@ -53,6 +53,8 @@ class CommonStack extends aws_cdk_lib_1.Stack {
             name: props.stackName || 'cdk-utils',
             nodejsRuntime: this.node.tryGetContext('nodejsRuntime') ?? CommonStack.NODEJS_RUNTIME,
             region: this.node.tryGetContext('region'),
+            globalPrefix: this.node.tryGetContext('globalPrefix'),
+            globalSuffix: this.node.tryGetContext('globalSuffix'),
             resourcePrefix: this.node.tryGetContext('resourcePrefix'),
             resourceSuffix: this.node.tryGetContext('resourceSuffix'),
             skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),

package/dist/src/lib/aws/common/types.d.ts

@@ -7,6 +7,8 @@ import { BaseProps } from '../../common';
 export interface CommonStackProps extends BaseProps, StackProps {
     region: string;
     resourceProjectIdentifier?: string;
+    globalPrefix?: string;
+    globalSuffix?: string;
     resourcePrefix?: string;
     resourceSuffix?: string;
     logRetention?: RetentionDays;
@@ -17,6 +19,8 @@ export interface CommonStackProps extends BaseProps, StackProps {
     nodejsRuntime?: Runtime;
 }
 export interface ResourceNameFormatterProps {
+    globalPrefix?: boolean;
+    globalSuffix?: boolean;
     prefix?: string;
     suffix?: string;
 }

package/dist/src/lib/aws/construct/rest-api-lambda-with-cache/main.js

@@ -55,7 +55,7 @@ class RestApiLambdaWithCache extends __1.RestApiLambda {
             this.restApivpc = this.vpcManager.retrieveCommonVpc(`${this.id}-vpc`, this, this.props.vpcName);
         }
         else {
-            this.restApivpc = this.vpcManager.createCommonVpc(this, this.props.restApiVpc, this.props.restApiVpc.vpcName);
+            this.restApivpc = this.vpcManager.createCommonVpc(`${this.id}-vpc`, this, this.props.restApiVpc, this.props.restApiVpc.vpcName);
         }
     }
     /**

package/dist/src/lib/aws/construct/site-with-ecs-backend/main.js

@@ -149,10 +149,10 @@ class SiteWithEcsBackend extends common_1.CommonConstruct {
      */
     createVpc() {
         if (this.props.useExistingVpc) {
-            this.siteVpc = this.vpcManager.retrieveCommonVpc(`${this.id}`, this, this.props.siteVpc.vpcName);
+            this.siteVpc = this.vpcManager.retrieveCommonVpc(`${this.id}-vpc`, this, this.props.siteVpc.vpcName);
         }
         else {
-            this.siteVpc = this.vpcManager.createCommonVpc(this, this.props.siteVpc, this.props.siteVpc.vpcName);
+            this.siteVpc = this.vpcManager.createCommonVpc(`${this.id}-vpc`, this, this.props.siteVpc, this.props.siteVpc.vpcName);
         }
     }
     /**

package/dist/src/lib/aws/services/dynamodb/main.js

@@ -34,9 +34,11 @@ class DynamodbManager {
     createTable(id, scope, props) {
         if (!props)
             throw `Table props undefined for ${id}`;
+        if (!props.tableName)
+            throw `Table tableName undefined for ${id}`;
         const table = new aws_dynamodb_1.Table(scope, `${id}`, {
             ...props,
-            tableName: `${props.tableName}-${scope.props.stage}`,
+            tableName: scope.resourceNameFormatter.format(props.tableName, props.resourceNameOptions),
         });
         if (props.tags && !lodash_1.default.isEmpty(props.tags)) {
             lodash_1.default.forEach(props.tags, tag => {
@@ -62,6 +64,11 @@ class DynamodbManager {
             ...props,
             tableName: scope.resourceNameFormatter.format(props.tableName, props.resourceNameOptions),
         });
+        if (props.tags && !lodash_1.default.isEmpty(props.tags)) {
+            lodash_1.default.forEach(props.tags, tag => {
+                aws_cdk_lib_1.Tags.of(table).add(tag.key, tag.value);
+            });
+        }
         (0, utils_1.createCfnOutput)(`${id}-tableName`, scope, table.tableName);
         (0, utils_1.createCfnOutput)(`${id}-tableArn`, scope, table.tableArn);
         return table;

package/dist/src/lib/aws/services/dynamodb/types.d.ts

@@ -4,8 +4,10 @@ import { TagProps } from '../../types';
 /**
  */
 export interface TableProps extends dynamodb.TableProps {
+    resourceNameOptions?: ResourceNameFormatterProps;
     tags?: TagProps[];
 }
 export interface TablePropsV2 extends dynamodb.TablePropsV2 {
     resourceNameOptions?: ResourceNameFormatterProps;
+    tags?: TagProps[];
 }

package/dist/src/lib/aws/services/key-management-service/main.js

@@ -29,9 +29,11 @@ class KmsManager {
     createKey(id, scope, props) {
         if (!props)
             throw `KMS Key props undefined for ${id}`;
+        if (!props.alias)
+            throw `KMS Key alias undefined for ${id}`;
         const key = new aws_kms_1.Key(scope, `${id}`, {
             ...props,
-            alias: `${props.alias}-${scope.props.stage}`,
+            alias: scope.resourceNameFormatter.format(props.alias, props.resourceNameOptions),
         });
         (0, utils_1.createCfnOutput)(`${id}-keyId`, scope, key.keyId);
         (0, utils_1.createCfnOutput)(`${id}-keyArn`, scope, key.keyArn);

package/dist/src/lib/aws/services/key-management-service/types.d.ts

@@ -1,5 +1,7 @@
 import { KeyProps } from 'aws-cdk-lib/aws-kms';
+import { ResourceNameFormatterProps } from '../../common';
 /**
  */
 export interface KmsKeyProps extends KeyProps {
+    resourceNameOptions?: ResourceNameFormatterProps;
 }

package/dist/src/lib/aws/services/simple-storage-service/main.js

@@ -95,8 +95,7 @@ class S3Manager {
         else {
             let logBucket;
             if (props.logBucketName) {
-                const logBucketName = S3Manager.determineBucketName(scope, props, props.logBucketName);
-                logBucket = aws_s3_1.Bucket.fromBucketName(scope, `${id}-logs`, props.logBucketName);
+                logBucket = aws_s3_1.Bucket.fromBucketName(scope, `${id}-logs`, S3Manager.determineBucketName(scope, props, props.logBucketName));
             }
             bucket = new aws_s3_1.Bucket(scope, `${id}-bucket`, {
                 ...props,

package/dist/src/lib/aws/services/systems-manager/main.d.ts

@@ -1,7 +1,7 @@
-import { StringParameter, StringParameterProps } from 'aws-cdk-lib/aws-ssm';
+import { StringParameter } from 'aws-cdk-lib/aws-ssm';
 import { AwsCustomResource } from 'aws-cdk-lib/custom-resources';
 import { CommonConstruct } from '../../common';
-import { SSMParameterReaderProps } from './types';
+import { SSMParameterReaderProps, SSMStringParameterProps } from './types';
 /**
  * @classdesc Provides operations on AWS Systems Manager.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
@@ -26,7 +26,7 @@ export declare class SsmManager {
      * @param scope scope in which this resource is defined
      * @param props parameter props
      */
-    writeStringToParameters(id: string, scope: CommonConstruct, props: StringParameterProps): StringParameter;
+    writeStringToParameters(id: string, scope: CommonConstruct, props: SSMStringParameterProps): StringParameter;
     /**
      * Method to read a string parameter from the parameters store
      * @param id scoped id of the resource

package/dist/src/lib/aws/services/systems-manager/main.js

@@ -31,10 +31,12 @@ class SsmManager {
     writeStringToParameters(id, scope, props) {
         if (!props)
             throw `Parameter props undefined for ${id}`;
+        if (!props.parameterName)
+            throw `Parameter parameterName undefined for ${id}`;
         const parameter = new aws_ssm_1.StringParameter(scope, `${id}`, {
             ...props,
             description: `${props.description} - ${scope.props.stage} stage`,
-            parameterName: `${props.parameterName}-${scope.props.stage}`,
+            parameterName: scope.resourceNameFormatter.format(props.parameterName, props.resourceNameOptions),
         });
         (0, utils_1.createCfnOutput)(`${id}-parameterArn`, scope, parameter.parameterArn);
         (0, utils_1.createCfnOutput)(`${id}-parameterName`, scope, parameter.parameterName);

package/dist/src/lib/aws/services/systems-manager/types.d.ts

@@ -1,6 +1,11 @@
+import { StringParameterProps } from 'aws-cdk-lib/aws-ssm';
+import { ResourceNameFormatterProps } from '../../common';
 /**
  */
 export interface SSMParameterReaderProps {
     parameterName: string;
     region: string;
 }
+export interface SSMStringParameterProps extends StringParameterProps {
+    resourceNameOptions?: ResourceNameFormatterProps;
+}

package/dist/src/lib/aws/services/virtual-private-cloud/main.d.ts

@@ -27,11 +27,12 @@ export declare class VpcManager {
     createVpc(id: string, scope: CommonConstruct, props: VpcProps): Vpc;
     /**
      * @summary Method to create a common vpc
+     * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param props
      * @param vpcIdentifier optional identifier for VPC
      */
-    createCommonVpc(scope: CommonConstruct, props: VpcProps, vpcIdentifier?: string): Vpc;
+    createCommonVpc(id: string, scope: CommonConstruct, props: VpcProps, vpcIdentifier?: string): Vpc;
     /**
      * @summary Method to retrieve a common vpc
      * @param id scoped id of the resource

package/dist/src/lib/aws/services/virtual-private-cloud/main.js

@@ -53,7 +53,10 @@ class VpcManager {
             });
         }
         else {
-            vpc = new aws_ec2_1.Vpc(scope, `${id}`, props);
+            vpc = new aws_ec2_1.Vpc(scope, `${id}`, {
+                ...props,
+                vpcName,
+            });
         }
         (0, utils_1.createCfnOutput)(`${id}Id`, scope, vpc.vpcId);
         (0, utils_1.createCfnOutput)(`${id}PublicSubnetIds`, scope, lodash_1.default.map(vpc.publicSubnets, subnet => subnet.subnetId).toString());
@@ -66,13 +69,14 @@ class VpcManager {
     }
     /**
      * @summary Method to create a common vpc
+     * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param props
      * @param vpcIdentifier optional identifier for VPC
      */
-    createCommonVpc(scope, props, vpcIdentifier) {
-        const vpc = this.createVpc(CommonVpcIdentifier, scope, props);
-        aws_cdk_lib_1.Tags.of(vpc).add('Name', vpcIdentifier ?? CommonVpcIdentifier);
+    createCommonVpc(id, scope, props, vpcIdentifier) {
+        const vpc = this.createVpc(id, scope, props);
+        aws_cdk_lib_1.Tags.of(vpc).add('Name', scope.resourceNameFormatter.format(vpcIdentifier ?? CommonVpcIdentifier, props.resourceNameOptions));
         return vpc;
     }
     /**
@@ -82,7 +86,6 @@ class VpcManager {
      * @param vpcIdentifier optional identifier for VPC
      */
     retrieveCommonVpc(id, scope, vpcIdentifier) {
-        const vpcName = scope.resourceNameFormatter.format(vpcIdentifier ?? CommonVpcIdentifier);
         return aws_ec2_1.Vpc.fromLookup(scope, `${id}`, {
             vpcName: scope.resourceNameFormatter.format(vpcIdentifier ?? CommonVpcIdentifier),
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "9.11.0",
+  "version": "9.13.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {

package/src/lib/aws/common/index.ts

@@ -1,3 +1,4 @@
 export * from './construct'
+export * from './resource-name-formatter'
 export * from './stack'
 export * from './types'

package/src/lib/aws/common/resource-name-formatter.ts

@@ -17,9 +17,11 @@ export class ResourceNameFormatter extends Construct {
    */
   public format(resourceName: string, options?: ResourceNameFormatterProps) {
     const resourceNameElements = []
+    resourceNameElements.push(options?.globalPrefix ? this.props.globalPrefix : undefined)
     resourceNameElements.push(options?.prefix ?? this.props.resourcePrefix)
     resourceNameElements.push(resourceName)
     resourceNameElements.push(options?.suffix ?? this.props.resourceSuffix)
+    resourceNameElements.push(options?.globalSuffix ? this.props.globalSuffix : undefined)
     resourceNameElements.push(this.props.stage)
     return resourceNameElements.filter(resourceNameElement => resourceNameElement != undefined).join('-')
   }

package/src/lib/aws/common/stack.ts

@@ -58,6 +58,8 @@ export class CommonStack extends Stack {
       name: props.stackName || 'cdk-utils',
       nodejsRuntime: this.node.tryGetContext('nodejsRuntime') ?? CommonStack.NODEJS_RUNTIME,
       region: this.node.tryGetContext('region'),
+      globalPrefix: this.node.tryGetContext('globalPrefix'),
+      globalSuffix: this.node.tryGetContext('globalSuffix'),
       resourcePrefix: this.node.tryGetContext('resourcePrefix'),
       resourceSuffix: this.node.tryGetContext('resourceSuffix'),
       skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),

package/src/lib/aws/common/types.ts

@@ -8,6 +8,8 @@ import { BaseProps } from '../../common'
 export interface CommonStackProps extends BaseProps, StackProps {
   region: string
   resourceProjectIdentifier?: string
+  globalPrefix?: string
+  globalSuffix?: string
   resourcePrefix?: string
   resourceSuffix?: string
   logRetention?: RetentionDays
@@ -19,6 +21,8 @@ export interface CommonStackProps extends BaseProps, StackProps {
 }
 
 export interface ResourceNameFormatterProps {
+  globalPrefix?: boolean
+  globalSuffix?: boolean
   prefix?: string
   suffix?: string
 }

package/src/lib/aws/construct/rest-api-lambda-with-cache/main.ts

@@ -57,7 +57,12 @@ export abstract class RestApiLambdaWithCache extends RestApiLambda {
     if (this.props.useExistingVpc) {
       this.restApivpc = this.vpcManager.retrieveCommonVpc(`${this.id}-vpc`, this, this.props.vpcName)
     } else {
-      this.restApivpc = this.vpcManager.createCommonVpc(this, this.props.restApiVpc, this.props.restApiVpc.vpcName)
+      this.restApivpc = this.vpcManager.createCommonVpc(
+        `${this.id}-vpc`,
+        this,
+        this.props.restApiVpc,
+        this.props.restApiVpc.vpcName
+      )
     }
   }
 

package/src/lib/aws/construct/site-with-ecs-backend/main.ts

@@ -213,9 +213,14 @@ export class SiteWithEcsBackend extends CommonConstruct {
    */
   protected createVpc() {
     if (this.props.useExistingVpc) {
-      this.siteVpc = this.vpcManager.retrieveCommonVpc(`${this.id}`, this, this.props.siteVpc.vpcName)
+      this.siteVpc = this.vpcManager.retrieveCommonVpc(`${this.id}-vpc`, this, this.props.siteVpc.vpcName)
     } else {
-      this.siteVpc = this.vpcManager.createCommonVpc(this, this.props.siteVpc, this.props.siteVpc.vpcName)
+      this.siteVpc = this.vpcManager.createCommonVpc(
+        `${this.id}-vpc`,
+        this,
+        this.props.siteVpc,
+        this.props.siteVpc.vpcName
+      )
     }
   }
 

package/src/lib/aws/services/dynamodb/main.ts

@@ -30,10 +30,11 @@ export class DynamodbManager {
    */
   public createTable(id: string, scope: CommonConstruct, props: TableProps) {
     if (!props) throw `Table props undefined for ${id}`
+    if (!props.tableName) throw `Table tableName undefined for ${id}`
 
     const table = new Table(scope, `${id}`, {
       ...props,
-      tableName: `${props.tableName}-${scope.props.stage}`,
+      tableName: scope.resourceNameFormatter.format(props.tableName, props.resourceNameOptions),
     })
 
     if (props.tags && !_.isEmpty(props.tags)) {
@@ -63,6 +64,12 @@ export class DynamodbManager {
       tableName: scope.resourceNameFormatter.format(props.tableName, props.resourceNameOptions),
     })
 
+    if (props.tags && !_.isEmpty(props.tags)) {
+      _.forEach(props.tags, tag => {
+        Tags.of(table).add(tag.key, tag.value)
+      })
+    }
+
     createCfnOutput(`${id}-tableName`, scope, table.tableName)
     createCfnOutput(`${id}-tableArn`, scope, table.tableArn)
 

package/src/lib/aws/services/dynamodb/types.ts

@@ -5,9 +5,11 @@ import { TagProps } from '../../types'
 /**
  */
 export interface TableProps extends dynamodb.TableProps {
+  resourceNameOptions?: ResourceNameFormatterProps
   tags?: TagProps[]
 }
 
 export interface TablePropsV2 extends dynamodb.TablePropsV2 {
   resourceNameOptions?: ResourceNameFormatterProps
+  tags?: TagProps[]
 }

package/src/lib/aws/services/key-management-service/main.ts

@@ -28,10 +28,11 @@ export class KmsManager {
    */
   public createKey(id: string, scope: CommonConstruct, props: KmsKeyProps) {
     if (!props) throw `KMS Key props undefined for ${id}`
+    if (!props.alias) throw `KMS Key alias undefined for ${id}`
 
     const key = new Key(scope, `${id}`, {
       ...props,
-      alias: `${props.alias}-${scope.props.stage}`,
+      alias: scope.resourceNameFormatter.format(props.alias, props.resourceNameOptions),
     })
 
     createCfnOutput(`${id}-keyId`, scope, key.keyId)

package/src/lib/aws/services/key-management-service/types.ts

@@ -1,5 +1,8 @@
 import { KeyProps } from 'aws-cdk-lib/aws-kms'
+import { ResourceNameFormatterProps } from '../../common'
 
 /**
  */
-export interface KmsKeyProps extends KeyProps {}
+export interface KmsKeyProps extends KeyProps {
+  resourceNameOptions?: ResourceNameFormatterProps
+}

package/src/lib/aws/services/simple-storage-service/main.ts

@@ -99,8 +99,11 @@ export class S3Manager {
     } else {
       let logBucket
       if (props.logBucketName) {
-        const logBucketName = S3Manager.determineBucketName(scope, props, props.logBucketName)
-        logBucket = Bucket.fromBucketName(scope, `${id}-logs`, props.logBucketName)
+        logBucket = Bucket.fromBucketName(
+          scope,
+          `${id}-logs`,
+          S3Manager.determineBucketName(scope, props, props.logBucketName)
+        )
       }
 
       bucket = new Bucket(scope, `${id}-bucket`, {

package/src/lib/aws/services/systems-manager/main.ts

@@ -1,4 +1,4 @@
-import { StringParameter, StringParameterProps } from 'aws-cdk-lib/aws-ssm'
+import { StringParameter } from 'aws-cdk-lib/aws-ssm'
 import {
   AwsCustomResource,
   AwsCustomResourcePolicy,
@@ -7,7 +7,7 @@ import {
 } from 'aws-cdk-lib/custom-resources'
 import { CommonConstruct } from '../../common'
 import { createCfnOutput } from '../../utils'
-import { SSMParameterReaderProps } from './types'
+import { SSMParameterReaderProps, SSMStringParameterProps } from './types'
 
 /**
  * @classdesc Provides operations on AWS Systems Manager.
@@ -34,13 +34,14 @@ export class SsmManager {
    * @param scope scope in which this resource is defined
    * @param props parameter props
    */
-  public writeStringToParameters(id: string, scope: CommonConstruct, props: StringParameterProps) {
+  public writeStringToParameters(id: string, scope: CommonConstruct, props: SSMStringParameterProps) {
     if (!props) throw `Parameter props undefined for ${id}`
+    if (!props.parameterName) throw `Parameter parameterName undefined for ${id}`
 
     const parameter = new StringParameter(scope, `${id}`, {
       ...props,
       description: `${props.description} - ${scope.props.stage} stage`,
-      parameterName: `${props.parameterName}-${scope.props.stage}`,
+      parameterName: scope.resourceNameFormatter.format(props.parameterName, props.resourceNameOptions),
     })
 
     createCfnOutput(`${id}-parameterArn`, scope, parameter.parameterArn)

package/src/lib/aws/services/systems-manager/types.ts

@@ -1,6 +1,13 @@
+import { StringParameterProps } from 'aws-cdk-lib/aws-ssm'
+import { ResourceNameFormatterProps } from '../../common'
+
 /**
  */
 export interface SSMParameterReaderProps {
   parameterName: string
   region: string
 }
+
+export interface SSMStringParameterProps extends StringParameterProps {
+  resourceNameOptions?: ResourceNameFormatterProps
+}

package/src/lib/aws/services/virtual-private-cloud/main.ts

@@ -49,7 +49,10 @@ export class VpcManager {
         vpcName,
       })
     } else {
-      vpc = new Vpc(scope, `${id}`, props)
+      vpc = new Vpc(scope, `${id}`, {
+        ...props,
+        vpcName,
+      })
     }
 
     createCfnOutput(`${id}Id`, scope, vpc.vpcId)
@@ -73,13 +76,17 @@ export class VpcManager {
 
   /**
    * @summary Method to create a common vpc
+   * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
    * @param props
    * @param vpcIdentifier optional identifier for VPC
    */
-  public createCommonVpc(scope: CommonConstruct, props: VpcProps, vpcIdentifier?: string) {
-    const vpc = this.createVpc(CommonVpcIdentifier, scope, props)
-    Tags.of(vpc).add('Name', vpcIdentifier ?? CommonVpcIdentifier)
+  public createCommonVpc(id: string, scope: CommonConstruct, props: VpcProps, vpcIdentifier?: string) {
+    const vpc = this.createVpc(id, scope, props)
+    Tags.of(vpc).add(
+      'Name',
+      scope.resourceNameFormatter.format(vpcIdentifier ?? CommonVpcIdentifier, props.resourceNameOptions)
+    )
 
     return vpc
   }
@@ -91,7 +98,6 @@ export class VpcManager {
    * @param vpcIdentifier optional identifier for VPC
    */
   public retrieveCommonVpc(id: string, scope: CommonConstruct, vpcIdentifier?: string) {
-    const vpcName = scope.resourceNameFormatter.format(vpcIdentifier ?? CommonVpcIdentifier)
     return Vpc.fromLookup(scope, `${id}`, {
       vpcName: scope.resourceNameFormatter.format(vpcIdentifier ?? CommonVpcIdentifier),
     })