# TopicRulePayloadProperty

Describes a rule.

- Source: Generated code
- Type last changed: v2.93.0 · 23 Aug 2023

## Example

```ts
// The generated example for this type would exceed 500 lines,
// and has been elided for readability.
```

## Properties

- `actions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnTopicRule.ActionProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_iot.CfnTopicRule.ActionProperty.html)[] (required) — The actions associated with the rule.

- `awsIotSqlVersion`: string — The version of the SQL rules engine to use when evaluating the rule.

  The default value is 2015-10-08.

- `description`: string — The description of the rule.

- `errorAction`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnTopicRule.ActionProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_iot.CfnTopicRule.ActionProperty.html) — The action to take when an error occurs.

- `ruleDisabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Specifies whether the rule is disabled.

- `sql`: string (required) — The SQL statement used to query the topic.

  For more information, see [AWS IoT SQL Reference](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html) in the *AWS IoT Developer Guide* .