interface CloudwatchAlarmActionProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IoT.Mixins.CfnTopicRulePropsMixin.CloudwatchAlarmActionProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiot/mixins#CfnTopicRulePropsMixin_CloudwatchAlarmActionProperty
Java	software.amazon.awscdk.mixins.preview.services.iot.mixins.CfnTopicRulePropsMixin.CloudwatchAlarmActionProperty
Python	aws_cdk.mixins_preview.aws_iot.mixins.CfnTopicRulePropsMixin.CloudwatchAlarmActionProperty
TypeScript	@aws-cdk/mixins-preview » aws_iot » mixins » CfnTopicRulePropsMixin » CloudwatchAlarmActionProperty

Describes an action that updates a CloudWatch alarm.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as iot_mixins } from '@aws-cdk/mixins-preview/aws-iot';
const cloudwatchAlarmActionProperty: iot_mixins.CfnTopicRulePropsMixin.CloudwatchAlarmActionProperty = {
  alarmName: 'alarmName',
  roleArn: 'roleArn',
  stateReason: 'stateReason',
  stateValue: 'stateValue',
};

Properties

Name	Type	Description
alarmName?	string	The CloudWatch alarm name.
roleArn?	string	The IAM role that allows access to the CloudWatch alarm.
stateReason?	string	The reason for the alarm change.
stateValue?	string	The value of the alarm state.

---

alarmName?

Type: string (optional)

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

---

roleArn?

Type: string (optional)

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

---

stateReason?

Type: string (optional)

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

---

stateValue?

Type: string (optional)

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