Interface AlarmStatusWidgetProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
AlarmStatusWidgetProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-11T15:55:54.727Z")
@Stability(Stable)
public interface AlarmStatusWidgetProps
extends software.amazon.jsii.JsiiSerializable
Properties for an Alarm Status Widget.
Example:
Dashboard dashboard; Alarm errorAlarm; dashboard.addWidgets( AlarmStatusWidget.Builder.create() .alarms(List.of(errorAlarm)) .build());
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forAlarmStatusWidgetProps
static final class
An implementation forAlarmStatusWidgetProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
CloudWatch Alarms to show in widget.default Number
Height of the widget.default AlarmStatusWidgetSortBy
Specifies how to sort the alarms in the widget.default List<AlarmState>
Use this field to filter the list of alarms displayed in the widget to only those alarms currently in the specified states.default String
getTitle()
The title of the widget.default Number
getWidth()
Width of the widget, in a grid of 24 units wide.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAlarms
CloudWatch Alarms to show in widget. -
getHeight
Height of the widget.Default: 3
-
getSortBy
Specifies how to sort the alarms in the widget.Default: - alphabetical order
-
getStates
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 specifed in alarms are displayed.
Default: - all the alarms specified in alarms are displayed.
-
getTitle
The title of the widget.Default: 'Alarm Status'
-
getWidth
Width of the widget, in a grid of 24 units wide.Default: 6
-
builder
- Returns:
- a
AlarmStatusWidgetProps.Builder
ofAlarmStatusWidgetProps
-