Skip to content

ConsumerGroupProps

Properties for defining a ConsumerGroup.

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

Initializer 

import { ConsumerGroupProps } from '@alicloud/ros-cdk-kafka'
const consumerGroupProps: ConsumerGroupProps = { ... }

Properties

Name Type Description
consumerId string | @alicloud/ros-cdk-core.IResolvable Property consumerId: Group name.
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: Kafka instance id.
remark string | @alicloud/ros-cdk-core.IResolvable Property remark: Remark description.
tags TagsProperty[] Property tags: Tags to attach to instance.

consumerIdRequired 

public readonly consumerId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property consumerId: Group name.

Reserved instance: Supports uppercase and lowercase letters, numbers, underscores (), hyphens (-), and periods (.), limited to 3-64 characters. - Serverless instance: Can only contain letters, numbers, and special characters "@.*$#^!&-", limited to 1-249 characters.

instanceIdRequired 

public readonly instanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceId: Kafka instance id.

remarkOptional 

public readonly remark: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property remark: Remark description.

tagsOptional 

public readonly tags: 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.