AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS IoT Resource Types Reference » AWS::IoT::TopicRule » AWS IoT TopicRule TopicRulePayload

Filter View: All JSON YAML

AWS IoT TopicRule TopicRulePayload

TopicRulePayload is a property of the AWS::IoT::TopicRule resource that describes the payload of an AWS IoT rule.

Syntax

JSON

{
  "Actions": [ Action, ... ],
  "AwsIotSqlVersion": String,
  "Description": String,
  "ErrorAction": Action,
  "RuleDisabled": Boolean,
  "Sql": String
}

YAML

Actions:
  - Action
  - ...
AwsIotSqlVersion: String
Description: String
ErrorAction:
  Action
RuleDisabled: Boolean
Sql: String

Properties

Actions

The actions associated with the rule.

Required: Yes

Type: Array of Action objects

Update requires: No interruption

AwsIotSqlVersion

The version of the SQL rules engine to use when evaluating the rule.

Required: No

Type: String

Update requires: No interruption

Description

The description of the rule.

Required: No

Type: String

Update requires: No interruption

ErrorAction

The action to take when an error occurs.

Required: No

Type: Action

Update requires: No interruption

RuleDisabled

Specifies whether the rule is disabled.

Required: Yes

Type: Boolean

Update requires: No interruption

Sql

The SQL statement that queries the topic. For more information, see Rules for AWS IoT in the AWS IoT Developer Guide.

Required: Yes

Type: String

Update requires: No interruption