Interface AlarmStatusWidgetProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AlarmStatusWidgetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:15.795Z") @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());
 
  • Method Details

    • getAlarms

      @Stability(Stable) @NotNull List<IAlarm> getAlarms()
      CloudWatch Alarms to show in widget.
    • getHeight

      @Stability(Stable) @Nullable default Number getHeight()
      Height of the widget.

      Default: 3

    • getSortBy

      @Stability(Stable) @Nullable default AlarmStatusWidgetSortBy getSortBy()
      Specifies how to sort the alarms in the widget.

      Default: - alphabetical order

    • getStates

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default String getTitle()
      The title of the widget.

      Default: 'Alarm Status'

    • getWidth

      @Stability(Stable) @Nullable default Number getWidth()
      Width of the widget, in a grid of 24 units wide.

      Default: 6

    • builder

      @Stability(Stable) static AlarmStatusWidgetProps.Builder builder()
      Returns:
      a AlarmStatusWidgetProps.Builder of AlarmStatusWidgetProps