Skip to content
v2.274.0

TopicRulePayloadProperty Struct ​

Describes a rule.

Example ​

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

Properties ​

actionsIResolvable | IResolvable | CfnTopicRule.ActionProperty[]actionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ActionProperty]]]actionsIResolvableActionsIResolvableActionsinterface{}required#
The actions associated with the rule.
awsIotSqlVersionoptionalstringaws_iot_sql_versionoptionalstrawsIotSqlVersionoptionalStringAwsIotSqlVersionoptionalstringAwsIotSqlVersionoptional*string#
The version of the SQL rules engine to use when evaluating the rule.

The default value is 2015-10-08.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the rule.
errorActionoptionalIResolvable | CfnTopicRule.ActionPropertyerror_actionoptionaltyping.Union[IResolvable, ActionProperty]errorActionoptionalIResolvableErrorActionoptionalIResolvableErrorActionoptionalinterface{}#
The action to take when an error occurs.
ruleDisabledoptionalboolean | IResolvablerule_disabledoptionaltyping.Union[bool, IResolvable]ruleDisabledoptionalBooleanRuleDisabledoptionalboolRuleDisabledoptionalinterface{}#
Specifies whether the rule is disabled.
sqlstringsqlstrsqlStringSqlstringSql*stringrequired#
The SQL statement used to query the topic.

For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .