Skip to content

ProductTopicProps

Properties for defining a ProductTopic.

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

Initializer 

import ros_cdk_iot
ros_cdk_iot.ProductTopicProps(
  operation: typing.Union[str, IResolvable],
  product_key: typing.Union[str, IResolvable],
  topic_short_name: typing.Union[str, IResolvable],
  desc: typing.Union[str, IResolvable] = None,
  iot_instance_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
operation typing.Union[str, ros_cdk_core.IResolvable] Property operation: Operation permissions of devices on the topic category.
product_key typing.Union[str, ros_cdk_core.IResolvable] Property productKey: The unique identifier of the product for which you want to create a topic category.
topic_short_name typing.Union[str, ros_cdk_core.IResolvable] Property topicShortName: The custom category hierarchy in the topic category.
desc typing.Union[str, ros_cdk_core.IResolvable] Property desc: The description of the topic category.
iot_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property iotInstanceId: Instance ID you purchased.

operationRequired 

operation: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property operation: Operation permissions of devices on the topic category.

Value options: SUB: Subscribe. Devices can subscribe to the topics of this category. PUB: Publish. Devices can publish messages using the topics of this category. ALL: Subscribe and publish. Devices can subscribe to and publish messages to the topics of this category.

product_keyRequired 

product_key: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property productKey: The unique identifier of the product for which you want to create a topic category.

topic_short_nameRequired 

topic_short_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property topicShortName: The custom category hierarchy in the topic category.

By default, a topic category contains two system defined category hierarchies: productKey and ${deviceName}. Forward slashes (/) are used to delimit the topic hierarchies. The format of a topic category is productKey/${deviceName}/topicShortName. Note The name of each category hierarchy can contain English letters, digits, and underscores (_), and cannot be empty.

descOptional 

desc: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property desc: The description of the topic category.

You can enter a description with up to 100 characters.

iot_instance_idOptional 

iot_instance_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property iotInstanceId: Instance ID you purchased.

Public instances do not need pass this property.