Skip to content

GroupProps

Properties for defining a Group.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-rocketmq-group

Initializer

import { GroupProps } from '@alicloud/ros-cdk-rocketmq'
const groupProps: GroupProps = { ... }

Properties

Name Type Description
groupId string | @alicloud/ros-cdk-core.IResolvable Property groupId: The group ID of the consumption cluster.
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: The ID of the instance.
groupType string | @alicloud/ros-cdk-core.IResolvable Property groupType: Group ID specify the creation of applicable agreements.
remark string | @alicloud/ros-cdk-core.IResolvable Property remark: The remarks on the request.

groupIdRequired

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

Property groupId: The group ID of the consumption cluster.

When creating a group ID, pay attention to the following aspects: A group ID starts with"GID_" or "GID-", and contains letters, numbers, hyphens (-), and underscores (_). A group ID ranges from 7 to 64 bytes. Once a group ID is created, it cannot be edited anymore.


instanceIdRequired

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

Property instanceId: The ID of the instance.


groupTypeOptional

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

Property groupType: Group ID specify the creation of applicable agreements.

Group ID TCP protocol and the HTTP protocol can not be shared, the need to create separately. Value as follows: tcp: Default, indicates Group ID is created only for the TCP protocol messaging. http: represents the Group ID was created only for the HTTP protocol messaging.


remarkOptional

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

Property remark: The remarks on the request.