software.amazon.awscdk.services.cloudwatch

Interface AlarmStatusWidgetProps

All Known Implementing Classes:

AlarmStatusWidgetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:18.533Z")
public interface AlarmStatusWidgetProps

Properties for an Alarm Status Widget.

Example:

 Dashboard dashboard;
 Alarm errorAlarm;
 dashboard.addWidgets(
 AlarmStatusWidget.Builder.create()
         .alarms(List.of(errorAlarm))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AlarmStatusWidgetProps.Builder A builder for AlarmStatusWidgetProps
static class	AlarmStatusWidgetProps.Jsii$Proxy An implementation for AlarmStatusWidgetProps

Method Summary

Modifier and Type	Method and Description
static AlarmStatusWidgetProps.Builder	builder()
java.util.List<IAlarm>	getAlarms() CloudWatch Alarms to show in widget.
default java.lang.Number	getHeight() Height of the widget.
default AlarmStatusWidgetSortBy	getSortBy() Specifies how to sort the alarms in the widget.
default java.util.List<AlarmState>	getStates() Use this field to filter the list of alarms displayed in the widget to only those alarms currently in the specified states.
default java.lang.String	getTitle() The title of the widget.
default java.lang.Number	getWidth() Width of the widget, in a grid of 24 units wide.

Method Detail

getAlarms

java.util.List<IAlarm> getAlarms()

CloudWatch Alarms to show in widget.

getHeight

default java.lang.Number getHeight()

Height of the widget.

Default: 3

getSortBy

default AlarmStatusWidgetSortBy getSortBy()

Specifies how to sort the alarms in the widget.

Default: - alphabetical order

getStates

default java.util.List<AlarmState> 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

default java.lang.String getTitle()

The title of the widget.

Default: 'Alarm Status'

getWidth

default java.lang.Number getWidth()

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

Default: 6

builder

static AlarmStatusWidgetProps.Builder builder()

Returns:

a AlarmStatusWidgetProps.Builder of AlarmStatusWidgetProps