@gradientedge/cdk-utils 4.2.0 → 4.3.0

package/src/lib/manager/{lambdaManager.ts → aws/lambdaManager.ts}

@@ -1,24 +1,24 @@
+import * as pylambda from '@aws-cdk/aws-lambda-python-alpha'
 import * as cdk from 'aws-cdk-lib'
 import * as ec2 from 'aws-cdk-lib/aws-ec2'
 import * as efs from 'aws-cdk-lib/aws-efs'
 import * as iam from 'aws-cdk-lib/aws-iam'
 import * as lambda from 'aws-cdk-lib/aws-lambda'
-import * as pylambda from '@aws-cdk/aws-lambda-python-alpha'
-import { CommonConstruct } from '../common/commonConstruct'
-import { LambdaEdgeProps, LambdaProps } from '../types'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 import { CloudFrontManager } from './cloudFrontManager'
 
 /**
  * @stability stable
  * @category Compute
  * @summary Provides operations on AWS Lambda.
- * - 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.
+ * - 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.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -32,10 +32,10 @@ export class LambdaManager {
   /**
    * @summary Method to create a lambda layer (nodejs)
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {lambda.AssetCode} code
    */
-  public createLambdaLayer(id: string, scope: CommonConstruct, code: lambda.AssetCode) {
+  public createLambdaLayer(id: string, scope: common.CommonConstruct, code: lambda.AssetCode) {
     const lambdaLayer = new lambda.LayerVersion(scope, `${id}`, {
       compatibleRuntimes: [lambda.Runtime.NODEJS_14_X],
       code: code,
@@ -43,7 +43,7 @@ export class LambdaManager {
       layerVersionName: `${id}-${scope.props.stage}`,
     })
 
-    createCfnOutput(`${id}-lambdaLayerArn`, scope, lambdaLayer.layerVersionArn)
+    utils.createCfnOutput(`${id}-lambdaLayerArn`, scope, lambdaLayer.layerVersionArn)
 
     return lambdaLayer
   }
@@ -51,10 +51,10 @@ export class LambdaManager {
   /**
    * @summary Method to create a lambda layer (python)
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {string} entry path to layer source
    */
-  public createPythonLambdaLayer(id: string, scope: CommonConstruct, entry: string) {
+  public createPythonLambdaLayer(id: string, scope: common.CommonConstruct, entry: string) {
     const lambdaLayer = new pylambda.PythonLayerVersion(scope, `${id}`, {
       compatibleRuntimes: [lambda.Runtime.PYTHON_3_8],
       description: `${id}`,
@@ -62,7 +62,7 @@ export class LambdaManager {
       layerVersionName: `${id}-${scope.props.stage}`,
     })
 
-    createCfnOutput(`${id}-lambdaLayerArn`, scope, lambdaLayer.layerVersionArn)
+    utils.createCfnOutput(`${id}-lambdaLayerArn`, scope, lambdaLayer.layerVersionArn)
 
     return lambdaLayer
   }
@@ -70,8 +70,8 @@ export class LambdaManager {
   /**
    * @summary Method to create a lambda function (nodejs)
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LambdaProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LambdaProps} props
    * @param {iam.Role | iam.CfnRole} role
    * @param {lambda.ILayerVersion[]} layers
    * @param {lambda.AssetCode} code
@@ -84,8 +84,8 @@ export class LambdaManager {
    */
   public createLambdaFunction(
     id: string,
-    scope: CommonConstruct,
-    props: LambdaProps,
+    scope: common.CommonConstruct,
+    props: types.LambdaProps,
     role: iam.Role | iam.CfnRole,
     layers: lambda.ILayerVersion[],
     code: lambda.AssetCode,
@@ -120,8 +120,8 @@ export class LambdaManager {
       vpc: vpc,
     })
 
-    createCfnOutput(`${id}-lambdaArn`, scope, lambdaFunction.functionArn)
-    createCfnOutput(`${id}-lambdaName`, scope, lambdaFunction.functionName)
+    utils.createCfnOutput(`${id}-lambdaArn`, scope, lambdaFunction.functionArn)
+    utils.createCfnOutput(`${id}-lambdaName`, scope, lambdaFunction.functionName)
 
     return lambdaFunction
   }
@@ -129,8 +129,8 @@ export class LambdaManager {
   /**
    * @summary Method to create a lambda function (python)
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LambdaProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LambdaProps} props
    * @param {iam.Role | iam.CfnRole} role
    * @param {lambda.ILayerVersion[]} layers
    * @param {string} entry path to lambda source
@@ -145,8 +145,8 @@ export class LambdaManager {
 
   public createPythonLambdaFunction(
     id: string,
-    scope: CommonConstruct,
-    props: LambdaProps,
+    scope: common.CommonConstruct,
+    props: types.LambdaProps,
     role: iam.Role | iam.CfnRole,
     layers: lambda.ILayerVersion[],
     entry: string,
@@ -183,8 +183,8 @@ export class LambdaManager {
       vpc: vpc,
     })
 
-    createCfnOutput(`${id}-lambdaArn`, scope, lambdaFunction.functionArn)
-    createCfnOutput(`${id}-lambdaName`, scope, lambdaFunction.functionName)
+    utils.createCfnOutput(`${id}-lambdaArn`, scope, lambdaFunction.functionArn)
+    utils.createCfnOutput(`${id}-lambdaName`, scope, lambdaFunction.functionName)
 
     return lambdaFunction
   }
@@ -193,8 +193,8 @@ export class LambdaManager {
    * @summary Method to provision a Lambda@Edge function
    *
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LambdaEdgeProps} props lambda@edge properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LambdaEdgeProps} props lambda@edge properties
    * @param {lambda.ILayerVersion[]} layers
    * @param {lambda.AssetCode} code
    * @param {Map<string, string>} environment
@@ -205,8 +205,8 @@ export class LambdaManager {
    */
   public createEdgeFunction(
     id: string,
-    scope: CommonConstruct,
-    props: LambdaEdgeProps,
+    scope: common.CommonConstruct,
+    props: types.LambdaEdgeProps,
     layers: lambda.ILayerVersion[],
     code: lambda.AssetCode,
     environment?: any,

package/src/lib/manager/{logManager.ts → aws/logManager.ts}

@@ -1,19 +1,19 @@
 import * as cdk from 'aws-cdk-lib'
 import * as logs from 'aws-cdk-lib/aws-logs'
-import { CommonConstruct } from '../common/commonConstruct'
-import { LogProps, MetricFilterProps } from '../types'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Management & Governance
  * @summary Provides operations on AWS CloudWatch.
- * - 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.
+ * - 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.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -27,11 +27,16 @@ export class LogManager {
   /**
    * @summary Method to create a cloudwatch metric filter
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {MetricFilterProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.MetricFilterProps} props
    * @param {logs.ILogGroup} logGroup
    */
-  public createMetricFilter(id: string, scope: CommonConstruct, props: MetricFilterProps, logGroup: logs.ILogGroup) {
+  public createMetricFilter(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.MetricFilterProps,
+    logGroup: logs.ILogGroup
+  ) {
     if (!props) throw `MetricFilter props undefined`
 
     const metricFilter = new logs.MetricFilter(scope, `${id}`, {
@@ -57,10 +62,10 @@ export class LogManager {
   /**
    * @summary Method to create a cloudwatch log group (cfn)
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LogProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LogProps} props
    */
-  public createCfnLogGroup(id: string, scope: CommonConstruct, props: LogProps) {
+  public createCfnLogGroup(id: string, scope: common.CommonConstruct, props: types.LogProps) {
     if (!props) throw `Logs props undefined`
 
     const logGroup = new logs.CfnLogGroup(scope, `${id}`, {
@@ -68,7 +73,7 @@ export class LogManager {
       retentionInDays: props.retention,
     })
 
-    createCfnOutput(`${id}-logGroupArn`, scope, logGroup.attrArn)
+    utils.createCfnOutput(`${id}-logGroupArn`, scope, logGroup.attrArn)
 
     return logGroup
   }
@@ -76,10 +81,10 @@ export class LogManager {
   /**
    * @summary Method to create a cloudwatch log group
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LogProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LogProps} props
    */
-  public createLogGroup(id: string, scope: CommonConstruct, props: LogProps) {
+  public createLogGroup(id: string, scope: common.CommonConstruct, props: types.LogProps) {
     if (!props) throw `Logs props undefined`
 
     const logGroup = new logs.LogGroup(scope, `${id}`, {
@@ -88,7 +93,7 @@ export class LogManager {
       removalPolicy: props.removalPolicy ?? cdk.RemovalPolicy.DESTROY,
     })
 
-    createCfnOutput(`${id}-logGroupArn`, scope, logGroup.logGroupArn)
+    utils.createCfnOutput(`${id}-logGroupArn`, scope, logGroup.logGroupArn)
 
     return logGroup
   }

package/src/lib/manager/{route53Manager.ts → aws/route53Manager.ts}

@@ -2,20 +2,20 @@ import * as apig from 'aws-cdk-lib/aws-apigateway'
 import * as cloudfront from 'aws-cdk-lib/aws-cloudfront'
 import * as route53 from 'aws-cdk-lib/aws-route53'
 import * as route53Targets from 'aws-cdk-lib/aws-route53-targets'
-import { Route53Props } from '../types'
-import { CommonConstruct } from '../common/commonConstruct'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Networking & Content Delivery
  * @summary Provides operations on AWS Route53.
- * - 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.
+ * - 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.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -29,10 +29,10 @@ export class Route53Manager {
   /**
    * @summary Method to create a hosted zone
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {Route53Props} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.Route53Props} props
    */
-  public createHostedZone(id: string, scope: CommonConstruct, props: Route53Props) {
+  public createHostedZone(id: string, scope: common.CommonConstruct, props: types.Route53Props) {
     let hostedZone: route53.IHostedZone
 
     if (!props) throw `Route53 props undefined`
@@ -48,8 +48,8 @@ export class Route53Manager {
       })
     }
 
-    createCfnOutput(`${id}-hostedZoneId`, scope, hostedZone.hostedZoneId)
-    createCfnOutput(`${id}-hostedZoneArn`, scope, hostedZone.hostedZoneArn)
+    utils.createCfnOutput(`${id}-hostedZoneId`, scope, hostedZone.hostedZoneId)
+    utils.createCfnOutput(`${id}-hostedZoneArn`, scope, hostedZone.hostedZoneArn)
 
     return hostedZone
   }
@@ -57,12 +57,12 @@ export class Route53Manager {
   /**
    * @summary Method to create/lookup a hosted zone
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param useExistingHostedZone Flag to indicate whether to lookup vs create new hosted zone
    */
   public withHostedZoneFromFullyQualifiedDomainName(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     useExistingHostedZone: boolean
   ) {
     let hostedZone: route53.IHostedZone
@@ -78,8 +78,8 @@ export class Route53Manager {
       })
     }
 
-    createCfnOutput(`${id}-hostedZoneId`, scope, hostedZone.hostedZoneId)
-    createCfnOutput(`${id}-hostedZoneArn`, scope, hostedZone.hostedZoneArn)
+    utils.createCfnOutput(`${id}-hostedZoneId`, scope, hostedZone.hostedZoneId)
+    utils.createCfnOutput(`${id}-hostedZoneArn`, scope, hostedZone.hostedZoneArn)
 
     return hostedZone
   }
@@ -87,14 +87,14 @@ export class Route53Manager {
   /**
    * @summary Method to create a-record for cloudfront target
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {cloudfront.IDistribution} distribution
    * @param {route53.IHostedZone} hostedZone
    * @param {string} recordName
    */
   public createCloudFrontTargetARecord(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     distribution?: cloudfront.IDistribution,
     hostedZone?: route53.IHostedZone,
     recordName?: string
@@ -108,7 +108,7 @@ export class Route53Manager {
       zone: hostedZone,
     })
 
-    createCfnOutput(`${id}-aRecordDomainName`, scope, aRecord.domainName)
+    utils.createCfnOutput(`${id}-aRecordDomainName`, scope, aRecord.domainName)
 
     return aRecord
   }
@@ -116,14 +116,14 @@ export class Route53Manager {
   /**
    * @summary Method to create a-record for cloudfront target
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {cloudfront.IDistribution} distribution
    * @param {route53.IHostedZone} hostedZone
    * @param {string} recordName
    */
   public createCloudFrontTargetARecordV2(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     distribution?: cloudfront.IDistribution,
     hostedZone?: route53.IHostedZone,
     recordName?: string
@@ -137,7 +137,7 @@ export class Route53Manager {
       zone: hostedZone,
     })
 
-    createCfnOutput(`${id}-aRecordDomainName`, scope, aRecord.domainName)
+    utils.createCfnOutput(`${id}-aRecordDomainName`, scope, aRecord.domainName)
 
     return aRecord
   }
@@ -145,14 +145,14 @@ export class Route53Manager {
   /**
    * @summary Method to create a-record for api gateway target
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param recordName
    * @param apiDomain
    * @param hostedZone
    */
   public createApiGatewayARecord(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     recordName: string,
     apiDomain: apig.DomainName,
     hostedZone: route53.IHostedZone
@@ -167,7 +167,7 @@ export class Route53Manager {
       zone: hostedZone,
     })
 
-    createCfnOutput(`${id}-a-record-domain-name`, scope, apiARecord.domainName)
+    utils.createCfnOutput(`${id}-a-record-domain-name`, scope, apiARecord.domainName)
 
     return apiARecord
   }

package/src/lib/manager/{s3Manager.ts → aws/s3Manager.ts}

@@ -3,20 +3,20 @@ import * as cloudfront from 'aws-cdk-lib/aws-cloudfront'
 import * as iam from 'aws-cdk-lib/aws-iam'
 import * as s3 from 'aws-cdk-lib/aws-s3'
 import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment'
-import { CommonConstruct } from '../common/commonConstruct'
-import { LifecycleRule, S3BucketProps } from '../types'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Storage
  * @summary Provides operations on AWS S3.
- * - 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.
+ * - 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.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -29,13 +29,13 @@ import { createCfnOutput } from '../utils'
 export class S3Manager {
   /**
    * @summary Method to determine S3 Bucket lifecycle properties
-   * @param {S3BucketProps} props bucket properties
+   * @param {types.S3BucketProps} props bucket properties
    * @private
    */
-  protected determineBucketLifecycleRules(props: S3BucketProps) {
+  protected determineBucketLifecycleRules(props: types.S3BucketProps) {
     if (!props.lifecycleRules) return undefined
 
-    const bucketLifecycleRules: LifecycleRule[] = []
+    const bucketLifecycleRules: types.LifecycleRule[] = []
     props.lifecycleRules.forEach(lifecycleRule => {
       bucketLifecycleRules.push({
         id: lifecycleRule.id,
@@ -59,11 +59,11 @@ export class S3Manager {
 
   /**
    * @summary Method to determine the bucket name
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {S3BucketProps} props bucket properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.S3BucketProps} props bucket properties
    * @private
    */
-  protected static determineBucketName(scope: CommonConstruct, props: S3BucketProps) {
+  protected static determineBucketName(scope: common.CommonConstruct, props: types.S3BucketProps) {
     return scope.isProductionStage()
       ? `${props.bucketName}.${scope.fullyQualifiedDomainName}`
       : `${props.bucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`
@@ -71,11 +71,11 @@ export class S3Manager {
 
   /**
    * @summary Method to determine the log bucket name
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {S3BucketProps} props bucket properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.S3BucketProps} props bucket properties
    * @private
    */
-  protected static determineLogBucketName(scope: CommonConstruct, props: S3BucketProps) {
+  protected static determineLogBucketName(scope: common.CommonConstruct, props: types.S3BucketProps) {
     return scope.isProductionStage()
       ? `${props.logBucketName}.${scope.fullyQualifiedDomainName}`
       : `${props.logBucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`
@@ -84,10 +84,10 @@ export class S3Manager {
   /**
    * @summary Method to create a s3 bucket
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {S3BucketProps} props bucket properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.S3BucketProps} props bucket properties
    */
-  public createS3Bucket(id: string, scope: CommonConstruct, props: S3BucketProps) {
+  public createS3Bucket(id: string, scope: common.CommonConstruct, props: types.S3BucketProps) {
     if (!props) throw `S3 props undefined`
 
     let bucket: s3.IBucket
@@ -131,8 +131,8 @@ export class S3Manager {
       }
     }
 
-    createCfnOutput(`${id}-bucketName`, scope, bucket.bucketName)
-    createCfnOutput(`${id}-bucketArn`, scope, bucket.bucketArn)
+    utils.createCfnOutput(`${id}-bucketName`, scope, bucket.bucketName)
+    utils.createCfnOutput(`${id}-bucketArn`, scope, bucket.bucketArn)
 
     return bucket
   }
@@ -140,10 +140,10 @@ export class S3Manager {
   /**
    * @summary Method to create an iam bucket policy for cloudtrail
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {s3.IBucket} bucket
    */
-  public createBucketPolicyForCloudTrail(id: string, scope: CommonConstruct, bucket: s3.IBucket) {
+  public createBucketPolicyForCloudTrail(id: string, scope: common.CommonConstruct, bucket: s3.IBucket) {
     const bucketPolicyDocument = new iam.PolicyDocument({
       statements: [
         new iam.PolicyStatement({
@@ -172,7 +172,7 @@ export class S3Manager {
   /**
    * @summary Method to create a s3 bucket deployment
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {s3.IBucket} siteBucket
    * @param {cloudfront.IDistribution} distribution
    * @param {s3deploy.ISource[]} sources
@@ -181,7 +181,7 @@ export class S3Manager {
    */
   public doBucketDeployment(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     siteBucket: s3.IBucket,
     distribution: cloudfront.IDistribution,
     sources: s3deploy.ISource[],

package/src/lib/manager/{secretsManager.ts → aws/secretsManager.ts}

@@ -1,6 +1,6 @@
-import { CommonConstruct } from '../common/commonConstruct'
 import * as cdk from 'aws-cdk-lib'
 import * as secretsManager from 'aws-cdk-lib/aws-secretsmanager'
+import * as common from '../../common'
 
 const AWS = require('aws-sdk')
 const fs = require('fs')
@@ -9,12 +9,12 @@ const fs = require('fs')
  * @stability experimental
  * @category Security, Identity & Compliance
  * @summary Provides operations on AWS Secrets Manager.
- * - 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.
+ * - 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.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -100,7 +100,12 @@ export class SecretsManager {
    * @param stackName
    * @param exportName
    */
-  public retrieveSecretFromSecretsManager(id: string, scope: CommonConstruct, stackName: string, exportName: string) {
+  public retrieveSecretFromSecretsManager(
+    id: string,
+    scope: common.CommonConstruct,
+    stackName: string,
+    exportName: string
+  ) {
     return secretsManager.Secret.fromSecretNameV2(
       scope,
       `${id}`,

package/src/lib/manager/{snsManager.ts → aws/snsManager.ts}

@@ -1,20 +1,20 @@
 import * as lambda from 'aws-cdk-lib/aws-lambda'
 import * as sns from 'aws-cdk-lib/aws-sns'
 import * as subs from 'aws-cdk-lib/aws-sns-subscriptions'
-import { CommonConstruct } from '../common/commonConstruct'
-import { SubscriptionProps } from '../types'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Application Integration
  * @summary Provides operations on AWS Simple Notification Service.
- * - 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.
+ * - 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.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -28,14 +28,14 @@ export class SnsManager {
   /**
    * @summary Method to create an email notification service
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {SubscriptionProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.SubscriptionProps} props
    * @param {string[]} emails
    */
   public createEmailNotificationService(
     id: string,
-    scope: CommonConstruct,
-    props: SubscriptionProps,
+    scope: common.CommonConstruct,
+    props: types.SubscriptionProps,
     emails: string[]
   ) {
     if (!props) throw `Subscription props undefined`
@@ -50,8 +50,8 @@ export class SnsManager {
       emails.forEach((email: string) => topic.addSubscription(new subs.EmailSubscription(email)))
     }
 
-    createCfnOutput(`${id}-subscriptionArn`, scope, topic.topicArn)
-    createCfnOutput(`${id}-subscriptionName`, scope, topic.topicName)
+    utils.createCfnOutput(`${id}-subscriptionArn`, scope, topic.topicArn)
+    utils.createCfnOutput(`${id}-subscriptionName`, scope, topic.topicName)
 
     return topic
   }
@@ -59,14 +59,14 @@ export class SnsManager {
   /**
    * @summary Method to create a lambda notification service
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {SubscriptionProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.SubscriptionProps} props
    * @param {lambda.Function} lambdaFunction
    */
   public createLambdaNotificationService(
     id: string,
-    scope: CommonConstruct,
-    props: SubscriptionProps,
+    scope: common.CommonConstruct,
+    props: types.SubscriptionProps,
     lambdaFunction: lambda.Function
   ) {
     if (!props) throw `Subscription props undefined`
@@ -79,8 +79,8 @@ export class SnsManager {
 
     topic.addSubscription(new subs.LambdaSubscription(lambdaFunction))
 
-    createCfnOutput(`${id}-subscriptionArn`, scope, topic.topicArn)
-    createCfnOutput(`${id}-subscriptionName`, scope, topic.topicName)
+    utils.createCfnOutput(`${id}-subscriptionArn`, scope, topic.topicArn)
+    utils.createCfnOutput(`${id}-subscriptionName`, scope, topic.topicName)
 
     return topic
   }