Enum AlarmStatusWidgetSortBy

java.lang.Object
java.lang.Enum<AlarmStatusWidgetSortBy>
software.amazon.awscdk.services.cloudwatch.AlarmStatusWidgetSortBy
All Implemented Interfaces:
Serializable, Comparable<AlarmStatusWidgetSortBy>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:15.795Z") @Stability(Stable) public enum AlarmStatusWidgetSortBy extends Enum<AlarmStatusWidgetSortBy>
The sort possibilities for AlarmStatusWidgets.

Example:

 Dashboard dashboard;
 Alarm errorAlarm;
 dashboard.addWidgets(AlarmStatusWidget.Builder.create()
         .title("Errors")
         .alarms(List.of(errorAlarm))
         .sortBy(AlarmStatusWidgetSortBy.STATE_UPDATED_TIMESTAMP)
         .states(List.of(AlarmState.ALARM))
         .build());
 
  • Enum Constant Details

    • DEFAULT

      @Stability(Stable) public static final AlarmStatusWidgetSortBy DEFAULT
      Choose DEFAULT to sort them in alphabetical order by alarm name.
    • STATE_UPDATED_TIMESTAMP

      @Stability(Stable) public static final AlarmStatusWidgetSortBy STATE_UPDATED_TIMESTAMP
      Choose STATE_UPDATED_TIMESTAMP to sort them first by alarm state, with alarms in ALARM state first, INSUFFICIENT_DATA alarms next, and OK alarms last.

      Within each group, the alarms are sorted by when they last changed state, with more recent state changes listed first.

    • TIMESTAMP

      @Stability(Stable) public static final AlarmStatusWidgetSortBy TIMESTAMP
      Choose TIMESTAMP to sort them by the time when the alarms most recently changed state, no matter the current alarm state.

      The alarm that changed state most recently is listed first.

  • Method Details

    • values

      public static AlarmStatusWidgetSortBy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static AlarmStatusWidgetSortBy valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null