@gradientedge/cdk-utils 8.89.0 → 8.90.0

package/src/lib/{manager/aws/sfn-manager.ts → services/aws/step-function/main.ts}

@@ -7,11 +7,26 @@ import * as logs from 'aws-cdk-lib/aws-logs'
 import * as sqs from 'aws-cdk-lib/aws-sqs'
 import * as sfn from 'aws-cdk-lib/aws-stepfunctions'
 import * as tasks from 'aws-cdk-lib/aws-stepfunctions-tasks'
-import * as common from '../../common'
-import * as types from '../../types'
-import * as utils from '../../utils'
-import { SfnMapProps } from '../../types'
+import * as utils from '../../../utils'
 import { v4 as uuidv4 } from 'uuid'
+import { CommonConstruct } from '../../../common'
+import {
+  SfnCallApiGatewayRestApiEndpointProps,
+  SfnChoiceProps,
+  SfnDynamoDeleteItemProps,
+  SfnDynamoGetItemProps,
+  SfnDynamoPutItemProps,
+  SfnFailProps,
+  SfnLambdaInvokeProps,
+  SfnMapProps,
+  SfnParallelProps,
+  SfnPassProps,
+  SfnSqsSendMessageProps,
+  SfnStartExecutionProps,
+  SfnStateMachineProps,
+  SfnSucceedProps,
+  SfnWaitProps,
+} from './types'
 
 const DEFAULT_RETRY_CONFIG = [
   {
@@ -27,12 +42,12 @@ const DEFAULT_RETRY_CONFIG = [
  * @category cdk-utils.step-functions-manager
  * @subcategory Construct
  * @classdesc Provides operations on AWS Step Functions Service.
- * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
- * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link CommonConstruct} constructor.
+ * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
- * import * as common from '@gradientedge/cdk-utils'
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.common.CommonConstruct {
+ * class CustomConstruct extends CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -46,10 +61,10 @@ export class SfnManager {
   /**
    * @summary Method to create a success step
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnSucceedProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnSucceedProps} props
    */
-  public createSuccessStep(id: string, scope: common.CommonConstruct, props: types.SfnSucceedProps) {
+  public createSuccessStep(id: string, scope: CommonConstruct, props: SfnSucceedProps) {
     if (!props) throw `Step props undefined for ${id}`
     return new sfn.Succeed(scope, `${props.name}`, {
       ...props,
@@ -62,10 +77,10 @@ export class SfnManager {
   /**
    * @summary Method to create a failure step
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnFailProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnFailProps} props
    */
-  public createFailStep(id: string, scope: common.CommonConstruct, props: types.SfnFailProps) {
+  public createFailStep(id: string, scope: CommonConstruct, props: SfnFailProps) {
     if (!props) throw `Step props undefined for ${id}`
     return new sfn.Fail(scope, `${props.name}`, {
       ...props,
@@ -78,10 +93,10 @@ export class SfnManager {
   /**
    * @summary Method to create a pass step
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnPassProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnPassProps} props
    */
-  public createPassStep(id: string, scope: common.CommonConstruct, props: types.SfnPassProps) {
+  public createPassStep(id: string, scope: CommonConstruct, props: SfnPassProps) {
     if (!props) throw `Step props undefined for ${id}`
     return new sfn.Pass(scope, `${props.name}`, {
       ...props,
@@ -94,10 +109,10 @@ export class SfnManager {
   /**
    * @summary Method to create a parallel step
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnParallelProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnParallelProps} props
    */
-  public createParallelStep(id: string, scope: common.CommonConstruct, props: types.SfnParallelProps) {
+  public createParallelStep(id: string, scope: CommonConstruct, props: SfnParallelProps) {
     if (!props) throw `Step props undefined for ${id}`
     const step = new sfn.Parallel(scope, `${props.name}`, {
       ...props,
@@ -124,10 +139,10 @@ export class SfnManager {
   /**
    * @summary Method to create a choice step
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnChoiceProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnChoiceProps} props
    */
-  public createChoiceStep(id: string, scope: common.CommonConstruct, props: types.SfnChoiceProps) {
+  public createChoiceStep(id: string, scope: CommonConstruct, props: SfnChoiceProps) {
     if (!props) throw `Step props undefined for ${id}`
     return new sfn.Choice(scope, `${props.name}`, {
       ...props,
@@ -140,10 +155,10 @@ export class SfnManager {
   /**
    * @summary Method to create a wait step
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnWaitProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnWaitProps} props
    */
-  public createWaitStep(id: string, scope: common.CommonConstruct, props: types.SfnWaitProps) {
+  public createWaitStep(id: string, scope: CommonConstruct, props: SfnWaitProps) {
     return new sfn.Wait(scope, `${props.name}`, {
       ...props,
       ...{
@@ -156,15 +171,15 @@ export class SfnManager {
   /**
    * @summary Method to create a DynamoDB get item step
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnDynamoGetItemProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnDynamoGetItemProps} props
    * @param {dynamodb.ITable} table The table to get the item from
    * @param tableKey The table key for query/scan
    */
   public createDynamoDbGetItemStep(
     id: string,
-    scope: common.CommonConstruct,
-    props: types.SfnDynamoGetItemProps,
+    scope: CommonConstruct,
+    props: SfnDynamoGetItemProps,
     table: dynamodb.ITable,
     tableKey: { [key: string]: tasks.DynamoAttributeValue }
   ) {
@@ -207,15 +222,15 @@ export class SfnManager {
   /**
    * @summary Method to create a DynamoDB put item step
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnDynamoPutItemProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnDynamoPutItemProps} props
    * @param {dynamodb.ITable} table The table to put the item in
    * @param tableItem The item to add to the table
    */
   public createDynamoDbPutItemStep(
     id: string,
-    scope: common.CommonConstruct,
-    props: types.SfnDynamoPutItemProps,
+    scope: CommonConstruct,
+    props: SfnDynamoPutItemProps,
     table: dynamodb.ITable,
     tableItem: { [key: string]: tasks.DynamoAttributeValue }
   ) {
@@ -260,15 +275,15 @@ export class SfnManager {
   /**
    * @summary Method to create a DynamoDB delete item step
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnDynamoDeleteItemProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnDynamoDeleteItemProps} props
    * @param {dynamodb.ITable} table The table to put the item in
    * @param tableKey The table key for query/scan
    */
   public createDynamoDbDeleteItemStep(
     id: string,
-    scope: common.CommonConstruct,
-    props: types.SfnDynamoDeleteItemProps,
+    scope: CommonConstruct,
+    props: SfnDynamoDeleteItemProps,
     table: dynamodb.ITable,
     tableKey: { [key: string]: tasks.DynamoAttributeValue }
   ) {
@@ -313,14 +328,14 @@ export class SfnManager {
   /**
    * @summary Method to send a message to SQS step
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnSqsSendMessageProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnSqsSendMessageProps} props
    * @param {sqs.IQueue} queue The queue to send the message to
    */
   public createSendSqsMessageStep(
     id: string,
-    scope: common.CommonConstruct,
-    props: types.SfnSqsSendMessageProps,
+    scope: CommonConstruct,
+    props: SfnSqsSendMessageProps,
     queue: sqs.IQueue
   ) {
     if (!props) throw `Step props undefined for ${id}`
@@ -362,14 +377,14 @@ export class SfnManager {
   /**
    * @summary Method to create a lambda invoke step
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnLambdaInvokeProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnLambdaInvokeProps} props
    * @param {lambda.IFunction} lambdaFunction
    */
   public createLambdaStep(
     id: string,
-    scope: common.CommonConstruct,
-    props: types.SfnLambdaInvokeProps,
+    scope: CommonConstruct,
+    props: SfnLambdaInvokeProps,
     lambdaFunction: lambda.IFunction
   ) {
     if (!props) throw `Step props undefined for ${id}`
@@ -399,14 +414,14 @@ export class SfnManager {
   /**
    * @summary Method to create a API Gateway invoke step
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnLambdaInvokeProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnLambdaInvokeProps} props
    * @param {apig.IRestApi} api
    */
   public createApiStep(
     id: string,
-    scope: common.CommonConstruct,
-    props: types.SfnCallApiGatewayRestApiEndpointProps,
+    scope: CommonConstruct,
+    props: SfnCallApiGatewayRestApiEndpointProps,
     api: apig.IRestApi
   ) {
     if (!props) throw `Step props undefined for ${id}`
@@ -437,14 +452,14 @@ export class SfnManager {
   /**
    * @summary Method to create a step function execution step
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnStartExecutionProps} props props for the step
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnStartExecutionProps} props props for the step
    * @param {sfn.IStateMachine} stateMachine the state machine to execute
    */
   public createSfnExecutionStep(
     id: string,
-    scope: common.CommonConstruct,
-    props: types.SfnStartExecutionProps,
+    scope: CommonConstruct,
+    props: SfnStartExecutionProps,
     stateMachine: sfn.IStateMachine
   ) {
     const step = new tasks.StepFunctionsStartExecution(scope, `${id}`, {
@@ -473,26 +488,26 @@ export class SfnManager {
   /**
    * @summary Method to create a step function map state
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnMapProps} props props for the map state
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnMapProps} props props for the map state
    */
-  public createMapState(id: string, scope: common.CommonConstruct, props: types.SfnMapProps) {
+  public createMapState(id: string, scope: CommonConstruct, props: SfnMapProps) {
     return new sfn.Map(scope, `${id}`, props)
   }
 
   /**
    * @summary Method to create a state machine
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.SfnStateMachineProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {SfnStateMachineProps} props
    * @param {sfn.IChainable} definition
    * @param {logs.ILogGroup} logGroup
    * @param {iam.IRole} role
    */
   public createStateMachine(
     id: string,
-    scope: common.CommonConstruct,
-    props: types.SfnStateMachineProps,
+    scope: CommonConstruct,
+    props: SfnStateMachineProps,
     definition: sfn.IChainable,
     logGroup: logs.ILogGroup,
     role?: iam.IRole

package/src/lib/services/aws/step-function/types.ts

@@ -0,0 +1,152 @@
+import {
+  ChoiceProps,
+  FailProps,
+  MapProps,
+  ParallelProps,
+  PassProps,
+  RetryProps,
+  StateMachineProps,
+  SucceedProps,
+  WaitProps,
+} from 'aws-cdk-lib/aws-stepfunctions'
+import {
+  CallApiGatewayRestApiEndpointProps,
+  DynamoDeleteItemProps,
+  DynamoGetItemProps,
+  DynamoPutItemProps,
+  LambdaInvokeProps,
+  SqsSendMessageProps,
+  StepFunctionsStartExecutionProps,
+} from 'aws-cdk-lib/aws-stepfunctions-tasks'
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnSucceedProps extends SucceedProps {
+  name: string
+}
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnRetryProps extends RetryProps {
+  intervalInSecs: number
+}
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnFailProps extends FailProps {
+  name: string
+}
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnPassProps extends PassProps {
+  name: string
+}
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnDynamoGetItemProps extends DynamoGetItemProps {
+  name: string
+  retries?: SfnRetryProps[]
+}
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnDynamoPutItemProps extends DynamoPutItemProps {
+  name: string
+  retries?: SfnRetryProps[]
+}
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnDynamoDeleteItemProps extends DynamoDeleteItemProps {
+  name: string
+  retries?: SfnRetryProps[]
+}
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnSqsSendMessageProps extends SqsSendMessageProps {
+  name: string
+  retries?: SfnRetryProps[]
+}
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnParallelProps extends ParallelProps {
+  name: string
+  retries?: SfnRetryProps[]
+}
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnChoiceProps extends ChoiceProps {
+  name: string
+}
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnWaitProps extends WaitProps {
+  name: string
+  delayInSeconds: number
+}
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnLambdaInvokeProps extends LambdaInvokeProps {
+  name: string
+  retries?: SfnRetryProps[]
+}
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnCallApiGatewayRestApiEndpointProps extends CallApiGatewayRestApiEndpointProps {
+  name: string
+  retries?: SfnRetryProps[]
+}
+
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnStateMachineProps extends StateMachineProps {}
+
+/**
+ * @category cdk-utils.sfn-manager
+ * @subcategory Properties
+ */
+export interface SfnMapProps extends MapProps {}
+
+/**
+ * @category cdk-utils.sfn-manager
+ * @subcategory Properties
+ */
+export interface SfnStartExecutionProps extends StepFunctionsStartExecutionProps {
+  retries?: SfnRetryProps[]
+}

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

@@ -0,0 +1,2 @@
+export * from './main'
+export * from './types'

package/src/lib/{manager/aws/ssm-manager.ts → services/aws/systems-manager/main.ts}

@@ -1,20 +1,20 @@
 import * as ssm from 'aws-cdk-lib/aws-ssm'
 import * as cr from 'aws-cdk-lib/custom-resources'
-import * as common from '../../common'
-import * as types from '../../types'
-import * as utils from '../../utils'
+import * as utils from '../../../utils'
+import { CommonConstruct } from '../../../common'
+import { SSMParameterReaderProps } from './types'
 
 /**
  * @stability stable
  * @category cdk-utils.ssm-manager
  * @subcategory Construct
  * @classdesc Provides operations on AWS Systems Manager.
- * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
- * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link CommonConstruct} constructor.
+ * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
- * import { common.CommonConstruct } from '@gradientedge/cdk-utils'
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -26,13 +26,14 @@ import * as utils from '../../utils'
  */
 export class SsmManager {
   public static SECRETS_MODIFIED_TIMESTAMP_PARAM = 'secrets-last-modified-timestamp'
+
   /**
    * Method to write a string parameter to the parameters store
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {CommonConstruct} scope scope in which this resource is defined
    * @param {ssm.StringParameterProps} props parameter props
    */
-  public writeStringToParameters(id: string, scope: common.CommonConstruct, props: ssm.StringParameterProps) {
+  public writeStringToParameters(id: string, scope: CommonConstruct, props: ssm.StringParameterProps) {
     if (!props) throw `Parameter props undefined for ${id}`
 
     const parameter = new ssm.StringParameter(scope, `${id}`, {
@@ -50,10 +51,10 @@ export class SsmManager {
   /**
    * Method to read a string parameter from the parameters store
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {CommonConstruct} scope scope in which this resource is defined
    * @param {string} parameterName parameter name to lookup
    */
-  public readStringParameter(id: string, scope: common.CommonConstruct, parameterName: string) {
+  public readStringParameter(id: string, scope: CommonConstruct, parameterName: string) {
     if (!parameterName || parameterName == '') throw 'Invalid parameter name'
 
     return ssm.StringParameter.valueFromLookup(scope, parameterName)
@@ -62,16 +63,11 @@ export class SsmManager {
   /**
    * Method to read a string parameter from the parameters store in a given region
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {CommonConstruct} scope scope in which this resource is defined
    * @param {string} parameterName parameter name to lookup
    * @param {string} region region name to lookup parameter
    */
-  public readStringParameterFromRegion(
-    id: string,
-    scope: common.CommonConstruct,
-    parameterName: string,
-    region: string
-  ) {
+  public readStringParameterFromRegion(id: string, scope: CommonConstruct, parameterName: string, region: string) {
     if (!parameterName || parameterName == '') throw `Invalid parameter name for ${id}`
     if (!region || region == '') throw `Invalid region for ${id}`
 
@@ -88,7 +84,7 @@ export class SsmManager {
  * @classdesc Provides utilities to read same/cross region SSM parameters
  */
 export class SSMParameterReader extends cr.AwsCustomResource {
-  constructor(scope: common.CommonConstruct, name: string, props: types.SSMParameterReaderProps) {
+  constructor(scope: CommonConstruct, name: string, props: SSMParameterReaderProps) {
     const { parameterName, region } = props
 
     const ssmAwsSdkCall: cr.AwsSdkCall = {

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

@@ -0,0 +1,8 @@
+/**
+ * @category cdk-utils.ssm-manager
+ * @subcategory Properties
+ */
+export interface SSMParameterReaderProps {
+  parameterName: string
+  region: string
+}

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

@@ -0,0 +1 @@
+export * from './main'

package/src/lib/{manager/aws/vpc-manager.ts → services/aws/virtual-private-cloud/main.ts}

@@ -1,7 +1,7 @@
 import * as cdk from 'aws-cdk-lib'
 import * as ec2 from 'aws-cdk-lib/aws-ec2'
-import * as common from '../../common'
-import * as utils from '../../utils'
+import * as utils from '../../../utils'
+import { CommonConstruct } from '../../../common'
 
 /**
  * @stability stable
@@ -14,12 +14,12 @@ const CommonVpcIdentifier = 'CommonVpc'
  * @category cdk-utils.vpc-manager
  * @subcategory Construct
  * @classdesc Provides operations on AWS VPC.
- * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
- * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link CommonConstruct} constructor.
+ * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
- * import * as common from '@gradientedge/cdk-utils'
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.common.CommonConstruct {
+ * class CustomConstruct extends CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -33,10 +33,10 @@ export class VpcManager {
   /**
    * @summary Method to create a new vpc
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {CommonConstruct} scope scope in which this resource is defined
    * @param {ec2.VpcProps} props
    */
-  public createVpc(id: string, scope: common.CommonConstruct, props: ec2.VpcProps) {
+  public createVpc(id: string, scope: CommonConstruct, props: ec2.VpcProps) {
     if (!props) throw `Vpc props undefined for ${id}`
     const vpc = new ec2.Vpc(scope, `${id}`, {
       maxAzs: props.maxAzs,
@@ -64,11 +64,11 @@ export class VpcManager {
 
   /**
    * @summary Method to create a common vpc
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {CommonConstruct} scope scope in which this resource is defined
    * @param {ec2.VpcProps} props
    * @param {string?} vpcIdentifier optional identifier for VPC
    */
-  public createCommonVpc(scope: common.CommonConstruct, props: ec2.VpcProps, vpcIdentifier?: string) {
+  public createCommonVpc(scope: CommonConstruct, props: ec2.VpcProps, vpcIdentifier?: string) {
     const vpc = this.createVpc(CommonVpcIdentifier, scope, props)
     cdk.Tags.of(vpc).add('Name', vpcIdentifier ?? CommonVpcIdentifier)
 
@@ -78,10 +78,10 @@ export class VpcManager {
   /**
    * @summary Method to retrieve a common vpc
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {CommonConstruct} scope scope in which this resource is defined
    * @param {string?} vpcIdentifier optional identifier for VPC
    */
-  public retrieveCommonVpc(id: string, scope: common.CommonConstruct, vpcIdentifier?: string) {
+  public retrieveCommonVpc(id: string, scope: CommonConstruct, vpcIdentifier?: string) {
     return ec2.Vpc.fromLookup(scope, `${id}`, { vpcName: vpcIdentifier ?? CommonVpcIdentifier })
   }
 }

package/src/lib/services/aws/web-application-firewall/index.ts

@@ -0,0 +1 @@
+export * from './main'

package/src/lib/{manager/aws/waf-manager.ts → services/aws/web-application-firewall/main.ts}

@@ -1,19 +1,19 @@
 import * as wafv2 from 'aws-cdk-lib/aws-wafv2'
-import * as common from '../../common'
-import * as types from '../../types'
-import * as utils from '../../utils'
+import * as utils from '../../../utils'
+import { CommonConstruct } from '../../../common'
+import { WafIPSetProps, WafWebACLProps } from './types'
 
 /**
  * @stability stable
  * @category cdk-utils.waf-manager
  * @subcategory Construct
  * @classdesc Provides operations on AWS WAF.
- * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
- * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link CommonConstruct} constructor.
+ * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
- * import * as common from '@gradientedge/cdk-utils'
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.common.CommonConstruct {
+ * class CustomConstruct extends CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -27,10 +27,10 @@ export class WafManager {
   /**
    * @summary Method to create an ip set
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.WafIPSetProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {WafIPSetProps} props
    */
-  public createIpSet(id: string, scope: common.CommonConstruct, props: types.WafIPSetProps) {
+  public createIpSet(id: string, scope: CommonConstruct, props: WafIPSetProps) {
     if (!props) throw `WAF Ip Set props undefined for ${id}`
 
     const ipSet = new wafv2.CfnIPSet(scope, `${id}`, {
@@ -50,10 +50,10 @@ export class WafManager {
   /**
    * @summary Method to create a web acl
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.WafWebACLProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {WafWebACLProps} props
    */
-  public createWebAcl(id: string, scope: common.CommonConstruct, props: types.WafWebACLProps) {
+  public createWebAcl(id: string, scope: CommonConstruct, props: WafWebACLProps) {
     if (!props) throw `WAF WebACL props undefined for ${id}`
 
     const webAcl = new wafv2.CfnWebACL(scope, `${id}`, {