@gradientedge/cdk-utils 8.88.0 → 8.90.0

package/dist/src/lib/{manager/aws/log-manager.d.ts → services/aws/cloudwatch/logs.d.ts}

@@ -1,18 +1,18 @@
 import * as cdk from 'aws-cdk-lib';
 import * as logs from 'aws-cdk-lib/aws-logs';
-import * as common from '../../common';
-import * as types from '../../types';
+import { CommonConstruct } from '../../../common';
+import { LogProps, MetricFilterProps } from './types';
 /**
  * @stability stable
  * @category cdk-utils.cloudwatch-manager
  * @subcategory Construct
  * @classdesc Provides operations on AWS CloudWatch.
- * - 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
@@ -26,26 +26,26 @@ export declare class LogManager {
     /**
      * @summary Method to create a cloudwatch metric filter
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.MetricFilterProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {MetricFilterProps} props
      * @param {logs.ILogGroup} logGroup
      */
-    createMetricFilter(id: string, scope: common.CommonConstruct, props: types.MetricFilterProps, logGroup: logs.ILogGroup): {
+    createMetricFilter(id: string, scope: CommonConstruct, props: MetricFilterProps, logGroup: logs.ILogGroup): {
         metricFilter: cdk.aws_logs.MetricFilter;
         metric: cdk.aws_cloudwatch.Metric;
     };
     /**
      * @summary Method to create a cloudwatch log group (cfn)
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.LogProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {LogProps} props
      */
-    createCfnLogGroup(id: string, scope: common.CommonConstruct, props: types.LogProps): cdk.aws_logs.CfnLogGroup;
+    createCfnLogGroup(id: string, scope: CommonConstruct, props: LogProps): cdk.aws_logs.CfnLogGroup;
     /**
      * @summary Method to create a cloudwatch log group
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.LogProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {LogProps} props
      */
-    createLogGroup(id: string, scope: common.CommonConstruct, props: types.LogProps): cdk.aws_logs.LogGroup;
+    createLogGroup(id: string, scope: CommonConstruct, props: LogProps): cdk.aws_logs.LogGroup;
 }

package/dist/src/lib/{manager/aws/log-manager.js → services/aws/cloudwatch/logs.js}

@@ -26,18 +26,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LogManager = void 0;
 const cdk = __importStar(require("aws-cdk-lib"));
 const logs = __importStar(require("aws-cdk-lib/aws-logs"));
