AWS::IoT::TopicRule TopicRulePayload - 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 TopicRulePayload

Describes a rule.

Syntax

To declare this entity in your CloudFormation template, use the following 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

Minimum: 0

Maximum: 10

Update requires: No interruption

AwsIotSqlVersion

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

The default value is 2015-10-08.

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: No

Type: Boolean

Update requires: No interruption

Sql

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.

Required: Yes

Type: String

Update requires: No interruption