Package software.amazon.awscdk.services.cloudwatch

Enum AlarmState

java.lang.Object

java.lang.Enum<AlarmState>

software.amazon.awscdk.services.cloudwatch.AlarmState

All Implemented Interfaces:

Serializable, Comparable<AlarmState>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-08-13T16:20:02.102Z")
@Stability(Stable)
public enum AlarmState
extends Enum<AlarmState>

Enumeration indicates state of Alarm used in building Alarm Rule.

Example:

 import software.amazon.awscdk.services.cloudwatch.*;
 Metric metric = Metric.Builder.create()
         .namespace("MyNamespace")
         .metricName("MyMetric")
         .dimensionsMap(Map.of("MyDimension", "MyDimensionValue"))
         .build();
 Alarm alarm = Alarm.Builder.create(this, "MyAlarm")
         .metric(metric)
         .threshold(100)
         .evaluationPeriods(3)
         .datapointsToAlarm(2)
         .build();
 TopicRule topicRule = TopicRule.Builder.create(this, "TopicRule")
         .sql(IotSql.fromStringAsVer20160323("SELECT topic(2) as device_id FROM 'device/+/data'"))
         .actions(List.of(
             CloudWatchSetAlarmStateAction.Builder.create(alarm)
                     .reason("AWS Iot Rule action is triggered")
                     .alarmStateToSet(AlarmState.ALARM)
                     .build()))
         .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
ALARM	State indicates resource is in ALARM.
INSUFFICIENT_DATA	State indicates there is not enough data to determine is resource is in ALARM.
OK	State indicates resource is not in ALARM.

Method Summary

Modifier and Type	Method	Description
static AlarmState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AlarmState[]	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

ALARM

@Stability(Stable)
public static final AlarmState ALARM

State indicates resource is in ALARM.

OK

@Stability(Stable)
public static final AlarmState OK

State indicates resource is not in ALARM.

INSUFFICIENT_DATA

@Stability(Stable)
public static final AlarmState INSUFFICIENT_DATA

State indicates there is not enough data to determine is resource is in ALARM.

Method Details

values

public static AlarmState[] 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 AlarmState 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