Topic

This class encapsulates and extends the ROS resource type ALIYUN::ROCKETMQ::Topic, which is used to create a topic.

Initializers

import ros_cdk_rocketmq
ros_cdk_rocketmq.Topic(
  scope: Construct,
  id: str,
  instance_id: typing.Union[str, IResolvable],
  message_type: typing.Union[typing.Union[int, float], IResolvable],
  topic: typing.Union[str, IResolvable],
  remark: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
instance_id	typing.Union[str, ros_cdk_core.IResolvable]	Property instanceId: The ID of the instance.
message_type	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property messageType: The type of the message.
topic	typing.Union[str, ros_cdk_core.IResolvable]	Property topic: The name of the topic you want to create.
remark	typing.Union[str, ros_cdk_core.IResolvable]	Property remark: The remarks on the request.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

instance_id^Required

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

Property instanceId: The ID of the instance.

---

message_type^Required

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

Property messageType: The type of the message.

Valid values: 0: normal message 1: partitionally ordered message 2: globally ordered message 4: transactional message 5: scheduled/delayed message

---

topic^Required

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

Property topic: The name of the topic you want to create.

Note: "CID" and "GID" are the reserved fields of a group ID, and they cannot be the start of a topic name. If namespaces are available in the instance for which the topic is created, the topic name must be unique in the instance and can be duplicated across instances. If no namespaces are available in the instance, the topic name must be unique both in the instance and across instances.

---

remark^Optional

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

Property remark: The remarks on the request.

This parameter can be left blank.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

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

---

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

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_rocketmq
ros_cdk_rocketmq.Topic.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_instance_id	ros_cdk_core.IResolvable	Attribute InstanceId: The ID of the instance.
attr_message_type	ros_cdk_core.IResolvable	Attribute MessageType: The type of the message.
attr_topic	ros_cdk_core.IResolvable	Attribute Topic: The name of the topic.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_instance_id^Required

attr_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the instance.

---

attr_message_type^Required

attr_message_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute MessageType: The type of the message.

---

attr_topic^Required

attr_topic: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Topic: The name of the topic.

---