Skip to content

RuleProps

Properties for defining a Rule.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-iot-rule

Initializer 

import { RuleProps } from '@alicloud/ros-cdk-iot'
const ruleProps: RuleProps = { ... }

Properties

Name Type Description
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the rule.
dataType string | @alicloud/ros-cdk-core.IResolvable Property dataType: The format of the data to be processed by the rule.
iotInstanceId string | @alicloud/ros-cdk-core.IResolvable Property iotInstanceId: The ID of the instance.
productKey string | @alicloud/ros-cdk-core.IResolvable Property productKey: The ProductKey of the product to which the rule applies.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group to which the rule is assigned.
ruleAction @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | RuleActionProperty[] Property ruleAction:.
ruleDesc string | @alicloud/ros-cdk-core.IResolvable Property ruleDesc: The description of the rule.
select string | @alicloud/ros-cdk-core.IResolvable Property select: The SQL SELECT statement that you want to execute.
shortTopic string | @alicloud/ros-cdk-core.IResolvable Property shortTopic: The topic to which this rule is applied.
startRule boolean | @alicloud/ros-cdk-core.IResolvable Property startRule: Start the rule.
topicType number | @alicloud/ros-cdk-core.IResolvable Property topicType: 0: The topic is a basic communication topic or TSL-based communication topic.
where string | @alicloud/ros-cdk-core.IResolvable Property where: The condition that is used to trigger the rule.

nameRequired 

public readonly name: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property name: The name of the rule.

The name must be 1 to 30 characters in length and can contain English letters, digits, underscores (_), and hyphens (-). Chinese language is also supported. Each Chinese symbol occupies 2 characters.

dataTypeOptional 

public readonly dataType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dataType: The format of the data to be processed by the rule.

You must specify the format of device data to be processed for this parameter. Valid values: JSON: JSON data BINARY: binary data Note If you specifyBINARY, you cannot set the TopicType parameter to 0 and forward data to Table Store, Time Series Database (TSDB), or ApsaradDB for RDS. Default value: JSON.

iotInstanceIdOptional 

public readonly iotInstanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property iotInstanceId: The ID of the instance.

This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased.

productKeyOptional 

public readonly productKey: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property productKey: The ProductKey of the product to which the rule applies.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group to which the rule is assigned.

You can view the resource group information in the Resource Management console. If you do not specify this parameter, the rule is assigned to the default resource group.

ruleActionOptional 

public readonly ruleAction: IResolvable | IResolvable | RuleActionProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | RuleActionProperty[]

Property ruleAction:.

ruleDescOptional 

public readonly ruleDesc: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property ruleDesc: The description of the rule.

The description can be up to 100 characters in length. Each Chinese symbol occupies 1 characters.

selectOptional 

public readonly select: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property select: The SQL SELECT statement that you want to execute.

For more information, seeSQL expressions. Note Specify the fields that follow the Select keyword for this parameter. For example, if the Select statement is Select a,b,c, specify a,b,c for this parameter.

shortTopicOptional 

public readonly shortTopic: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property shortTopic: The topic to which this rule is applied.

Syntax: ${deviceName}\/topicShortName. ${deviceName}specifies the name of the device, and topicShortNamespecifies the custom name of the topic. Basic communication topics or Thing Specification Language (TSL)-based communication topics. Syntax: ${deviceName}\/topicShortName. You can replace ${deviceName} with the + wildcard. The wildcard indicates that the topic applies to all devices under the product. Valid values of topicShortName: \/thing\/event\/property\/post: submits the property data of a device. \/thing\/event\/${tsl.event.identifier}\/post: submits the event data of a device.${tsl.event.identifier} specifies the identifier of an event in the TSL. \/thing\/lifecycle: submits device lifecycle changes. \/thing\/downlink\/reply\/message: sends a response to a request from IoT Platform. \/thing\/list\/found: submits the data when a gateway detects a new sub-device. \/thing\/topo\/lifecycle: submits device topology changes. \/thing\/event\/property\/history\/post: submits historical property data of a device. \/thing\/event\/${tsl.event.identifier}\/post: submits the historical event data of a device.${tsl.event.identifier}specifies the identifier of an event in the TSL. \/ota\/upgrade: submits OTA update status. \/ota\/version\/post: submits OTA module versions. \/thing\/deviceinfo\/update: submits device tag changes. \/edge\/driver\/${driver_id}\/point_post: submits pass-through data from Link IoT Edge.${driver_id} specifies the ID of the driver that a device uses to access Link IoT Edge. ${packageId}\/${jobId}\/ota\/job\/status: submits the status of OTA update batches. This topic is a basic communication topic. ${packageId}specifies the ID of the firmware. ${jobId}specifies the ID of the update batch. Custom topics. Example:${deviceName}\/user\/get. You can call theQueryProductTopicoperation to view all custom topics of the product. When you specify a custom topic, you can use the + and # wildcards. You can replace ${deviceName} with the+ wildcard. The wildcard indicates that the topic applies to all devices under the product. You can replace the fields that follow ${deviceName} with \/user\/#. The # wildcard indicates that the topic applies whatever values are specified for the fields that follow\/user. For more information about how to use wildcards, see Wildcards in topics. Topic that is used to submit device status changes: ${deviceName}. You can use the+wildcard. In this case, the status changes of all devices under the product are submitted.

startRuleOptional 

public readonly startRule: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property startRule: Start the rule.

The rule at least contains one rule action with normal data forward.

topicTypeOptional 

public readonly topicType: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property topicType: 0: The topic is a basic communication topic or TSL-based communication topic.

1: The topic is a custom topic. 2: The topic is used to submit device status changes. Syntax: \/as\/mqtt\/status\/${productKey}\/${deviceName}.

whereOptional 

public readonly where: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property where: The condition that is used to trigger the rule.

For more information, seeSQL expressions. Note Specify the fields that follow theWherekeyword for this parameter. For example, if the Where statement is Where a>10, specify a>10 for this parameter.