Skip to content

Topic

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

Initializers 

import ros_cdk_kafka
ros_cdk_kafka.Topic(
  scope: Construct,
  id: str,
  instance_id: typing.Union[str, IResolvable],
  remark: typing.Union[str, IResolvable],
  topic: typing.Union[str, IResolvable],
  compact_topic: typing.Union[bool, IResolvable] = None,
  config: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  local_topic: typing.Union[bool, IResolvable] = None,
  min_insync_replicas: typing.Union[typing.Union[int, float], IResolvable] = None,
  partition_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  replication_factor: typing.Union[typing.Union[int, float], IResolvable] = None,
  tags: typing.List[TagsProperty] = 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 Message Queue for Apache Kafka instance where the topic is located.
remark typing.Union[str, ros_cdk_core.IResolvable] Property remark: The description of the topic.
topic typing.Union[str, ros_cdk_core.IResolvable] Property topic: The name of the topic.
compact_topic typing.Union[bool, ros_cdk_core.IResolvable] Property compactTopic: The log cleanup policy for the topic.
config typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property config: Supplementary configuration.
local_topic typing.Union[bool, ros_cdk_core.IResolvable] Property localTopic: The storage engine of the topic.
min_insync_replicas typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property minInsyncReplicas: The minimum number of ISR sync replicas.
partition_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property partitionNum: The number of partitions in the topic.
replication_factor typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property replicationFactor: The number of copies of the topic.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

instance_idRequired

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

Property instanceId: The ID of the Message Queue for Apache Kafka instance where the topic is located.

You can call the GetInstanceList operation to query instances.

remarkRequired

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

Property remark: The description of the topic.

The value of this parameter must meet the following requirements: The value can only contain letters, digits, hyphens (-), and underscores (_). The value must be 3 to 64 characters in length.

topicRequired

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

Property topic: The name of the topic.

The value of this parameter must meet the following requirements: The name can only contain letters, digits, hyphens (-), and underscores (_). The name must be 3 to 64 characters in length, and will be automatically truncated if it contains more characters. The name cannot be modified after being created.

compact_topicOptional

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

Property compactTopic: The log cleanup policy for the topic.

This parameter is available when the Local Storage mode is specified for the topic. Valid values: false: uses the default log cleanup policy. true: uses the Apache Kafka log compaction policy.

configOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property config: Supplementary configuration.

Currently supports Key as replications. Indicates the number of Topic copies, the value type is Integer, and the value limit is 1~3. This parameter can only be specified if the LocalTopic value is true. NOTE If replications is specified in this parameter, the specified ReplicationFactor parameter no longer takes effect.

local_topicOptional

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

Property localTopic: The storage engine of the topic.

Valid values: false: the Cloud Storage mode. true: the Local Storage mode.

min_insync_replicasOptional

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

Property minInsyncReplicas: The minimum number of ISR sync replicas.

This parameter can only be specified if the LocalTopic value is true. The value must be less than the number of Topic copies. The number of synchronous replicas is limited to 1~3.

partition_numOptional

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

Property partitionNum: The number of partitions in the topic.

Valid values: 1 to 48 We recommend that you set the number of partitions to a multiple of 6 to reduce the risk of data skew.Note:For special requirements,submit a ticket.

replication_factorOptional

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

Property replicationFactor: The number of copies of the topic.

This parameter can only be specified if the LocalTopic value is true. The number of copies is limited to 1~3. Note When the number of replicas is 1, there is a risk of data loss. Please set it carefully.

tagsOptional

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

enable_resource_property_constraintOptional

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

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • 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 Message Queue for Apache Kafka instance where the topic is located.
attr_topic ros_cdk_core.IResolvable Attribute Topic: Topic name.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the Message Queue for Apache Kafka instance where the topic is located.

You can call the GetInstanceList operation to query instances.

attr_topicRequired 

attr_topic: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Topic: Topic name.