1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. rocketmq
  6. Group
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.rocketmq.Group

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Group, also known as Consumer Group, is a collection of consumers with similar consumption behavior, used to categorize and manage different consumers. Each consumer group consumes different types of messages. Within each consumer group, the logic for publishing or subscribing to messages is consistent. In RocketMQ Message Queue, you need to create a Group and use the Group ID to identify different types of producers or consumers.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const rocketMQGroupDemo = new volcenginecc.rocketmq.Group("RocketMQGroupDemo", {
    instanceId: "rocketmq-cnnxxxxxc2d",
    groupId: "ccapi-test-test-1",
    consumeMessageOrderly: true,
    description: "test",
    groupType: "TCP",
    retryMaxTimes: 2,
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

rocket_mq_group_demo = volcenginecc.rocketmq.Group("RocketMQGroupDemo",
    instance_id="rocketmq-cnnxxxxxc2d",
    group_id="ccapi-test-test-1",
    consume_message_orderly=True,
    description="test",
    group_type="TCP",
    retry_max_times=2)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rocketmq"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rocketmq.NewGroup(ctx, "RocketMQGroupDemo", &rocketmq.GroupArgs{
			InstanceId:            pulumi.String("rocketmq-cnnxxxxxc2d"),
			GroupId:               pulumi.String("ccapi-test-test-1"),
			ConsumeMessageOrderly: pulumi.Bool(true),
			Description:           pulumi.String("test"),
			GroupType:             pulumi.String("TCP"),
			RetryMaxTimes:         pulumi.Int(2),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var rocketMQGroupDemo = new Volcenginecc.Rocketmq.Group("RocketMQGroupDemo", new()
    {
        InstanceId = "rocketmq-cnnxxxxxc2d",
        GroupId = "ccapi-test-test-1",
        ConsumeMessageOrderly = true,
        Description = "test",
        GroupType = "TCP",
        RetryMaxTimes = 2,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.rocketmq.Group;
import com.volcengine.volcenginecc.rocketmq.GroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var rocketMQGroupDemo = new Group("rocketMQGroupDemo", GroupArgs.builder()
            .instanceId("rocketmq-cnnxxxxxc2d")
            .groupId("ccapi-test-test-1")
            .consumeMessageOrderly(true)
            .description("test")
            .groupType("TCP")
            .retryMaxTimes(2)
            .build());

    }
}

    resources:
  rocketMQGroupDemo:
    type: volcenginecc:rocketmq:Group
    name: RocketMQGroupDemo
    properties:
      instanceId: rocketmq-cnnxxxxxc2d
      groupId: ccapi-test-test-1
      consumeMessageOrderly: true
      description: test
      groupType: TCP
      retryMaxTimes: 2

    Create Group Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
    @overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          group_id: Optional[str] = None,
          group_type: Optional[str] = None,
          instance_id: Optional[str] = None,
          consume_message_orderly: Optional[bool] = None,
          description: Optional[str] = None,
          retry_max_times: Optional[int] = None)
    func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

    type: volcenginecc:rocketmq:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Group Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Group resource accepts the following input properties:

    GroupId string
    Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
    GroupType string
    Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
    InstanceId string
    Instance ID.
    ConsumeMessageOrderly bool
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    Description string
    Brief description of the Group.
    RetryMaxTimes int
    Maximum number of consumption retries.
    GroupId string
    Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
    GroupType string
    Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
    InstanceId string
    Instance ID.
    ConsumeMessageOrderly bool
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    Description string
    Brief description of the Group.
    RetryMaxTimes int
    Maximum number of consumption retries.
    groupId String
    Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
    groupType String
    Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
    instanceId String
    Instance ID.
    consumeMessageOrderly Boolean
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    description String
    Brief description of the Group.
    retryMaxTimes Integer
    Maximum number of consumption retries.
    groupId string
    Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
    groupType string
    Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
    instanceId string
    Instance ID.
    consumeMessageOrderly boolean
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    description string
    Brief description of the Group.
    retryMaxTimes number
    Maximum number of consumption retries.
    group_id str
    Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
    group_type str
    Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
    instance_id str
    Instance ID.
    consume_message_orderly bool
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    description str
    Brief description of the Group.
    retry_max_times int
    Maximum number of consumption retries.
    groupId String
    Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
    groupType String
    Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
    instanceId String
    Instance ID.
    consumeMessageOrderly Boolean
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    description String
    Brief description of the Group.
    retryMaxTimes Number
    Maximum number of consumption retries.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

    ConsumedClients List<Volcengine.GroupConsumedClient>
    ConsumedTopics List<Volcengine.GroupConsumedTopic>
    CreatedTime string
    Group creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsSubSame bool
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    LastUpdateTimestamp string
    Whether consumption is sequential.
    MessageDelayTime string
    Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
    MessageModel string
    Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
    RocketmqVersion string
    RocketMQ version.
    ServiceStatus string
    Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
    Status string
    Consumer group status. Online: Consuming, Offline: Not consuming.
    TotalConsumedRate string
    Total TPS of consumer instance groups under this Group, measured in messages per second.
    TotalDiff int
    Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.
    ConsumedClients []GroupConsumedClient
    ConsumedTopics []GroupConsumedTopic
    CreatedTime string
    Group creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsSubSame bool
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    LastUpdateTimestamp string
    Whether consumption is sequential.
    MessageDelayTime string
    Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
    MessageModel string
    Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
    RocketmqVersion string
    RocketMQ version.
    ServiceStatus string
    Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
    Status string
    Consumer group status. Online: Consuming, Offline: Not consuming.
    TotalConsumedRate string
    Total TPS of consumer instance groups under this Group, measured in messages per second.
    TotalDiff int
    Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.
    consumedClients List<GroupConsumedClient>
    consumedTopics List<GroupConsumedTopic>
    createdTime String
    Group creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    isSubSame Boolean
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    lastUpdateTimestamp String
    Whether consumption is sequential.
    messageDelayTime String
    Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
    messageModel String
    Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
    rocketmqVersion String
    RocketMQ version.
    serviceStatus String
    Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
    status String
    Consumer group status. Online: Consuming, Offline: Not consuming.
    totalConsumedRate String
    Total TPS of consumer instance groups under this Group, measured in messages per second.
    totalDiff Integer
    Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.
    consumedClients GroupConsumedClient[]
    consumedTopics GroupConsumedTopic[]
    createdTime string
    Group creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    isSubSame boolean
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    lastUpdateTimestamp string
    Whether consumption is sequential.
    messageDelayTime string
    Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
    messageModel string
    Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
    rocketmqVersion string
    RocketMQ version.
    serviceStatus string
    Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
    status string
    Consumer group status. Online: Consuming, Offline: Not consuming.
    totalConsumedRate string
    Total TPS of consumer instance groups under this Group, measured in messages per second.
    totalDiff number
    Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.
    consumed_clients Sequence[GroupConsumedClient]
    consumed_topics Sequence[GroupConsumedTopic]
    created_time str
    Group creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    is_sub_same bool
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    last_update_timestamp str
    Whether consumption is sequential.
    message_delay_time str
    Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
    message_model str
    Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
    rocketmq_version str
    RocketMQ version.
    service_status str
    Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
    status str
    Consumer group status. Online: Consuming, Offline: Not consuming.
    total_consumed_rate str
    Total TPS of consumer instance groups under this Group, measured in messages per second.
    total_diff int
    Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.
    consumedClients List<Property Map>
    consumedTopics List<Property Map>
    createdTime String
    Group creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    isSubSame Boolean
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    lastUpdateTimestamp String
    Whether consumption is sequential.
    messageDelayTime String
    Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
    messageModel String
    Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
    rocketmqVersion String
    RocketMQ version.
    serviceStatus String
    Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
    status String
    Consumer group status. Online: Consuming, Offline: Not consuming.
    totalConsumedRate String
    Total TPS of consumer instance groups under this Group, measured in messages per second.
    totalDiff Number
    Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.

    Look up Existing Group Resource

    Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        consume_message_orderly: Optional[bool] = None,
        consumed_clients: Optional[Sequence[GroupConsumedClientArgs]] = None,
        consumed_topics: Optional[Sequence[GroupConsumedTopicArgs]] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        group_id: Optional[str] = None,
        group_type: Optional[str] = None,
        instance_id: Optional[str] = None,
        is_sub_same: Optional[bool] = None,
        last_update_timestamp: Optional[str] = None,
        message_delay_time: Optional[str] = None,
        message_model: Optional[str] = None,
        retry_max_times: Optional[int] = None,
        rocketmq_version: Optional[str] = None,
        service_status: Optional[str] = None,
        status: Optional[str] = None,
        total_consumed_rate: Optional[str] = None,
        total_diff: Optional[int] = None) -> Group
    func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
    public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
    public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:rocketmq:Group    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ConsumeMessageOrderly bool
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    ConsumedClients List<Volcengine.GroupConsumedClient>
    ConsumedTopics List<Volcengine.GroupConsumedTopic>
    CreatedTime string
    Group creation time.
    Description string
    Brief description of the Group.
    GroupId string
    Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
    GroupType string
    Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
    InstanceId string
    Instance ID.
    IsSubSame bool
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    LastUpdateTimestamp string
    Whether consumption is sequential.
    MessageDelayTime string
    Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
    MessageModel string
    Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
    RetryMaxTimes int
    Maximum number of consumption retries.
    RocketmqVersion string
    RocketMQ version.
    ServiceStatus string
    Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
    Status string
    Consumer group status. Online: Consuming, Offline: Not consuming.
    TotalConsumedRate string
    Total TPS of consumer instance groups under this Group, measured in messages per second.
    TotalDiff int
    Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.
    ConsumeMessageOrderly bool
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    ConsumedClients []GroupConsumedClientArgs
    ConsumedTopics []GroupConsumedTopicArgs
    CreatedTime string
    Group creation time.
    Description string
    Brief description of the Group.
    GroupId string
    Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
    GroupType string
    Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
    InstanceId string
    Instance ID.
    IsSubSame bool
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    LastUpdateTimestamp string
    Whether consumption is sequential.
    MessageDelayTime string
    Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
    MessageModel string
    Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
    RetryMaxTimes int
    Maximum number of consumption retries.
    RocketmqVersion string
    RocketMQ version.
    ServiceStatus string
    Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
    Status string
    Consumer group status. Online: Consuming, Offline: Not consuming.
    TotalConsumedRate string
    Total TPS of consumer instance groups under this Group, measured in messages per second.
    TotalDiff int
    Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.
    consumeMessageOrderly Boolean
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    consumedClients List<GroupConsumedClient>
    consumedTopics List<GroupConsumedTopic>
    createdTime String
    Group creation time.
    description String
    Brief description of the Group.
    groupId String
    Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
    groupType String
    Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
    instanceId String
    Instance ID.
    isSubSame Boolean
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    lastUpdateTimestamp String
    Whether consumption is sequential.
    messageDelayTime String
    Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
    messageModel String
    Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
    retryMaxTimes Integer
    Maximum number of consumption retries.
    rocketmqVersion String
    RocketMQ version.
    serviceStatus String
    Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
    status String
    Consumer group status. Online: Consuming, Offline: Not consuming.
    totalConsumedRate String
    Total TPS of consumer instance groups under this Group, measured in messages per second.
    totalDiff Integer
    Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.
    consumeMessageOrderly boolean
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    consumedClients GroupConsumedClient[]
    consumedTopics GroupConsumedTopic[]
    createdTime string
    Group creation time.
    description string
    Brief description of the Group.
    groupId string
    Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
    groupType string
    Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
    instanceId string
    Instance ID.
    isSubSame boolean
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    lastUpdateTimestamp string
    Whether consumption is sequential.
    messageDelayTime string
    Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
    messageModel string
    Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
    retryMaxTimes number
    Maximum number of consumption retries.
    rocketmqVersion string
    RocketMQ version.
    serviceStatus string
    Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
    status string
    Consumer group status. Online: Consuming, Offline: Not consuming.
    totalConsumedRate string
    Total TPS of consumer instance groups under this Group, measured in messages per second.
    totalDiff number
    Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.
    consume_message_orderly bool
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    consumed_clients Sequence[GroupConsumedClientArgs]
    consumed_topics Sequence[GroupConsumedTopicArgs]
    created_time str
    Group creation time.
    description str
    Brief description of the Group.
    group_id str
    Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
    group_type str
    Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
    instance_id str
    Instance ID.
    is_sub_same bool
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    last_update_timestamp str
    Whether consumption is sequential.
    message_delay_time str
    Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
    message_model str
    Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
    retry_max_times int
    Maximum number of consumption retries.
    rocketmq_version str
    RocketMQ version.
    service_status str
    Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
    status str
    Consumer group status. Online: Consuming, Offline: Not consuming.
    total_consumed_rate str
    Total TPS of consumer instance groups under this Group, measured in messages per second.
    total_diff int
    Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.
    consumeMessageOrderly Boolean
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    consumedClients List<Property Map>
    consumedTopics List<Property Map>
    createdTime String
    Group creation time.
    description String
    Brief description of the Group.
    groupId String
    Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
    groupType String
    Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
    instanceId String
    Instance ID.
    isSubSame Boolean
    Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
    lastUpdateTimestamp String
    Whether consumption is sequential.
    messageDelayTime String
    Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
    messageModel String
    Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
    retryMaxTimes Number
    Maximum number of consumption retries.
    rocketmqVersion String
    RocketMQ version.
    serviceStatus String
    Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
    status String
    Consumer group status. Online: Consuming, Offline: Not consuming.
    totalConsumedRate String
    Total TPS of consumer instance groups under this Group, measured in messages per second.
    totalDiff Number
    Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.

    Supporting Types

    GroupConsumedClient, GroupConsumedClientArgs

    ClientAddress string
    Address and port of this consumer instance.
    ClientId string
    ID of this consumer instance.
    Diff int
    Message backlog.
    Language string
    Development language of the consumer application.
    Version string
    Consumer version.
    ClientAddress string
    Address and port of this consumer instance.
    ClientId string
    ID of this consumer instance.
    Diff int
    Message backlog.
    Language string
    Development language of the consumer application.
    Version string
    Consumer version.
    clientAddress String
    Address and port of this consumer instance.
    clientId String
    ID of this consumer instance.
    diff Integer
    Message backlog.
    language String
    Development language of the consumer application.
    version String
    Consumer version.
    clientAddress string
    Address and port of this consumer instance.
    clientId string
    ID of this consumer instance.
    diff number
    Message backlog.
    language string
    Development language of the consumer application.
    version string
    Consumer version.
    client_address str
    Address and port of this consumer instance.
    client_id str
    ID of this consumer instance.
    diff int
    Message backlog.
    language str
    Development language of the consumer application.
    version str
    Consumer version.
    clientAddress String
    Address and port of this consumer instance.
    clientId String
    ID of this consumer instance.
    diff Number
    Message backlog.
    language String
    Development language of the consumer application.
    version String
    Consumer version.

    GroupConsumedTopic, GroupConsumedTopicArgs

    QueueNum int
    Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.
    SubString string
    Subscription rules.
    TopicName string
    Name of the Topic subscribed by the client.
    QueueNum int
    Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.
    SubString string
    Subscription rules.
    TopicName string
    Name of the Topic subscribed by the client.
    queueNum Integer
    Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.
    subString String
    Subscription rules.
    topicName String
    Name of the Topic subscribed by the client.
    queueNum number
    Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.
    subString string
    Subscription rules.
    topicName string
    Name of the Topic subscribed by the client.
    queue_num int
    Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.
    sub_string str
    Subscription rules.
    topic_name str
    Name of the Topic subscribed by the client.
    queueNum Number
    Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.
    subString String
    Subscription rules.
    topicName String
    Name of the Topic subscribed by the client.

    Import

    $ pulumi import volcenginecc:rocketmq/group:Group example "instance_id|group_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.