Skip to content

ConsumerGroupProps

Properties for defining a ConsumerGroup.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-consumergroup

Initializer 

import ros_cdk_kafka
ros_cdk_kafka.ConsumerGroupProps(
  consumer_id: typing.Union[str, IResolvable],
  instance_id: typing.Union[str, IResolvable],
  remark: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None
)

Properties

Name Type Description
consumer_id typing.Union[str, ros_cdk_core.IResolvable] Property consumerId: Group name.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: Kafka instance id.
remark typing.Union[str, ros_cdk_core.IResolvable] Property remark: Remark description.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.

consumer_idRequired 

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

Property consumerId: Group name.

Value: Can only contain letters, numbers, dashes (-), underscores (_), and at least one English or number. The length is limited to 3 to 128 characters, and more than 128 characters will be automatically intercepted. Once the group name is created, it cannot be modified.

instance_idRequired 

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

Property instanceId: Kafka instance id.

remarkOptional 

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

Property remark: Remark description.

tagsOptional 

tags: typing.List[TagsProperty]

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.