Group

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  bMQGroupDemo:
    type: volcenginecc:bmq:Group
    name: BMQGroupDemo
    properties:
      description: this is test group
      groupName: cBMQGroupDemo
      instanceId: bmq-4ld4vpjzd32tq1gxxxxx
      resetInfo:
        topic_id: 5f81fcab96cb46c7955659fdxxxxx
        reset_by: OFFSET
        offset_type: LATEST
        reset_value: 4
        partition_id: 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: volcenginecc: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.

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 a custom Consumer Group name. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
InstanceId string: BMQ instance ID
ResetInfo Volcengine.GroupResetInfo: Reset consumption offset information

Description string: Consumer Group description
GroupName string: Set a custom Consumer Group name. 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 offset information

description String: Consumer Group description
groupName String: Set a custom Consumer Group name. 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 offset information

description string: Consumer Group description
groupName string: Set a custom Consumer Group name. 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 offset information

description str: Consumer Group description
group_name str: Set a custom Consumer Group name. 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 offset information

description String: Consumer Group description
groupName String: Set a custom Consumer Group name. 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 offset 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 of the Consumer Group owner
OwnerName string: Name of the Consumer Group owner
Status string: Consumer Group status
TopicInfos List<Volcengine.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 of the Consumer Group owner
OwnerName string: Name of the Consumer Group owner
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 of the Consumer Group owner
ownerName String: Name of the Consumer Group owner
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 of the Consumer Group owner
ownerName string: Name of the Consumer Group owner
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 of the Consumer Group owner
owner_name str: Name of the Consumer Group owner
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 of the Consumer Group owner
ownerName String: Name of the Consumer Group owner
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: volcenginecc: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 a custom Consumer Group name. 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 of the Consumer Group owner
OwnerName string: Name of the Consumer Group owner
ResetInfo Volcengine.GroupResetInfo: Reset consumption offset information
Status string: Consumer Group status
TopicInfos List<Volcengine.GroupTopicInfo>

CreatedTime string: Consumer Group creation time
Description string: Consumer Group description
GroupId string: Consumer Group ID
GroupName string: Set a custom Consumer Group name. 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 of the Consumer Group owner
OwnerName string: Name of the Consumer Group owner
ResetInfo GroupResetInfoArgs: Reset consumption offset 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 a custom Consumer Group name. 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 of the Consumer Group owner
ownerName String: Name of the Consumer Group owner
resetInfo GroupResetInfo: Reset consumption offset 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 a custom Consumer Group name. 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 of the Consumer Group owner
ownerName string: Name of the Consumer Group owner
resetInfo GroupResetInfo: Reset consumption offset 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 a custom Consumer Group name. 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 of the Consumer Group owner
owner_name str: Name of the Consumer Group owner
reset_info GroupResetInfoArgs: Reset consumption offset 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 a custom Consumer Group name. 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 of the Consumer Group owner
ownerName String: Name of the Consumer Group owner
resetInfo Property Map: Reset consumption offset information
status String: Consumer Group status
topicInfos List<Property Map>

Supporting Types

GroupResetInfo, GroupResetInfoArgs

OffsetType string: If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.
PartitionId int: Partition number
ResetBy string: Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.
ResetValue int: Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 100.
TopicId string: Topic ID。

OffsetType string: If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.
PartitionId int: Partition number
ResetBy string: Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.
ResetValue int: Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 100.
TopicId string: Topic ID。

offsetType String: If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.
partitionId Integer: Partition number
resetBy String: Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.
resetValue Integer: Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 100.
topicId String: Topic ID。

offsetType string: If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.
partitionId number: Partition number
resetBy string: Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.
resetValue number: Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 100.
topicId string: Topic ID。

offset_type str: If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.
partition_id int: Partition number
reset_by str: Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.
reset_value int: Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 100.
topic_id str: Topic ID。

offsetType String: If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.
partitionId Number: Partition number
resetBy String: Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.
resetValue Number: Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 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<Volcengine.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 offset
GroupName string: Consumer Group name
Lag int: Number of unconsumed messages in the partition
LatestOffset int: Latest consumption offset
PartitionId int: Partition number
TopicName string: Name of the Topic subscribed by the Consumer Group

CurrentOffset int: Current consumption offset
GroupName string: Consumer Group name
Lag int: Number of unconsumed messages in the partition
LatestOffset int: Latest consumption offset
PartitionId int: Partition number
TopicName string: Name of the Topic subscribed by the Consumer Group

currentOffset Integer: Current consumption offset
groupName String: Consumer Group name
lag Integer: Number of unconsumed messages in the partition
latestOffset Integer: Latest consumption offset
partitionId Integer: Partition number
topicName String: Name of the Topic subscribed by the Consumer Group

currentOffset number: Current consumption offset
groupName string: Consumer Group name
lag number: Number of unconsumed messages in the partition
latestOffset number: Latest consumption offset
partitionId number: Partition number
topicName string: Name of the Topic subscribed by the Consumer Group

current_offset int: Current consumption offset
group_name str: Consumer Group name
lag int: Number of unconsumed messages in the partition
latest_offset int: Latest consumption offset
partition_id int: Partition number
topic_name str: Name of the Topic subscribed by the Consumer Group

currentOffset Number: Current consumption offset
groupName String: Consumer Group name
lag Number: Number of unconsumed messages in the partition
latestOffset Number: Latest consumption offset
partitionId Number: Partition number
topicName String: Name of the Topic subscribed by the Consumer Group

Import

$ pulumi import volcenginecc:bmq/group:Group example "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.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.bmq.Group

On this page

On this page

Example Usage

Create Group Resource

Constructor syntax

Parameters

Group Resource Properties

Inputs

Outputs

Look up Existing Group Resource

Supporting Types

GroupResetInfo, GroupResetInfoArgs

GroupTopicInfo, GroupTopicInfoArgs

GroupTopicInfoPartitionInfo, GroupTopicInfoPartitionInfoArgs

Import

Package Details

On this page

On this page