interface TopicRulePayloadProperty

Language	Type name
.NET	Amazon.CDK.AWS.IoT.CfnTopicRule.TopicRulePayloadProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnTopicRule_TopicRulePayloadProperty
Java	software.amazon.awscdk.services.iot.CfnTopicRule.TopicRulePayloadProperty
Python	aws_cdk.aws_iot.CfnTopicRule.TopicRulePayloadProperty
TypeScript	aws-cdk-lib » aws_iot » CfnTopicRule » TopicRulePayloadProperty

Describes a rule.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html

Example

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

Properties

Name	Type	Description
actions	IResolvable | (IResolvable | ActionProperty)[]	The actions associated with the rule.
sql	string	The SQL statement used to query the topic.
awsIotSqlVersion?	string	The version of the SQL rules engine to use when evaluating the rule.
description?	string	The description of the rule.
errorAction?	IResolvable | ActionProperty	The action to take when an error occurs.
ruleDisabled?	boolean | IResolvable	Specifies whether the rule is disabled.

---

actions

Type: IResolvable | (IResolvable | ActionProperty)[]

The actions associated with the rule.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-actions

---

sql

Type: string

The SQL statement used to query the topic.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-sql

---

awsIotSqlVersion?

Type: string (optional)

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

The default value is 2015-10-08.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-awsiotsqlversion

---

description?

Type: string (optional)

The description of the rule.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-description

---

errorAction?

Type: IResolvable | ActionProperty (optional)

The action to take when an error occurs.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-erroraction

---

ruleDisabled?

Type: boolean | IResolvable (optional)

Specifies whether the rule is disabled.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-ruledisabled