Package software.amazon.awscdk.mixins.preview.services.iot.mixins

Interface CfnTopicRulePropsMixin.CloudwatchAlarmActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRulePropsMixin.CloudwatchAlarmActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRulePropsMixin

@Stability(Stable)
public static interface CfnTopicRulePropsMixin.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.mixins.preview.services.iot.mixins.*;
 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	CfnTopicRulePropsMixin.CloudwatchAlarmActionProperty.Builder	A builder for CfnTopicRulePropsMixin.CloudwatchAlarmActionProperty
static final class	CfnTopicRulePropsMixin.CloudwatchAlarmActionProperty.Jsii$Proxy	An implementation for CfnTopicRulePropsMixin.CloudwatchAlarmActionProperty

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlarmName

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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 CfnTopicRulePropsMixin.CloudwatchAlarmActionProperty.Builder builder()

Returns:

a CfnTopicRulePropsMixin.CloudwatchAlarmActionProperty.Builder of CfnTopicRulePropsMixin.CloudwatchAlarmActionProperty