Package software.amazon.awscdk.services.iot

Interface CfnTopicRule.CloudwatchAlarmActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.CloudwatchAlarmActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(Stable)
public static interface CfnTopicRule.CloudwatchAlarmActionProperty
extends software.amazon.jsii.JsiiSerializable

Describes an action that updates a CloudWatch alarm.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 CloudwatchAlarmActionProperty cloudwatchAlarmActionProperty = CloudwatchAlarmActionProperty.builder()
         .alarmName("alarmName")
         .roleArn("roleArn")
         .stateReason("stateReason")
         .stateValue("stateValue")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicRule.CloudwatchAlarmActionProperty.Builder	builder()
String	getAlarmName()	The CloudWatch alarm name.
String	getRoleArn()	The IAM role that allows access to the CloudWatch alarm.
String	getStateReason()	The reason for the alarm change.
String	getStateValue()	The value of the alarm state.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlarmName

@Stability(Stable)
@NotNull
String getAlarmName()

The CloudWatch alarm name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-alarmname

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The IAM role that allows access to the CloudWatch alarm.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-rolearn

getStateReason

@Stability(Stable)
@NotNull
String getStateReason()

The reason for the alarm change.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-statereason

getStateValue

@Stability(Stable)
@NotNull
String getStateValue()

The value of the alarm state.

Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-statevalue

builder

@Stability(Stable)
static CfnTopicRule.CloudwatchAlarmActionProperty.Builder builder()

Returns:

a CfnTopicRule.CloudwatchAlarmActionProperty.Builder of CfnTopicRule.CloudwatchAlarmActionProperty