ProductTopic

• Implements: IProductTopic

This class encapsulates and extends the ROS resource type ALIYUN::IOT::ProductTopic.

Initializers

import ros_cdk_iot
ros_cdk_iot.ProductTopic(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

operation^Required

• 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_key^Required

• 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_name^Required

• 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.

desc^Optional

• 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_id^Optional

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

Property iotInstanceId: Instance ID you purchased.

Public instances do not need pass this property.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_iot
ros_cdk_iot.ProductTopic.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_topic_id^Required

attr_topic_id: typing.Union[str, IResolvable]

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

Attribute TopicId: Topic ID.

props^Required

props: ProductTopicProps

• Type: ProductTopicProps