interface AlarmStatusWidgetProps

Language	Type name
.NET	Amazon.CDK.AWS.CloudWatch.AlarmStatusWidgetProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#AlarmStatusWidgetProps
Java	software.amazon.awscdk.services.cloudwatch.AlarmStatusWidgetProps
Python	aws_cdk.aws_cloudwatch.AlarmStatusWidgetProps
TypeScript (source)	aws-cdk-lib » aws_cloudwatch » AlarmStatusWidgetProps

Properties for an Alarm Status Widget.

Example

declare const dashboard: cloudwatch.Dashboard;
declare const errorAlarm: cloudwatch.Alarm;

dashboard.addWidgets(
  new cloudwatch.AlarmStatusWidget({
    alarms: [errorAlarm],
  })
);

Properties

Name	Type	Description
alarms	IAlarm[]	CloudWatch Alarms to show in widget.
height?	number	Height of the widget.
sortBy?	AlarmStatusWidgetSortBy	Specifies how to sort the alarms in the widget.
states?	AlarmState[]	Use this field to filter the list of alarms displayed in the widget to only those alarms currently in the specified states.
title?	string	The title of the widget.
width?	number	Width of the widget, in a grid of 24 units wide.

---

alarms

Type: IAlarm[]

CloudWatch Alarms to show in widget.

---

height?

Type: number (optional, default: 3)

Height of the widget.

---

sortBy?

Type: AlarmStatusWidgetSortBy (optional, default: alphabetical order)

Specifies how to sort the alarms in the widget.

---

states?

Type: AlarmState[] (optional, default: all the alarms specified in alarms are displayed.)

Use this field to filter the list of alarms displayed in the widget to only those alarms currently in the specified states.

You can specify one or more alarm states in the value for this field. The alarm states that you can specify are ALARM, INSUFFICIENT_DATA, and OK.

If you omit this field or specify an empty array, all the alarms specified in alarms are displayed.

---

title?

Type: string (optional, default: 'Alarm Status')

The title of the widget.

---

width?

Type: number (optional, default: 6)

Width of the widget, in a grid of 24 units wide.