aws-cdk-lib.aws_cloudwatch.GraphWidget

class GraphWidget

LanguageType name
.NETAmazon.CDK.AWS.CloudWatch.GraphWidget
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#GraphWidget
Javasoftware.amazon.awscdk.services.cloudwatch.GraphWidget
Pythonaws_cdk.aws_cloudwatch.GraphWidget
TypeScript (source)aws-cdk-lib » aws_cloudwatch » GraphWidget

Implements IWidget

Extends ConcreteWidget

A dashboard widget that displays metrics.

Example

declare const dashboard: cloudwatch.Dashboard;

dashboard.addWidgets(new cloudwatch.GraphWidget({
  // ...

  legendPosition: cloudwatch.LegendPosition.RIGHT,
}));

Initializer

new GraphWidget(props: GraphWidgetProps)

Parameters

  • props GraphWidgetProps

Properties

NameTypeDescription
heightnumberThe amount of vertical grid units the widget will take up.
widthnumberThe amount of horizontal grid units the widget will take up.
warnings?string[]Any warnings that are produced as a result of putting together this widget.

height

Type: number

The amount of vertical grid units the widget will take up.


width

Type: number

The amount of horizontal grid units the widget will take up.


warnings?

Type: string[] (optional)

Any warnings that are produced as a result of putting together this widget.

Methods

NameDescription
addLeftMetric(metric)Add another metric to the left Y axis of the GraphWidget.
addRightMetric(metric)Add another metric to the right Y axis of the GraphWidget.
position(x, y)Place the widget at a given position.
toJson()Return the widget JSON for use in the dashboard.

addLeftMetric(metric)

public addLeftMetric(metric: IMetric): void

Parameters

  • metric IMetric — the metric to add.

Add another metric to the left Y axis of the GraphWidget.


addRightMetric(metric)

public addRightMetric(metric: IMetric): void

Parameters

  • metric IMetric — the metric to add.

Add another metric to the right Y axis of the GraphWidget.


position(x, y)

public position(x: number, y: number): void

Parameters

  • x number
  • y number

Place the widget at a given position.


toJson()

public toJson(): any[]

Returns

  • any[]

Return the widget JSON for use in the dashboard.