@gradientedge/cdk-utils 8.91.0 → 8.92.0

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

@@ -4,9 +4,6 @@ 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.
@@ -20,192 +17,191 @@ import { AlarmProps, AlarmStatusWidgetProps, DashboardProps, GraphWidgetProps, G
  *     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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param 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 id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param 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 id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param 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 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 id scoped id of the resource
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param eventBusName the event bus name
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param clusterName the ecs cluster name
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param 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 id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param 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 id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param 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 id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param 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
+     * @param scope scope in which this resource is defined
+     * @param metricProps
      */
     private determineMetrics;
     /**
      * @summary Utility method to determine the time range
-     * @param {string?} range
+     * @param 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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param alarmProps
      */
     private determineAlarms;
 }