Topic

This class encapsulates and extends the ROS resource type DATASOURCE::KAFKA::Topic, which is used to query the information about a topic.

Initializers

from ros_cdk_kafka import datasource
datasource.Topic(
  scope: Construct,
  id: str,
  instance_id: typing.Union[str, IResolvable],
  topic: typing.Union[str, IResolvable],
  refresh_options: 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: Resource id.
topic	typing.Union[str, ros_cdk_core.IResolvable]	Property topic: Topic Name.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
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: Resource id.

---

topic^Required

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

Property topic: Topic Name.

---

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

---

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

from ros_cdk_kafka import datasource
datasource.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_compact_topic	ros_cdk_core.IResolvable	Attribute CompactTopic: Can log merge.
attr_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: Creation time.
attr_instance_id	ros_cdk_core.IResolvable	Attribute InstanceId: Resource id.
attr_local_topic	ros_cdk_core.IResolvable	Attribute LocalTopic: Whether to store locally.
attr_partition_num	ros_cdk_core.IResolvable	Attribute PartitionNum: Number of partitions.
attr_remark	ros_cdk_core.IResolvable	Attribute Remark: Remarks.
attr_status_name	ros_cdk_core.IResolvable	Attribute StatusName: Meaning of status value.
attr_tags	ros_cdk_core.IResolvable	Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption.
attr_topic	ros_cdk_core.IResolvable	Attribute Topic: Topic Name.
attr_topic_status	ros_cdk_core.IResolvable	Attribute TopicStatus: The Topic status.

---

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

attr_compact_topic: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CompactTopic: Can log merge.

---

attr_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: Creation time.

---

attr_instance_id^Required

attr_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceId: Resource id.

---

attr_local_topic^Required

attr_local_topic: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute LocalTopic: Whether to store locally.

---

attr_partition_num^Required

attr_partition_num: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PartitionNum: Number of partitions.

---

attr_remark^Required

attr_remark: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Remark: Remarks.

---

attr_status_name^Required

attr_status_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute StatusName: Meaning of status value.

---

attr_tags^Required

attr_tags: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption.

---

attr_topic^Required

attr_topic: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Topic: Topic Name.

---

attr_topic_status^Required

attr_topic_status: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute TopicStatus: The Topic status.

---