@gradientedge/cdk-utils 4.1.0 → 4.2.1

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

@@ -1,26 +1,26 @@
+import * as cdk from 'aws-cdk-lib'
 import * as acm from 'aws-cdk-lib/aws-certificatemanager'
 import * as cloudfront from 'aws-cdk-lib/aws-cloudfront'
-import * as lambda from 'aws-cdk-lib/aws-lambda'
-import * as s3 from 'aws-cdk-lib/aws-s3'
-import { CommonConstruct } from '../common/commonConstruct'
-import { CloudFrontProps, DistributionProps, LambdaEdgeProps } from '../types'
-import { createCfnOutput } from '../utils'
-import * as cdk from 'aws-cdk-lib'
+import * as origins from 'aws-cdk-lib/aws-cloudfront-origins'
 import * as ec2 from 'aws-cdk-lib/aws-ec2'
 import * as efs from 'aws-cdk-lib/aws-efs'
-import * as origins from 'aws-cdk-lib/aws-cloudfront-origins'
+import * as lambda from 'aws-cdk-lib/aws-lambda'
+import * as s3 from 'aws-cdk-lib/aws-s3'
 import * as cr from 'aws-cdk-lib/custom-resources'
+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 CloudFront.
- * - 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,12 +32,13 @@ import * as cr from 'aws-cdk-lib/custom-resources'
  *       originAccessIdentity,
  *       certificate
  *     )
+ *   }
  * }
  *
- * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-cloudfront-readme.html}
+ * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront-readme.html}
  */
 export class CloudFrontManager {
-  public createOriginAccessIdentity(id: string, scope: CommonConstruct, accessBucket?: s3.IBucket) {
+  public createOriginAccessIdentity(id: string, scope: common.CommonConstruct, accessBucket?: s3.IBucket) {
     const oai = new cloudfront.OriginAccessIdentity(scope, `${id}`, {
       comment: `${id} - ${scope.props.stage} stage`,
     })
@@ -51,8 +52,8 @@ export class CloudFrontManager {
    *
    * @summary Method to create a cloudfront distribution
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {CloudFrontProps} props distribution properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.CloudFrontProps} props distribution properties
    * @param {s3.IBucket?} siteBucket
    * @param {s3.IBucket?} logBucket
    * @param {cloudfront.OriginAccessIdentity?} oai
@@ -61,8 +62,8 @@ export class CloudFrontManager {
    */
   public createCloudFrontDistribution(
     id: string,
-    scope: CommonConstruct,
-    props: CloudFrontProps,
+    scope: common.CommonConstruct,
+    props: types.CloudFrontProps,
     siteBucket?: s3.IBucket,
     logBucket?: s3.IBucket,
     oai?: cloudfront.OriginAccessIdentity,
@@ -103,8 +104,8 @@ export class CloudFrontManager {
       webACLId: props.webACLId,
     })
 
-    createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
-    createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
+    utils.createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
+    utils.createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
 
     return distribution
   }
@@ -112,25 +113,27 @@ export class CloudFrontManager {
   /**
    * Method to create a CloudFront distribution with S3 Origin
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {CloudFrontProps} props distribution properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.DistributionProps} props distribution properties
    * @param {origins.S3Origin} origin
    * @param {s3.IBucket} siteBucket
    * @param {s3.IBucket?} logBucket
    * @param {cloudfront.OriginAccessIdentity?} oai
    * @param {acm.ICertificate?} certificate
    * @param {string[]?} aliases
+   * @param {cloudfront.FunctionAssociation?} defaultFunctionAssociations
    */
   public createDistributionWithS3Origin(
     id: string,
-    scope: CommonConstruct,
-    props: DistributionProps,
+    scope: common.CommonConstruct,
+    props: types.DistributionProps,
     origin: origins.S3Origin,
     siteBucket: s3.IBucket,
     logBucket?: s3.IBucket,
     oai?: cloudfront.OriginAccessIdentity,
     certificate?: acm.ICertificate,
-    aliases?: string[]
+    aliases?: string[],
+    defaultFunctionAssociations?: cloudfront.FunctionAssociation[]
   ) {
     const distribution = new cloudfront.Distribution(scope, `${id}`, {
       certificate: certificate,
@@ -139,6 +142,7 @@ export class CloudFrontManager {
         cachePolicy: props.defaultBehavior ? props.defaultBehavior.cachePolicy : undefined,
         origin: origin,
         originRequestPolicy: props.defaultBehavior ? props.defaultBehavior.originRequestPolicy : undefined,
+        functionAssociations: defaultFunctionAssociations ?? undefined,
       },
       additionalBehaviors: props.additionalBehaviors,
       defaultRootObject: props.defaultRootObject,
@@ -157,8 +161,8 @@ export class CloudFrontManager {
       webAclId: props.webAclId,
     })
 
-    createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
-    createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
+    utils.createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
+    utils.createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
 
     return distribution
   }
@@ -166,21 +170,23 @@ export class CloudFrontManager {
   /**
    * Method to create a CloudFront distribution with HTTP Origin
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {CloudFrontProps} props distribution properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.DistributionProps} props distribution properties
    * @param {origins.S3Origin} origin
    * @param {string[]} domainNames
    * @param {s3.IBucket?} logBucket
    * @param {acm.ICertificate?} certificate
+   * @param {cloudfront.FunctionAssociation?} defaultFunctionAssociations
    */
   public createDistributionWithHttpOrigin(
     id: string,
-    scope: CommonConstruct,
-    props: DistributionProps,
+    scope: common.CommonConstruct,
+    props: types.DistributionProps,
     origin: origins.HttpOrigin,
     domainNames: string[],
     logBucket?: s3.IBucket,
-    certificate?: acm.ICertificate
+    certificate?: acm.ICertificate,
+    defaultFunctionAssociations?: cloudfront.FunctionAssociation[]
   ) {
     const distribution = new cloudfront.Distribution(scope, `${id}`, {
       certificate: certificate,
@@ -189,6 +195,7 @@ export class CloudFrontManager {
         cachePolicy: props.defaultBehavior ? props.defaultBehavior.cachePolicy : undefined,
         origin: origin,
         originRequestPolicy: props.defaultBehavior ? props.defaultBehavior.originRequestPolicy : undefined,
+        functionAssociations: defaultFunctionAssociations ?? undefined,
       },
       additionalBehaviors: props.additionalBehaviors,
       defaultRootObject: props.defaultRootObject,
@@ -207,8 +214,8 @@ export class CloudFrontManager {
       webAclId: props.webAclId,
     })
 
-    createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
-    createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
+    utils.createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
+    utils.createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
 
     return distribution
   }
@@ -217,8 +224,8 @@ export class CloudFrontManager {
    * @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
@@ -229,8 +236,8 @@ export class CloudFrontManager {
    */
   public createEdgeFunction(
     id: string,
-    scope: CommonConstruct,
-    props: LambdaEdgeProps,
+    scope: common.CommonConstruct,
+    props: types.LambdaEdgeProps,
     layers: lambda.ILayerVersion[],
     code: lambda.AssetCode,
     environment?: any,
@@ -260,9 +267,9 @@ export class CloudFrontManager {
       vpc: vpc,
     })
 
-    createCfnOutput(`${id}-edgeArn`, scope, edgeFunction.edgeArn)
-    createCfnOutput(`${id}-edgeFunctionArn`, scope, edgeFunction.functionArn)
-    createCfnOutput(`${id}-edgeFunctionName`, scope, edgeFunction.functionName)
+    utils.createCfnOutput(`${id}-edgeArn`, scope, edgeFunction.edgeArn)
+    utils.createCfnOutput(`${id}-edgeFunctionArn`, scope, edgeFunction.functionArn)
+    utils.createCfnOutput(`${id}-edgeFunctionName`, scope, edgeFunction.functionName)
 
     return edgeFunction
   }
@@ -277,7 +284,7 @@ export class CloudFrontManager {
    */
   public invalidateCache(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     dockerFilePath: string,
     distributionId: string,
     paths?: string
@@ -300,4 +307,26 @@ export class CloudFrontManager {
       policy: cr.AwsCustomResourcePolicy.fromSdkCalls({ resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE }),
     })
   }
+
+  /**
+   * @summary Method to provision a Cloudfront function
+   *
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.CloudfrontFunctionProps} props
+   */
+  public createCloudfrontFunction(id: string, scope: common.CommonConstruct, props: types.CloudfrontFunctionProps) {
+    const cloudfrontFunction = new cloudfront.Function(scope, `${id}`, {
+      code: cloudfront.FunctionCode.fromFile({
+        filePath: props.functionFilePath,
+      }),
+      comment: props.comment,
+      functionName: `${props.functionName}-${scope.props.stage}`,
+    })
+
+    utils.createCfnOutput(`${id}-functionArn`, scope, cloudfrontFunction.functionArn)
+    utils.createCfnOutput(`${id}-functionName`, scope, cloudfrontFunction.functionName)
+
+    return cloudfrontFunction
+  }
 }

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

@@ -1,20 +1,20 @@
 import * as cloudtrail from 'aws-cdk-lib/aws-cloudtrail'
 import * as logs from 'aws-cdk-lib/aws-logs'
 import * as s3 from 'aws-cdk-lib/aws-s3'
-import { CommonConstruct } from '../common/commonConstruct'
-import { CloudTrailProps } 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 CloudTrail.
- * - 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
@@ -26,16 +26,17 @@ import { createCfnOutput } from '../utils'
  *       logBucket,
  *       logBucketPolicy
  *     )
+ *   }
  * }
  *
- * @see [CDK CloudTrail Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-cloudtrail-readme.html}
+ * @see [CDK CloudTrail Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudtrail-readme.html}
  */
 export class CloudTrailManager {
   /**
    * @summary Method to create a cloud trail
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {CloudTrailProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.CloudTrailProps} props
    * @param {logs.CfnLogGroup} logGroup
    * @param {s3.IBucket} dataBucket
    * @param {s3.IBucket} logBucket
@@ -43,8 +44,8 @@ export class CloudTrailManager {
    */
   public createCloudTrail(
     id: string,
-    scope: CommonConstruct,
-    props: CloudTrailProps,
+    scope: common.CommonConstruct,
+    props: types.CloudTrailProps,
     logGroup: logs.CfnLogGroup,
     dataBucket: s3.IBucket,
     logBucket: s3.IBucket,
@@ -83,8 +84,8 @@ export class CloudTrailManager {
     cloudTrail.addDependsOn(logGroup)
     cloudTrail.addDependsOn(role)
 
-    createCfnOutput(`${id}-trailName`, scope, cloudTrail.trailName)
-    createCfnOutput(`${id}-trailArn`, scope, cloudTrail.attrArn)
+    utils.createCfnOutput(`${id}-trailName`, scope, cloudTrail.trailName)
+    utils.createCfnOutput(`${id}-trailArn`, scope, cloudTrail.attrArn)
 
     return { cloudTrailRole: role, cloudTrail }
   }

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

@@ -1,45 +1,48 @@
 import * as cdk from 'aws-cdk-lib'
 import * as watch from 'aws-cdk-lib/aws-cloudwatch'
 import { IMetric } from 'aws-cdk-lib/aws-cloudwatch'
-import {
-  AlarmProps,
-  AlarmStatusWidgetProps,
-  DashboardProps,
-  GraphWidgetProps,
-  LogQueryWidgetProps,
-  MetricProps,
-  NumericWidgetProps,
-  TextWidgetProps,
-} from '../types'
-import { CommonConstruct } from '../common/commonConstruct'
-import { CloudWatchWidgetType, createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
+
+/**
+ * @category Utils
+ */
+enum CloudWatchWidgetType {
+  Text = 'Text',
+  SingleValue = 'SingleValue',
+  Graph = 'Graph',
+  AlarmStatus = 'AlarmStatus',
+  LogQuery = 'LogQuery',
+}
 
 /**
  * @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
  *     this.cloudWatchManager.createAlarmForMetric('MyAlarm', this, metric)
+ *   }
  * }
  *
- * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-cloudwatch-readme.html}
+ * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch-readme.html}
  */
 export class CloudWatchManager {
   /**
    * @summary Method to create a cloudwatch alarm for a given expression
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {AlarmProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.AlarmProps} props
    */
-  public createAlarmForExpression(id: string, scope: CommonConstruct, props: AlarmProps) {
+  public createAlarmForExpression(id: string, scope: common.CommonConstruct, props: types.AlarmProps) {
     if (!props) throw `Alarm props undefined`
 
     if (!props.expression) throw `Could not find expression for Alarm props for id:${id}`
@@ -65,8 +68,8 @@ export class CloudWatchManager {
       datapointsToAlarm: props.datapointsToAlarm,
     })
 
-    createCfnOutput(`${id}-alarmArn`, scope, alarm.alarmArn)
-    createCfnOutput(`${id}-alarmName`, scope, alarm.alarmName)
+    utils.createCfnOutput(`${id}-alarmArn`, scope, alarm.alarmArn)
+    utils.createCfnOutput(`${id}-alarmName`, scope, alarm.alarmName)
 
     return alarm
   }
@@ -74,11 +77,16 @@ export class CloudWatchManager {
   /**
    * @summary Method to create a cloudwatch alarm for a given metric
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {AlarmProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.AlarmProps} props
    * @param metric
    */
-  public createAlarmForMetric(id: string, scope: CommonConstruct, props: AlarmProps, metric: watch.Metric) {
+  public createAlarmForMetric(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.AlarmProps,
+    metric: watch.Metric
+  ) {
     if (!props) throw `Alarm props undefined`
 
     const alarm = metric.createAlarm(scope, `${id}`, {
@@ -91,8 +99,8 @@ export class CloudWatchManager {
       datapointsToAlarm: props.datapointsToAlarm,
     })
 
-    createCfnOutput(`${id}-alarmArn`, scope, alarm.alarmArn)
-    createCfnOutput(`${id}-alarmName`, scope, alarm.alarmName)
+    utils.createCfnOutput(`${id}-alarmArn`, scope, alarm.alarmArn)
+    utils.createCfnOutput(`${id}-alarmName`, scope, alarm.alarmName)
 
     return alarm
   }
@@ -100,11 +108,16 @@ export class CloudWatchManager {
   /**
    * @summary Method to create a cloudwatch dashboard
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {DashboardProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.DashboardProps} props
    * @param widgets
    */
-  public createDashboard(id: string, scope: CommonConstruct, props: DashboardProps, widgets?: watch.IWidget[][]) {
+  public createDashboard(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.DashboardProps,
+    widgets?: watch.IWidget[][]
+  ) {
     if (!props) throw `Dashboard props undefined`
 
     const dashboard = new watch.Dashboard(scope, `${id}`, {
@@ -115,17 +128,17 @@ export class CloudWatchManager {
       widgets: widgets,
     })
 
-    createCfnOutput(`${id}-dashboardName`, scope, props.dashboardName)
+    utils.createCfnOutput(`${id}-dashboardName`, scope, props.dashboardName)
 
     return dashboard
   }
 
   /**
    * @summary Method to create cloudwatch widgets
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param props
    */
-  public createWidgets(scope: CommonConstruct, props: any[]) {
+  public createWidgets(scope: common.CommonConstruct, props: any[]) {
     if (!props || props.length == 0) throw `Widget props undefined`
 
     const widgets: any = []
@@ -137,10 +150,10 @@ export class CloudWatchManager {
   /**
    * @summary Method to create a cloudwatch widget
    * @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 props
    */
-  public createWidget(id: string, scope: CommonConstruct, props: any) {
+  public createWidget(id: string, scope: common.CommonConstruct, props: any) {
     if (!props) throw `Widget props undefined`
 
     const metrics = this.determineMetrics(scope, props.metricProps)
@@ -167,10 +180,10 @@ export class CloudWatchManager {
   /**
    * @summary Method to create a cloudwatch text widget
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {TextWidgetProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.TextWidgetProps} props
    */
-  public createTextWidget(id: string, scope: CommonConstruct, props: TextWidgetProps) {
+  public createTextWidget(id: string, scope: common.CommonConstruct, props: types.TextWidgetProps) {
     const widget = new watch.TextWidget({
       markdown: props.markdown,
       width: props.width,
@@ -185,11 +198,16 @@ export class CloudWatchManager {
   /**
    * @summary Method to create a cloudwatch numeric widget
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {NumericWidgetProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.NumericWidgetProps} props
    * @param metrics
    */
-  public createSingleValueWidget(id: string, scope: CommonConstruct, props: NumericWidgetProps, metrics: IMetric[]) {
+  public createSingleValueWidget(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.NumericWidgetProps,
+    metrics: IMetric[]
+  ) {
     const widget = new watch.SingleValueWidget({
       metrics: metrics,
       setPeriodToTimeRange: props.setPeriodToTimeRange,
@@ -207,15 +225,15 @@ export class CloudWatchManager {
   /**
    * @summary Method to create a cloudwatch graph widget
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {GraphWidgetProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.GraphWidgetProps} props
    * @param leftYMetrics
    * @param rightYMetrics
    */
   public createGraphWidget(
     id: string,
-    scope: CommonConstruct,
-    props: GraphWidgetProps,
+    scope: common.CommonConstruct,
+    props: types.GraphWidgetProps,
     leftYMetrics?: IMetric[],
     rightYMetrics?: IMetric[]
   ) {
@@ -243,14 +261,14 @@ export class CloudWatchManager {
   /**
    * @summary Method to create a cloudwatch alarm status widget
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {AlarmStatusWidgetProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.AlarmStatusWidgetProps} props
    * @param {watch.IAlarm[]} alarms
    */
   public createAlarmStatusWidget(
     id: string,
-    scope: CommonConstruct,
-    props: AlarmStatusWidgetProps,
+    scope: common.CommonConstruct,
+    props: types.AlarmStatusWidgetProps,
     alarms: watch.IAlarm[]
   ) {
     const widget = new watch.AlarmStatusWidget({
@@ -268,11 +286,16 @@ export class CloudWatchManager {
   /**
    * @summary Method to create a cloudwatch log query widget
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LogQueryWidgetProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LogQueryWidgetProps} props
    * @param {string[]} logGroupNames
    */
-  public createLogQueryWidget(id: string, scope: CommonConstruct, props: LogQueryWidgetProps, logGroupNames: string[]) {
+  public createLogQueryWidget(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.LogQueryWidgetProps,
+    logGroupNames: string[]
+  ) {
     const widget = new watch.LogQueryWidget({
       logGroupNames: logGroupNames,
       queryString: props.queryString,
@@ -290,13 +313,13 @@ export class CloudWatchManager {
 
   /**
    * @summary Utility method to determine the metrics and dimensions
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {MetricProps[]} metricProps
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.MetricProps[]} metricProps
    */
-  private determineMetrics(scope: CommonConstruct, metricProps: MetricProps[]) {
+  private determineMetrics(scope: common.CommonConstruct, metricProps: types.MetricProps[]) {
     const metrics: watch.IMetric[] = []
     if (metricProps) {
-      metricProps.forEach((metricProp: MetricProps) => {
+      metricProps.forEach((metricProp: types.MetricProps) => {
         let metricDimensions: watch.DimensionHash = metricProp.dimensionsMap || {}
         if (metricProp.functionName) {
           metricDimensions = {
@@ -349,10 +372,10 @@ export class CloudWatchManager {
   /**
    * @summary Utility method to determine the configured alarms
    * @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 {watch.AlarmProps[]} alarmProps
    */
-  private determineAlarms(id: string, scope: CommonConstruct, alarmProps: watch.AlarmProps[]) {
+  private determineAlarms(id: string, scope: common.CommonConstruct, alarmProps: watch.AlarmProps[]) {
     const alarms: watch.IAlarm[] = []
     if (alarmProps) {
       alarmProps.forEach((alarmProp: watch.AlarmProps) => {

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

@@ -1,9 +1,25 @@
-import { CommonConstruct } from '../common/commonConstruct'
-import * as codebuild from 'aws-cdk-lib/aws-codebuild'
 import * as cdk from 'aws-cdk-lib'
+import * as codebuild from 'aws-cdk-lib/aws-codebuild'
+import * as common from '../../common'
 
 /**
+ * @stability stable
+ * @category Developer Tools
+ * @summary Provides operations on AWS Code Build.
+ * - 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 { common.CommonConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends common.CommonConstruct {
+ *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.codeBuildManager.createImageForCloudfrontInvalidation('MyInvalidation', this, './docker ')
+ *   }
+ * }
  *
+ * @see [CDK Codebuild Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild-readme.html}
  */
 export class CodeBuildManager {
   /**
@@ -12,7 +28,7 @@ export class CodeBuildManager {
    * @param scope
    * @param dockerfilePath
    */
-  public createImageForCloudfrontInvalidation(id: string, scope: CommonConstruct, dockerfilePath: string) {
+  public createImageForCloudfrontInvalidation(id: string, scope: common.CommonConstruct, dockerfilePath: string) {
     return scope.ecrManager.createDockerImage(`${id}-build-image`, scope, dockerfilePath)
   }
 
@@ -26,7 +42,7 @@ export class CodeBuildManager {
    */
   public createProjectForCloudfrontInvalidation(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     dockerFilepath: string,
     distributionId: string,
     paths?: string