Class CloudWatchManager

Provides operations on AWS CloudWatch.

A new instance of this class is injected into CommonConstruct constructor.
If a custom construct extends 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]https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch-readme.html

Constructors

constructor

new CloudWatchManager(): CloudWatchManager
Returns CloudWatchManager

Methods

createAlarmForExpression

createAlarmForExpression(
    id: string,
    scope: CommonConstruct,
    props: AlarmProps,
): Alarm
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: AlarmProps
  the alarm properties including the math expression and metrics
Returns Alarm
- Defined in packages/aws/src/services/cloudwatch/main.ts:57

createAlarmForMetric

createAlarmForMetric(
    id: string,
    scope: CommonConstruct,
    props: AlarmProps,
    metric: Metric,
): Alarm
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: AlarmProps
  the alarm properties
- metric: Metric
  the CloudWatch metric to create the alarm for
Returns Alarm
- Defined in packages/aws/src/services/cloudwatch/main.ts:94

createAlarmStatusWidget

createAlarmStatusWidget(
    id: string,
    scope: CommonConstruct,
    props: AlarmStatusWidgetProps,
    alarms: IAlarm[],
): AlarmStatusWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: AlarmStatusWidgetProps
  the alarm status widget properties
- alarms: IAlarm[]
  the alarms to display status for
Returns AlarmStatusWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:442

createApiGatewayWidget

createApiGatewayWidget(
    id: string,
    scope: CommonConstruct,
    props: any,
    apiName: string,
):
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: any
- apiName: string
  the api name
Returns
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:238

createCacheWidget

createCacheWidget(
    id: string,
    scope: CommonConstruct,
    props: any,
    cacheClusterId: string,
):
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: any
- cacheClusterId: string
  the elasticache cluster id
Returns
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:341

createCloudfrontDistributionWidget

createCloudfrontDistributionWidget(
    id: string,
    scope: CommonConstruct,
    props: any,
    distributionId: string,
):
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: any
- distributionId: string
  the cloudfront distribution id
Returns
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:189

createCustomWidget

createCustomWidget(
    id: string,
    scope: CommonConstruct,
    props: any,
    service: string,
):
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: any
- service: string
  the service identifier
Returns
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:270

createDashboard

createDashboard(
    id: string,
    scope: CommonConstruct,
    props: DashboardProps,
    widgets?: IWidget[][],
): Dashboard
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: DashboardProps
  the dashboard properties
- Optionalwidgets: IWidget[][]
  optional 2D array of widgets to add to the dashboard
Returns Dashboard
- Defined in packages/aws/src/services/cloudwatch/main.ts:114

createEcsClusterWidget

createEcsClusterWidget(
    id: string,
    scope: CommonConstruct,
    props: any,
    clusterName: string,
):
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: any
- clusterName: string
  the ecs cluster name
Returns
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:286

createEcsServiceWidget

createEcsServiceWidget(
    id: string,
    scope: CommonConstruct,
    props: any,
    clusterName: string,
    serviceName: string,
):
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: any
- clusterName: string
  the ecs cluster name
- serviceName: string
  the ecs service name
Returns
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:303

createElbWidget

createElbWidget(
    id: string,
    scope: CommonConstruct,
    props: any,
    loadBalancer: string,
):
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: any
- loadBalancer: string
  the loadbalancer reference
Returns
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:325

createEventWidget

createEventWidget(
    id: string,
    scope: CommonConstruct,
    props: any,
    eventBusName: string,
    ruleName: string,
):
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: any
- eventBusName: string
  the event bus name
- ruleName: string
  the event rule name
Returns
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:222

createGraphWidget

createGraphWidget(
    id: string,
    scope: CommonConstruct,
    props: GraphWidgetProps,
    leftYMetrics?: IMetric[],
    rightYMetrics?: IMetric[],
): GraphWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: GraphWidgetProps
  the graph widget properties
- OptionalleftYMetrics: IMetric[]
  optional metrics to display on the left Y axis
- OptionalrightYMetrics: IMetric[]
  optional metrics to display on the right Y axis
Returns GraphWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:415

createGuageWidget

createGuageWidget(
    id: string,
    scope: CommonConstruct,
    props: GuageWidgetProps,
    metrics: IMetric[],
): GaugeWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: GuageWidgetProps
  the gauge widget properties
- metrics: IMetric[]
  the metrics to display in the widget
Returns GaugeWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:394

createLambdaWidget

createLambdaWidget(
    id: string,
    scope: CommonConstruct,
    props: any,
    functionName: string,
):
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: any
- functionName: string
  the lambda function name
Returns
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:254

createLogQueryWidget

createLogQueryWidget(
    id: string,
    scope: CommonConstruct,
    props: LogQueryWidgetProps,
    logGroupNames: string[],
): LogQueryWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: LogQueryWidgetProps
  the log query widget properties
- logGroupNames: string[]
  the log group names to query
Returns LogQueryWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:466

createSingleValueWidget

createSingleValueWidget(
    id: string,
    scope: CommonConstruct,
    props: NumericWidgetProps,
    metrics: IMetric[],
): SingleValueWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: NumericWidgetProps
  the numeric widget properties
- metrics: IMetric[]
  the metrics to display in the widget
Returns SingleValueWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:374

createStateWidget

