Package software.amazon.awscdk.services.cloudwatch

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.104.0 (build e79254c)",
           date="2024-11-22T02:23:58.459Z")
@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());
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	Choose DEFAULT to sort them in alphabetical order by alarm name.
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.
TIMESTAMP	Choose TIMESTAMP to sort them by the time when the alarms most recently changed state, no matter the current alarm state.

Method Summary

Modifier and Type	Method	Description
static AlarmStatusWidgetSortBy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AlarmStatusWidgetSortBy[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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