1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. bmq
  6. Group
Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus
bytepluscc logo
Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus

    A group of consumers with the same Group ID. When a Topic is consumed by multiple Consumers in the same Group, each message is delivered to only one Consumer, enabling load balancing. Using Groups ensures that messages in a Topic are consumed in parallel.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as byteplus from "@pulumi/byteplus";
    
    const bMQGroupDemo = new byteplus.index.BmqGroup("BMQGroupDemo", {
        description: "this is test group",
        groupName: "cBMQGroupDemo",
        instanceId: "bmq-4ld4vpjzd32tq1gxxxxx",
        resetInfo: {
            topicId: "5f81fcab96cb46c7955659fdxxxxx",
            resetBy: "OFFSET",
            offsetType: "LATEST",
            resetValue: 4,
            partitionId: 1,
        },
    });
    
    import pulumi
    import pulumi_byteplus as byteplus
    
    b_mq_group_demo = byteplus.index.BmqGroup("BMQGroupDemo",
        description=this is test group,
        group_name=cBMQGroupDemo,
        instance_id=bmq-4ld4vpjzd32tq1gxxxxx,
        reset_info={
            topicId: 5f81fcab96cb46c7955659fdxxxxx,
            resetBy: OFFSET,
            offsetType: LATEST,
            resetValue: 4,
            partitionId: 1,
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-byteplus/sdk/go/byteplus"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := byteplus.NewBmqGroup(ctx, "BMQGroupDemo", &byteplus.BmqGroupArgs{
    			Description: "this is test group",
    			GroupName:   "cBMQGroupDemo",
    			InstanceId:  "bmq-4ld4vpjzd32tq1gxxxxx",
    			ResetInfo: map[string]interface{}{
    				"topicId":     "5f81fcab96cb46c7955659fdxxxxx",
    				"resetBy":     "OFFSET",
    				"offsetType":  "LATEST",
    				"resetValue":  4,
    				"partitionId": 1,
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Byteplus = Pulumi.Byteplus;
    
    return await Deployment.RunAsync(() => 
    {
        var bMQGroupDemo = new Byteplus.Index.BmqGroup("BMQGroupDemo", new()
        {
            Description = "this is test group",
            GroupName = "cBMQGroupDemo",
            InstanceId = "bmq-4ld4vpjzd32tq1gxxxxx",
            ResetInfo = 
            {
                { "topicId", "5f81fcab96cb46c7955659fdxxxxx" },
                { "resetBy", "OFFSET" },
                { "offsetType", "LATEST" },
                { "resetValue", 4 },
                { "partitionId", 1 },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.byteplus.bmqGroup;
    import com.pulumi.byteplus.bmqGroupArgs;
    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 bMQGroupDemo = new BmqGroup("bMQGroupDemo", BmqGroupArgs.builder()
                .description("this is test group")
                .groupName("cBMQGroupDemo")
                .instanceId("bmq-4ld4vpjzd32tq1gxxxxx")
                .resetInfo(Map.ofEntries(
                    Map.entry("topicId", "5f81fcab96cb46c7955659fdxxxxx"),
                    Map.entry("resetBy", "OFFSET"),
                    Map.entry("offsetType", "LATEST"),
                    Map.entry("resetValue", 4),
                    Map.entry("partitionId", 1)
                ))
                .build());
    
        }
    }
    
    resources:
      bMQGroupDemo:
        type: byteplus:bmqGroup
        name: BMQGroupDemo
        properties:
          description: this is test group
          groupName: cBMQGroupDemo
          instanceId: bmq-4ld4vpjzd32tq1gxxxxx
          resetInfo:
            topicId: 5f81fcab96cb46c7955659fdxxxxx
            resetBy: OFFSET
            offsetType: LATEST
            resetValue: 4
            partitionId: 1
    

    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: Optional[GroupArgs] = None,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Group(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              description: Optional[str] = None,
              group_name: Optional[str] = None,
              instance_id: Optional[str] = None,
              reset_info: Optional[GroupResetInfoArgs] = None)
    func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs? args = null, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
    public Group(String name, GroupArgs args, CustomResourceOptions options)
    
    type: bytepluscc:bmq: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var groupResource = new Bytepluscc.Bmq.Group("groupResource", new()
    {
        Description = "string",
        GroupName = "string",
        InstanceId = "string",
        ResetInfo = new Bytepluscc.Bmq.Inputs.GroupResetInfoArgs
        {
            OffsetType = "string",
            PartitionId = 0,
            ResetBy = "string",
            ResetValue = 0,
            TopicId = "string",
        },
    });
    
    example, err := bmq.NewGroup(ctx, "groupResource", &bmq.GroupArgs{
    	Description: pulumi.String("string"),
    	GroupName:   pulumi.String("string"),
    	InstanceId:  pulumi.String("string"),
    	ResetInfo: &bmq.GroupResetInfoArgs{
    		OffsetType:  pulumi.String("string"),
    		PartitionId: pulumi.Int(0),
    		ResetBy:     pulumi.String("string"),
    		ResetValue:  pulumi.Int(0),
    		TopicId:     pulumi.String("string"),
    	},
    })
    
    var groupResource = new com.byteplus.bytepluscc.bmq.Group("groupResource", com.byteplus.bytepluscc.bmq.GroupArgs.builder()
        .description("string")
        .groupName("string")
        .instanceId("string")
        .resetInfo(GroupResetInfoArgs.builder()
            .offsetType("string")
            .partitionId(0)
            .resetBy("string")
            .resetValue(0)
            .topicId("string")
            .build())
        .build());
    
    group_resource = bytepluscc.bmq.Group("groupResource",
        description="string",
        group_name="string",
        instance_id="string",
        reset_info={
            "offset_type": "string",
            "partition_id": 0,
            "reset_by": "string",
            "reset_value": 0,
            "topic_id": "string",
        })
    
    const groupResource = new bytepluscc.bmq.Group("groupResource", {
        description: "string",
        groupName: "string",
        instanceId: "string",
        resetInfo: {
            offsetType: "string",
            partitionId: 0,
            resetBy: "string",
            resetValue: 0,
            topicId: "string",
        },
    });
    
    type: bytepluscc:bmq:Group
    properties:
        description: string
        groupName: string
        instanceId: string
        resetInfo:
            offsetType: string
            partitionId: 0
            resetBy: string
            resetValue: 0
            topicId: string
    

    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:

    Description string
    Consumer Group description.
    GroupName string
    Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
    InstanceId string
    BMQ instance ID.
    ResetInfo Byteplus.GroupResetInfo
    Reset consumption position information.
    Description string
    Consumer Group description.
    GroupName string
    Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
    InstanceId string
    BMQ instance ID.
    ResetInfo GroupResetInfoArgs
    Reset consumption position information.
    description String
    Consumer Group description.
    groupName String
    Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
    instanceId String
    BMQ instance ID.
    resetInfo GroupResetInfo
    Reset consumption position information.
    description string
    Consumer Group description.
    groupName string
    Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
    instanceId string
    BMQ instance ID.
    resetInfo GroupResetInfo
    Reset consumption position information.
    description str
    Consumer Group description.
    group_name str
    Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
    instance_id str
    BMQ instance ID.
    reset_info GroupResetInfoArgs
    Reset consumption position information.
    description String
    Consumer Group description.
    groupName String
    Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
    instanceId String
    BMQ instance ID.
    resetInfo Property Map
    Reset consumption position information.

    Outputs

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

    CreatedTime string
    Consumer Group creation time.
    GroupId string
    Consumer Group ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerId string
    User ID associated with the Consumer Group.
    OwnerName string
    Name of the user associated with the Consumer Group.
    Status string
    Consumer Group status.
    TopicInfos List<Byteplus.GroupTopicInfo>
    CreatedTime string
    Consumer Group creation time.
    GroupId string
    Consumer Group ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerId string
    User ID associated with the Consumer Group.
    OwnerName string
    Name of the user associated with the Consumer Group.
    Status string
    Consumer Group status.
    TopicInfos []GroupTopicInfo
    createdTime String
    Consumer Group creation time.
    groupId String
    Consumer Group ID.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerId String
    User ID associated with the Consumer Group.
    ownerName String
    Name of the user associated with the Consumer Group.
    status String
    Consumer Group status.
    topicInfos List<GroupTopicInfo>
    createdTime string
    Consumer Group creation time.
    groupId string
    Consumer Group ID.
    id string
    The provider-assigned unique ID for this managed resource.
    ownerId string
    User ID associated with the Consumer Group.
    ownerName string
    Name of the user associated with the Consumer Group.
    status string
    Consumer Group status.
    topicInfos GroupTopicInfo[]
    created_time str
    Consumer Group creation time.
    group_id str
    Consumer Group ID.
    id str
    The provider-assigned unique ID for this managed resource.
    owner_id str
    User ID associated with the Consumer Group.
    owner_name str
    Name of the user associated with the Consumer Group.
    status str
    Consumer Group status.
    topic_infos Sequence[GroupTopicInfo]
    createdTime String
    Consumer Group creation time.
    groupId String
    Consumer Group ID.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerId String
    User ID associated with the Consumer Group.
    ownerName String
    Name of the user associated with the Consumer Group.
    status String
    Consumer Group status.
    topicInfos List<Property Map>

    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,
            created_time: Optional[str] = None,
            description: Optional[str] = None,
            group_id: Optional[str] = None,
            group_name: Optional[str] = None,
            instance_id: Optional[str] = None,
            owner_id: Optional[str] = None,
            owner_name: Optional[str] = None,
            reset_info: Optional[GroupResetInfoArgs] = None,
            status: Optional[str] = None,
            topic_infos: Optional[Sequence[GroupTopicInfoArgs]] = 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: bytepluscc:bmq: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:
    CreatedTime string
    Consumer Group creation time.
    Description string
    Consumer Group description.
    GroupId string
    Consumer Group ID.
    GroupName string
    Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
    InstanceId string
    BMQ instance ID.
    OwnerId string
    User ID associated with the Consumer Group.
    OwnerName string
    Name of the user associated with the Consumer Group.
    ResetInfo Byteplus.GroupResetInfo
    Reset consumption position information.
    Status string
    Consumer Group status.
    TopicInfos List<Byteplus.GroupTopicInfo>
    CreatedTime string
    Consumer Group creation time.
    Description string
    Consumer Group description.
    GroupId string
    Consumer Group ID.
    GroupName string
    Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
    InstanceId string
    BMQ instance ID.
    OwnerId string
    User ID associated with the Consumer Group.
    OwnerName string
    Name of the user associated with the Consumer Group.
    ResetInfo GroupResetInfoArgs
    Reset consumption position information.
    Status string
    Consumer Group status.
    TopicInfos []GroupTopicInfoArgs
    createdTime String
    Consumer Group creation time.
    description String
    Consumer Group description.
    groupId String
    Consumer Group ID.
    groupName String
    Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
    instanceId String
    BMQ instance ID.
    ownerId String
    User ID associated with the Consumer Group.
    ownerName String
    Name of the user associated with the Consumer Group.
    resetInfo GroupResetInfo
    Reset consumption position information.
    status String
    Consumer Group status.
    topicInfos List<GroupTopicInfo>
    createdTime string
    Consumer Group creation time.
    description string
    Consumer Group description.
    groupId string
    Consumer Group ID.
    groupName string
    Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
    instanceId string
    BMQ instance ID.
    ownerId string
    User ID associated with the Consumer Group.
    ownerName string
    Name of the user associated with the Consumer Group.
    resetInfo GroupResetInfo
    Reset consumption position information.
    status string
    Consumer Group status.
    topicInfos GroupTopicInfo[]
    created_time str
    Consumer Group creation time.
    description str
    Consumer Group description.
    group_id str
    Consumer Group ID.
    group_name str
    Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
    instance_id str
    BMQ instance ID.
    owner_id str
    User ID associated with the Consumer Group.
    owner_name str
    Name of the user associated with the Consumer Group.
    reset_info GroupResetInfoArgs
    Reset consumption position information.
    status str
    Consumer Group status.
    topic_infos Sequence[GroupTopicInfoArgs]
    createdTime String
    Consumer Group creation time.
    description String
    Consumer Group description.
    groupId String
    Consumer Group ID.
    groupName String
    Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
    instanceId String
    BMQ instance ID.
    ownerId String
    User ID associated with the Consumer Group.
    ownerName String
    Name of the user associated with the Consumer Group.
    resetInfo Property Map
    Reset consumption position information.
    status String
    Consumer Group status.
    topicInfos List<Property Map>

    Supporting Types

    GroupResetInfo, GroupResetInfoArgs

    OffsetType string
    This parameter is required when the reset mode is OFFSET. Specifies the reference consumption position for re-consuming. Options are: EARLIEST: The reference position is the earliest consumption point. CURRENT: The reference position is the current consumption point. LATEST: The reference position is the latest consumption point.
    PartitionId int
    Partition number.
    ResetBy string
    Reset mode. Options are: TIMESTAMP: Reset the consumption position based on a specific time point. Specify a past or future time, and jump directly to the position at that time to start consuming. OFFSET: Reset the consumption position based on a specified offset. Start consuming from the specified position, and you can use the offsetType parameter to specify the offset.
    ResetValue int
    Reset value. If the reset mode is TIMESTAMP, this value is the time point for re-consuming messages, for example, 1722224612000. If the reset mode is OFFSET, this value is the relative offset from the reference position specified in OffsetType, for example, 100.
    TopicId string
    Topic ID。
    OffsetType string
    This parameter is required when the reset mode is OFFSET. Specifies the reference consumption position for re-consuming. Options are: EARLIEST: The reference position is the earliest consumption point. CURRENT: The reference position is the current consumption point. LATEST: The reference position is the latest consumption point.
    PartitionId int
    Partition number.
    ResetBy string
    Reset mode. Options are: TIMESTAMP: Reset the consumption position based on a specific time point. Specify a past or future time, and jump directly to the position at that time to start consuming. OFFSET: Reset the consumption position based on a specified offset. Start consuming from the specified position, and you can use the offsetType parameter to specify the offset.
    ResetValue int
    Reset value. If the reset mode is TIMESTAMP, this value is the time point for re-consuming messages, for example, 1722224612000. If the reset mode is OFFSET, this value is the relative offset from the reference position specified in OffsetType, for example, 100.
    TopicId string
    Topic ID。
    offsetType String
    This parameter is required when the reset mode is OFFSET. Specifies the reference consumption position for re-consuming. Options are: EARLIEST: The reference position is the earliest consumption point. CURRENT: The reference position is the current consumption point. LATEST: The reference position is the latest consumption point.
    partitionId Integer
    Partition number.
    resetBy String
    Reset mode. Options are: TIMESTAMP: Reset the consumption position based on a specific time point. Specify a past or future time, and jump directly to the position at that time to start consuming. OFFSET: Reset the consumption position based on a specified offset. Start consuming from the specified position, and you can use the offsetType parameter to specify the offset.
    resetValue Integer
    Reset value. If the reset mode is TIMESTAMP, this value is the time point for re-consuming messages, for example, 1722224612000. If the reset mode is OFFSET, this value is the relative offset from the reference position specified in OffsetType, for example, 100.
    topicId String
    Topic ID。
    offsetType string
    This parameter is required when the reset mode is OFFSET. Specifies the reference consumption position for re-consuming. Options are: EARLIEST: The reference position is the earliest consumption point. CURRENT: The reference position is the current consumption point. LATEST: The reference position is the latest consumption point.
    partitionId number
    Partition number.
    resetBy string
    Reset mode. Options are: TIMESTAMP: Reset the consumption position based on a specific time point. Specify a past or future time, and jump directly to the position at that time to start consuming. OFFSET: Reset the consumption position based on a specified offset. Start consuming from the specified position, and you can use the offsetType parameter to specify the offset.
    resetValue number
    Reset value. If the reset mode is TIMESTAMP, this value is the time point for re-consuming messages, for example, 1722224612000. If the reset mode is OFFSET, this value is the relative offset from the reference position specified in OffsetType, for example, 100.
    topicId string
    Topic ID。
    offset_type str
    This parameter is required when the reset mode is OFFSET. Specifies the reference consumption position for re-consuming. Options are: EARLIEST: The reference position is the earliest consumption point. CURRENT: The reference position is the current consumption point. LATEST: The reference position is the latest consumption point.
    partition_id int
    Partition number.
    reset_by str
    Reset mode. Options are: TIMESTAMP: Reset the consumption position based on a specific time point. Specify a past or future time, and jump directly to the position at that time to start consuming. OFFSET: Reset the consumption position based on a specified offset. Start consuming from the specified position, and you can use the offsetType parameter to specify the offset.
    reset_value int
    Reset value. If the reset mode is TIMESTAMP, this value is the time point for re-consuming messages, for example, 1722224612000. If the reset mode is OFFSET, this value is the relative offset from the reference position specified in OffsetType, for example, 100.
    topic_id str
    Topic ID。
    offsetType String
    This parameter is required when the reset mode is OFFSET. Specifies the reference consumption position for re-consuming. Options are: EARLIEST: The reference position is the earliest consumption point. CURRENT: The reference position is the current consumption point. LATEST: The reference position is the latest consumption point.
    partitionId Number
    Partition number.
    resetBy String
    Reset mode. Options are: TIMESTAMP: Reset the consumption position based on a specific time point. Specify a past or future time, and jump directly to the position at that time to start consuming. OFFSET: Reset the consumption position based on a specified offset. Start consuming from the specified position, and you can use the offsetType parameter to specify the offset.
    resetValue Number
    Reset value. If the reset mode is TIMESTAMP, this value is the time point for re-consuming messages, for example, 1722224612000. If the reset mode is OFFSET, this value is the relative offset from the reference position specified in OffsetType, for example, 100.
    topicId String
    Topic ID。

    GroupTopicInfo, GroupTopicInfoArgs

    CreateTime string
    Topic creation time.
    Description string
    Topic description.
    Lag int
    Number of unconsumed messages in the Topic.
    PartitionInfos List<Byteplus.GroupTopicInfoPartitionInfo>
    Partitions int
    Number of Topic partitions.
    Retention int
    Retention period of data in the Topic, in hours.
    Status string
    Topic status.
    TopicId string
    Topic ID。
    TopicName string
    Topic name.
    CreateTime string
    Topic creation time.
    Description string
    Topic description.
    Lag int
    Number of unconsumed messages in the Topic.
    PartitionInfos []GroupTopicInfoPartitionInfo
    Partitions int
    Number of Topic partitions.
    Retention int
    Retention period of data in the Topic, in hours.
    Status string
    Topic status.
    TopicId string
    Topic ID。
    TopicName string
    Topic name.
    createTime String
    Topic creation time.
    description String
    Topic description.
    lag Integer
    Number of unconsumed messages in the Topic.
    partitionInfos List<GroupTopicInfoPartitionInfo>
    partitions Integer
    Number of Topic partitions.
    retention Integer
    Retention period of data in the Topic, in hours.
    status String
    Topic status.
    topicId String
    Topic ID。
    topicName String
    Topic name.
    createTime string
    Topic creation time.
    description string
    Topic description.
    lag number
    Number of unconsumed messages in the Topic.
    partitionInfos GroupTopicInfoPartitionInfo[]
    partitions number
    Number of Topic partitions.
    retention number
    Retention period of data in the Topic, in hours.
    status string
    Topic status.
    topicId string
    Topic ID。
    topicName string
    Topic name.
    create_time str
    Topic creation time.
    description str
    Topic description.
    lag int
    Number of unconsumed messages in the Topic.
    partition_infos Sequence[GroupTopicInfoPartitionInfo]
    partitions int
    Number of Topic partitions.
    retention int
    Retention period of data in the Topic, in hours.
    status str
    Topic status.
    topic_id str
    Topic ID。
    topic_name str
    Topic name.
    createTime String
    Topic creation time.
    description String
    Topic description.
    lag Number
    Number of unconsumed messages in the Topic.
    partitionInfos List<Property Map>
    partitions Number
    Number of Topic partitions.
    retention Number
    Retention period of data in the Topic, in hours.
    status String
    Topic status.
    topicId String
    Topic ID。
    topicName String
    Topic name.

    GroupTopicInfoPartitionInfo, GroupTopicInfoPartitionInfoArgs

    CurrentOffset int
    Current consumption position.
    GroupName string
    Name of the Consumer Group.
    Lag int
    Number of unconsumed messages in the partition.
    LatestOffset int
    Latest consumption position.
    PartitionId int
    Partition number.
    TopicName string
    Name of the Topic subscribed by the Consumer Group.
    CurrentOffset int
    Current consumption position.
    GroupName string
    Name of the Consumer Group.
    Lag int
    Number of unconsumed messages in the partition.
    LatestOffset int
    Latest consumption position.
    PartitionId int
    Partition number.
    TopicName string
    Name of the Topic subscribed by the Consumer Group.
    currentOffset Integer
    Current consumption position.
    groupName String
    Name of the Consumer Group.
    lag Integer
    Number of unconsumed messages in the partition.
    latestOffset Integer
    Latest consumption position.
    partitionId Integer
    Partition number.
    topicName String
    Name of the Topic subscribed by the Consumer Group.
    currentOffset number
    Current consumption position.
    groupName string
    Name of the Consumer Group.
    lag number
    Number of unconsumed messages in the partition.
    latestOffset number
    Latest consumption position.
    partitionId number
    Partition number.
    topicName string
    Name of the Topic subscribed by the Consumer Group.
    current_offset int
    Current consumption position.
    group_name str
    Name of the Consumer Group.
    lag int
    Number of unconsumed messages in the partition.
    latest_offset int
    Latest consumption position.
    partition_id int
    Partition number.
    topic_name str
    Name of the Topic subscribed by the Consumer Group.
    currentOffset Number
    Current consumption position.
    groupName String
    Name of the Consumer Group.
    lag Number
    Number of unconsumed messages in the partition.
    latestOffset Number
    Latest consumption position.
    partitionId Number
    Partition number.
    topicName String
    Name of the Topic subscribed by the Consumer Group.

    Import

    $ pulumi import bytepluscc:bmq/group:Group example "group_id"
    

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.25
    published on Thursday, May 7, 2026 by Byteplus
      Try Pulumi Cloud free. Your team will thank you.