-const utils = __importStar(require("../../utils"));
+const utils = __importStar(require("../../../utils"));
 /**
  * @stability stable
  * @category cdk-utils.cloudwatch-manager
  * @subcategory Construct
  * @classdesc Provides operations on AWS CloudWatch.
- * - 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
@@ -51,8 +51,8 @@ class LogManager {
     /**
      * @summary Method to create a cloudwatch metric filter
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.MetricFilterProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {MetricFilterProps} props
      * @param {logs.ILogGroup} logGroup
      */
     createMetricFilter(id, scope, props, logGroup) {
@@ -78,8 +78,8 @@ class LogManager {
     /**
      * @summary Method to create a cloudwatch log group (cfn)
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.LogProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {LogProps} props
      */
     createCfnLogGroup(id, scope, props) {
         if (!props)
@@ -100,8 +100,8 @@ class LogManager {
     /**
      * @summary Method to create a cloudwatch log group
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.LogProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {LogProps} props
      */
     createLogGroup(id, scope, props) {
         if (!props)

package/dist/src/lib/services/aws/cloudwatch/main.d.ts

@@ -0,0 +1,211 @@
+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 { CommonConstruct } from '../../../common';
+import { AlarmProps, AlarmStatusWidgetProps, DashboardProps, GraphWidgetProps, GuageWidgetProps, LogQueryWidgetProps, NumericWidgetProps, TextWidgetProps } from './types';
+/**
+ * @stability stable
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Construct
+ * @classdesc 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.
+ * @example
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends 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/v2/docs/aws-cdk-lib.aws_cloudwatch-readme.html}
+ */
+export declare 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
+     */
+    createAlarmForExpression(id: string, scope: CommonConstruct, props: AlarmProps): cdk.aws_cloudwatch.Alarm;
+    /**
+     * @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 metric
+     */
+    createAlarmForMetric(id: string, scope: CommonConstruct, props: AlarmProps, metric: watch.Metric): cdk.aws_cloudwatch.Alarm;
+    /**
+     * @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 widgets
+     */
+    createDashboard(id: string, scope: CommonConstruct, props: DashboardProps, widgets?: watch.IWidget[][]): cdk.aws_cloudwatch.Dashboard;
+    /**
+     * @summary Method to create cloudwatch widgets
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param props
+     */
+    createWidgets(scope: CommonConstruct, props: any[]): any;
+    /**
+     * @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 props
+     */
+    createWidget(id: string, scope: CommonConstruct, props: any): cdk.aws_cloudwatch.GaugeWidget | cdk.aws_cloudwatch.GraphWidget | cdk.aws_cloudwatch.SingleValueWidget | cdk.aws_cloudwatch.LogQueryWidget | cdk.aws_cloudwatch.TextWidget | cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @summary Method to create a cloudfront distribution widget
+     * @param {string} id scoped id of the resource
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
+     * @param {string} distributionId the cloudfront distribution id
+     */
+    createCloudfrontDistributionWidget(id: string, scope: CommonConstruct, props: any, distributionId: string): cdk.aws_cloudwatch.GaugeWidget | cdk.aws_cloudwatch.GraphWidget | cdk.aws_cloudwatch.SingleValueWidget | cdk.aws_cloudwatch.LogQueryWidget | cdk.aws_cloudwatch.TextWidget | cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @summary Method to create a step function widget
+     * @param {string} id scoped id of the resource
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
+     * @param {string} stateMachineArn the step function arn
+     */
+    createStateWidget(id: string, scope: CommonConstruct, props: any, stateMachineArn: string): cdk.aws_cloudwatch.GaugeWidget | cdk.aws_cloudwatch.GraphWidget | cdk.aws_cloudwatch.SingleValueWidget | cdk.aws_cloudwatch.LogQueryWidget | cdk.aws_cloudwatch.TextWidget | cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @summary Method to create an event widget
+     * @param {string} id scoped id of the resource
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
+     * @param {string} eventBusName the event bus name
+     * @param {string} ruleName the event rule name
+     */
+    createEventWidget(id: string, scope: CommonConstruct, props: any, eventBusName: string, ruleName: string): cdk.aws_cloudwatch.GaugeWidget | cdk.aws_cloudwatch.GraphWidget | cdk.aws_cloudwatch.SingleValueWidget | cdk.aws_cloudwatch.LogQueryWidget | cdk.aws_cloudwatch.TextWidget | cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @summary Method to create an api gateway widget
+     * @param {string} id scoped id of the resource
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
+     * @param {string} apiName the api name
+     */
+    createApiGatewayWidget(id: string, scope: CommonConstruct, props: any, apiName: string): cdk.aws_cloudwatch.GaugeWidget | cdk.aws_cloudwatch.GraphWidget | cdk.aws_cloudwatch.SingleValueWidget | cdk.aws_cloudwatch.LogQueryWidget | cdk.aws_cloudwatch.TextWidget | cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @summary Method to create a lambda function widget
+     * @param {string} id scoped id of the resource
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
+     * @param {string} functionName the lambda function name
+     */
+    createLambdaWidget(id: string, scope: CommonConstruct, props: any, functionName: string): cdk.aws_cloudwatch.GaugeWidget | cdk.aws_cloudwatch.GraphWidget | cdk.aws_cloudwatch.SingleValueWidget | cdk.aws_cloudwatch.LogQueryWidget | cdk.aws_cloudwatch.TextWidget | cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @summary Method to create a custom widget
+     * @param {string} id scoped id of the resource
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
+     * @param {string} service the service identifier
+     */
+    createCustomWidget(id: string, scope: CommonConstruct, props: any, service: string): cdk.aws_cloudwatch.GaugeWidget | cdk.aws_cloudwatch.GraphWidget | cdk.aws_cloudwatch.SingleValueWidget | cdk.aws_cloudwatch.LogQueryWidget | cdk.aws_cloudwatch.TextWidget | cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @summary Method to create an ecs cluster widget
+     * @param {string} id scoped id of the resource
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
+     * @param {string} clusterName the ecs cluster name
+     */
+    createEcsClusterWidget(id: string, scope: CommonConstruct, props: any, clusterName: string): cdk.aws_cloudwatch.GaugeWidget | cdk.aws_cloudwatch.GraphWidget | cdk.aws_cloudwatch.SingleValueWidget | cdk.aws_cloudwatch.LogQueryWidget | cdk.aws_cloudwatch.TextWidget | cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @summary Method to create an ecs service widget
+     * @param {string} id scoped id of the resource
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
+     * @param {string} clusterName the ecs cluster name
+     * @param {string} serviceName the ecs service name
+     */
+    createEcsServiceWidget(id: string, scope: CommonConstruct, props: any, clusterName: string, serviceName: string): cdk.aws_cloudwatch.GaugeWidget | cdk.aws_cloudwatch.GraphWidget | cdk.aws_cloudwatch.SingleValueWidget | cdk.aws_cloudwatch.LogQueryWidget | cdk.aws_cloudwatch.TextWidget | cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @summary Method to create an elb widget
+     * @param {string} id scoped id of the resource
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
+     * @param {string} loadBalancer the loadbalancer reference
+     */
+    createElbWidget(id: string, scope: CommonConstruct, props: any, loadBalancer: string): cdk.aws_cloudwatch.GaugeWidget | cdk.aws_cloudwatch.GraphWidget | cdk.aws_cloudwatch.SingleValueWidget | cdk.aws_cloudwatch.LogQueryWidget | cdk.aws_cloudwatch.TextWidget | cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @summary Method to create an elasticache widget
+     * @param {string} id scoped id of the resource
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
+     * @param {string} cacheClusterId the elasticache cluster id
+     */
+    createCacheWidget(id: string, scope: CommonConstruct, props: any, cacheClusterId: string): cdk.aws_cloudwatch.GaugeWidget | cdk.aws_cloudwatch.GraphWidget | cdk.aws_cloudwatch.SingleValueWidget | cdk.aws_cloudwatch.LogQueryWidget | cdk.aws_cloudwatch.TextWidget | cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @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
+     */
+    createTextWidget(id: string, scope: CommonConstruct, props: TextWidgetProps): cdk.aws_cloudwatch.TextWidget;
+    /**
+     * @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 metrics
+     */
+    createSingleValueWidget(id: string, scope: CommonConstruct, props: NumericWidgetProps, metrics: IMetric[]): cdk.aws_cloudwatch.SingleValueWidget;
+    /**
+     * @summary Method to create a cloudwatch guage widget
+     * @param {string} id scoped id of the resource
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {GuageWidgetProps} props
+     * @param metrics
+     */
+    createGuageWidget(id: string, scope: CommonConstruct, props: GuageWidgetProps, metrics: IMetric[]): cdk.aws_cloudwatch.GaugeWidget;
+    /**
+     * @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 leftYMetrics
+     * @param rightYMetrics
+     */
+    createGraphWidget(id: string, scope: CommonConstruct, props: GraphWidgetProps, leftYMetrics?: IMetric[], rightYMetrics?: IMetric[]): cdk.aws_cloudwatch.GraphWidget;
+    /**
+     * @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 {watch.IAlarm[]} alarms
+     */
+    createAlarmStatusWidget(id: string, scope: CommonConstruct, props: AlarmStatusWidgetProps, alarms: watch.IAlarm[]): cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @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 {string[]} logGroupNames
+     */
+    createLogQueryWidget(id: string, scope: CommonConstruct, props: LogQueryWidgetProps, logGroupNames: string[]): cdk.aws_cloudwatch.LogQueryWidget;
+    /**
+     * @summary Utility method to determine the metrics and dimensions
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {MetricProps[]} metricProps
+     */
+    private determineMetrics;
+    /**
+     * @summary Utility method to determine the time range
+     * @param {string?} range
+     */
+    private static determineTimeRange;
+    /**
+     * @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 {watch.AlarmProps[]} alarmProps
+     */
+    private determineAlarms;
+}

package/dist/src/lib/{manager/aws/cloudwatch-manager.js → services/aws/cloudwatch/main.js}

@@ -26,7 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CloudWatchManager = void 0;
 const cdk = __importStar(require("aws-cdk-lib"));
 const watch = __importStar(require("aws-cdk-lib/aws-cloudwatch"));
-const utils = __importStar(require("../../utils"));
+const utils = __importStar(require("../../../utils"));
 /**
  * @category cdk-utils.cloudwatch-manager
  * @subcategory Construct
@@ -45,12 +45,12 @@ var CloudWatchWidgetType;
  * @category cdk-utils.cloudwatch-manager
  * @subcategory Construct
  * @classdesc Provides operations on AWS CloudWatch.
- * - 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
@@ -64,8 +64,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create a cloudwatch alarm for a given expression
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.AlarmProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {AlarmProps} props
      */
     createAlarmForExpression(id, scope, props) {
         if (!props)
@@ -97,8 +97,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create a cloudwatch alarm for a given metric
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.AlarmProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {AlarmProps} props
      * @param metric
      */
     createAlarmForMetric(id, scope, props, metric) {
@@ -120,8 +120,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create a cloudwatch dashboard
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.DashboardProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {DashboardProps} props
      * @param widgets
      */
     createDashboard(id, scope, props, widgets) {
@@ -139,7 +139,7 @@ class CloudWatchManager {
     }
     /**
      * @summary Method to create cloudwatch widgets
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {CommonConstruct} scope scope in which this resource is defined
      * @param props
      */
     createWidgets(scope, props) {
@@ -152,7 +152,7 @@ class CloudWatchManager {
     /**
      * @summary Method to create a cloudwatch widget
      * @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 props
      */
     createWidget(id, scope, props) {
@@ -182,8 +182,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create a cloudfront distribution widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.TextWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
      * @param {string} distributionId the cloudfront distribution id
      */
     createCloudfrontDistributionWidget(id, scope, props, distributionId) {
@@ -200,8 +200,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create a step function widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.TextWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
      * @param {string} stateMachineArn the step function arn
      */
     createStateWidget(id, scope, props, stateMachineArn) {
@@ -218,8 +218,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create an event widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.TextWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
      * @param {string} eventBusName the event bus name
      * @param {string} ruleName the event rule name
      */
@@ -240,8 +240,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create an api gateway widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.TextWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
      * @param {string} apiName the api name
      */
     createApiGatewayWidget(id, scope, props, apiName) {
@@ -258,8 +258,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create a lambda function widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.TextWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
      * @param {string} functionName the lambda function name
      */
     createLambdaWidget(id, scope, props, functionName) {
@@ -276,8 +276,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create a custom widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.TextWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
      * @param {string} service the service identifier
      */
     createCustomWidget(id, scope, props, service) {
@@ -294,8 +294,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create an ecs cluster widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.TextWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
      * @param {string} clusterName the ecs cluster name
      */
     createEcsClusterWidget(id, scope, props, clusterName) {
@@ -312,8 +312,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create an ecs service widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.TextWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
      * @param {string} clusterName the ecs cluster name
      * @param {string} serviceName the ecs service name
      */
@@ -334,8 +334,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create an elb widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.TextWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
      * @param {string} loadBalancer the loadbalancer reference
      */
     createElbWidget(id, scope, props, loadBalancer) {
@@ -352,8 +352,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create an elasticache widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.TextWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
      * @param {string} cacheClusterId the elasticache cluster id
      */
     createCacheWidget(id, scope, props, cacheClusterId) {
@@ -370,8 +370,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create a cloudwatch text widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.TextWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {TextWidgetProps} props
      */
     createTextWidget(id, scope, props) {
         if (!props)
@@ -388,8 +388,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create a cloudwatch numeric widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.NumericWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {NumericWidgetProps} props
      * @param metrics
      */
     createSingleValueWidget(id, scope, props, metrics) {
@@ -412,8 +412,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create a cloudwatch guage widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.GuageWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {GuageWidgetProps} props
      * @param metrics
      */
     createGuageWidget(id, scope, props, metrics) {
@@ -436,8 +436,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create a cloudwatch graph widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.GraphWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {GraphWidgetProps} props
      * @param leftYMetrics
      * @param rightYMetrics
      */
@@ -467,8 +467,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create a cloudwatch alarm status widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.AlarmStatusWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {AlarmStatusWidgetProps} props
      * @param {watch.IAlarm[]} alarms
      */
     createAlarmStatusWidget(id, scope, props, alarms) {
@@ -487,8 +487,8 @@ class CloudWatchManager {
     /**
      * @summary Method to create a cloudwatch log query widget
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.LogQueryWidgetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {LogQueryWidgetProps} props
      * @param {string[]} logGroupNames
      */
     createLogQueryWidget(id, scope, props, logGroupNames) {
@@ -510,8 +510,8 @@ class CloudWatchManager {
     }
     /**
      * @summary Utility method to determine the metrics and dimensions
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.MetricProps[]} metricProps
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {MetricProps[]} metricProps
      */
     determineMetrics(scope, metricProps) {
         const metrics = [];
@@ -648,7 +648,7 @@ class CloudWatchManager {
     /**
      * @summary Utility method to determine the configured alarms
      * @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 {watch.AlarmProps[]} alarmProps
      */
     determineAlarms(id, scope, alarmProps) {