createStateWidget(
    id: string,
    scope: CommonConstruct,
    props: any,
    stateMachineArn: string,
):
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: any
- stateMachineArn: string
  the step function arn
Returns
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:205

createTextWidget

createTextWidget(
    id: string,
    scope: CommonConstruct,
    props: TextWidgetProps,
): TextWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: TextWidgetProps
  the text widget properties
Returns TextWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:356

createWidget

createWidget(
    id: string,
    scope: CommonConstruct,
    props: any,
):
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: any
  the widget properties including the type discriminator
Returns
    | TextWidget
    | SingleValueWidget
    | GaugeWidget
    | GraphWidget
    | AlarmStatusWidget
    | LogQueryWidget
- Defined in packages/aws/src/services/cloudwatch/main.ts:156

createWidgets

createWidgets(scope: CommonConstruct, props: any[]): any
Parameters
- scope: CommonConstruct
  scope in which this resource is defined
- props: any[]
  array of widget properties
Returns any
- Defined in packages/aws/src/services/cloudwatch/main.ts:139

Class CloudWatchManager

Example

See

Index

Constructors

Methods

Constructors

constructor

Returns CloudWatchManager

Methods

createAlarmForExpression

Parameters

Returns Alarm

createAlarmForMetric

Parameters

Returns Alarm

createAlarmStatusWidget

Parameters

Returns AlarmStatusWidget

createApiGatewayWidget

Parameters

Returns | TextWidget | SingleValueWidget | GaugeWidget | GraphWidget | AlarmStatusWidget | LogQueryWidget

createCacheWidget

Parameters

Returns | TextWidget | SingleValueWidget | GaugeWidget | GraphWidget | AlarmStatusWidget | LogQueryWidget

createCloudfrontDistributionWidget

Parameters

Returns | TextWidget | SingleValueWidget | GaugeWidget | GraphWidget | AlarmStatusWidget | LogQueryWidget

createCustomWidget

Parameters

Returns | TextWidget | SingleValueWidget | GaugeWidget | GraphWidget | AlarmStatusWidget | LogQueryWidget

createDashboard

Parameters

Returns Dashboard

createEcsClusterWidget

Parameters

Returns | TextWidget | SingleValueWidget | GaugeWidget | GraphWidget | AlarmStatusWidget | LogQueryWidget

createEcsServiceWidget

Parameters

Returns | TextWidget | SingleValueWidget | GaugeWidget | GraphWidget | AlarmStatusWidget | LogQueryWidget

createElbWidget

Parameters

Returns | TextWidget | SingleValueWidget | GaugeWidget | GraphWidget | AlarmStatusWidget | LogQueryWidget

createEventWidget

Parameters

Returns | TextWidget | SingleValueWidget | GaugeWidget | GraphWidget | AlarmStatusWidget | LogQueryWidget

createGraphWidget

Parameters

Returns GraphWidget

createGuageWidget

Parameters

Returns GaugeWidget

createLambdaWidget

Parameters

Returns | TextWidget | SingleValueWidget | GaugeWidget | GraphWidget | AlarmStatusWidget | LogQueryWidget

createLogQueryWidget

Parameters

Returns LogQueryWidget

createSingleValueWidget

Parameters

Returns SingleValueWidget

createStateWidget

Parameters

Returns | TextWidget | SingleValueWidget | GaugeWidget | GraphWidget | AlarmStatusWidget | LogQueryWidget

createTextWidget

Parameters

Returns TextWidget

createWidget

Parameters

Returns | TextWidget | SingleValueWidget | GaugeWidget | GraphWidget | AlarmStatusWidget | LogQueryWidget

createWidgets

Parameters

Returns any

Settings

On This Page

Returns
| TextWidget
| SingleValueWidget
| GaugeWidget
| GraphWidget
| AlarmStatusWidget
| LogQueryWidget

Returns
| TextWidget
| SingleValueWidget
| GaugeWidget
| GraphWidget
| AlarmStatusWidget
| LogQueryWidget

Returns
| TextWidget
| SingleValueWidget
| GaugeWidget
| GraphWidget
| AlarmStatusWidget
| LogQueryWidget

Returns
| TextWidget
| SingleValueWidget
| GaugeWidget
| GraphWidget
| AlarmStatusWidget
| LogQueryWidget

Returns
| TextWidget
| SingleValueWidget
| GaugeWidget
| GraphWidget
| AlarmStatusWidget
| LogQueryWidget

Returns
| TextWidget
| SingleValueWidget
| GaugeWidget
| GraphWidget
| AlarmStatusWidget
| LogQueryWidget

Returns
| TextWidget
| SingleValueWidget
| GaugeWidget
| GraphWidget
| AlarmStatusWidget
| LogQueryWidget

Returns
| TextWidget
| SingleValueWidget
| GaugeWidget
| GraphWidget
| AlarmStatusWidget
| LogQueryWidget

Returns
| TextWidget
| SingleValueWidget
| GaugeWidget
| GraphWidget
| AlarmStatusWidget
| LogQueryWidget

Returns
| TextWidget
| SingleValueWidget
| GaugeWidget
| GraphWidget
| AlarmStatusWidget
| LogQueryWidget

Returns
| TextWidget
| SingleValueWidget
| GaugeWidget
| GraphWidget
| AlarmStatusWidget
| LogQueryWidget