AWS::IoT::TopicRule CloudwatchAlarmAction - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::IoT::TopicRule CloudwatchAlarmAction

Describes an action that updates a CloudWatch alarm.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "AlarmName" : String,
  "RoleArn" : String,
  "StateReason" : String,
  "StateValue" : String
}

YAML

  AlarmName: String
  RoleArn: String
  StateReason: String
  StateValue: String

Properties

AlarmName

The CloudWatch alarm name.

Required: Yes

Type: String

Update requires: No interruption

RoleArn

The IAM role that allows access to the CloudWatch alarm.

Required: Yes

Type: String

Update requires: No interruption

StateReason

The reason for the alarm change.

Required: Yes

Type: String

Update requires: No interruption

StateValue

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

Required: Yes

Type: String

Update requires: No interruption