software.amazon.awscdk.services.iot.actions.alpha

Interface CloudWatchSetAlarmStateActionProps

All Superinterfaces:

CommonActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CloudWatchSetAlarmStateActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.78.1 (build 878761e)",
           date="2023-04-17T22:38:13.257Z")
 @Stability(value=Experimental)
public interface CloudWatchSetAlarmStateActionProps
extends software.amazon.jsii.JsiiSerializable, CommonActionProps

(experimental) Configuration properties of an action for CloudWatch alarm.

Example:

 import software.amazon.awscdk.services.cloudwatch.*;
 Metric metric = Metric.Builder.create()
         .namespace("MyNamespace")
         .metricName("MyMetric")
         .dimensions(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

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

Method Summary

Modifier and Type	Method and Description
static CloudWatchSetAlarmStateActionProps.Builder	builder()
AlarmState	getAlarmStateToSet() (experimental) The value of the alarm state to set.
default String	getReason() (experimental) The reason for the alarm change.

Methods inherited from interface software.amazon.awscdk.services.iot.actions.alpha.CommonActionProps

getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAlarmStateToSet

@Stability(value=Experimental)
 @NotNull
AlarmState getAlarmStateToSet()

(experimental) The value of the alarm state to set.

getReason

@Stability(value=Experimental)
 @Nullable
default String getReason()

(experimental) The reason for the alarm change.

Default: None

builder

@Stability(value=Experimental)
static CloudWatchSetAlarmStateActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Returns:

a CloudWatchSetAlarmStateActionProps.Builder of CloudWatchSetAlarmStateActionProps