interface AlarmWidgetProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.CloudWatch.AlarmWidgetProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#AlarmWidgetProps |
 Java | software.amazon.awscdk.services.cloudwatch.AlarmWidgetProps |
 Python | aws_cdk.aws_cloudwatch.AlarmWidgetProps |
 TypeScript (source) | aws-cdk-lib » aws_cloudwatch » AlarmWidgetProps |
Properties for an AlarmWidget.
Example
declare const dashboard: cloudwatch.Dashboard;
declare const errorAlarm: cloudwatch.Alarm;
dashboard.addWidgets(new cloudwatch.AlarmWidget({
title: "Errors",
alarm: errorAlarm,
}));
Properties
| Name | Type | Description |
|---|---|---|
| alarm | IAlarm | The alarm to show. |
| height? | number | Height of the widget. |
| left | YAxis | Left Y axis. |
| region? | string | The region the metrics of this graph should be taken from. |
| title? | string | Title for the graph. |
| width? | number | Width of the widget, in a grid of 24 units wide. |
alarm
Type:
IAlarm
The alarm to show.
height?
Type:
number
(optional, default: 6 for Alarm and Graph widgets.
3 for single value widgets where most recent value of a metric is displayed.)
Height of the widget.
leftYAxis?
Type:
YAxis
(optional, default: No minimum or maximum values for the left Y-axis)
Left Y axis.
region?
Type:
string
(optional, default: Current region)
The region the metrics of this graph should be taken from.
title?
Type:
string
(optional, default: None)
Title for the graph.
width?
Type:
number
(optional, default: 6)
Width of the widget, in a grid of 24 units wide.