1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. tls
  6. ConsumerGroup
Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.tls.ConsumerGroup

bytepluscc logo
Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    A virtual collection of multiple consumers. When consuming log data at the consumer group level, all consumers in the group subscribe to the same log topic and jointly consume data from that log topic. Each consumer consumes data from one or more Shards in the log topic, and there is no duplicate consumption of data among consumers.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

const tLSConsumerGroupDemo = new bytepluscc.tls.ConsumerGroup("TLSConsumerGroupDemo", {
    projectId: "c6fef4c1-041f-43*****",
    topicIdLists: ["bead2d9c*****"],
    consumerGroupName: "test-gruopname",
    heartbeatTtl: 10,
    orderedConsume: true,
});

    import pulumi
import pulumi_bytepluscc as bytepluscc

t_ls_consumer_group_demo = bytepluscc.tls.ConsumerGroup("TLSConsumerGroupDemo",
    project_id="c6fef4c1-041f-43*****",
    topic_id_lists=["bead2d9c*****"],
    consumer_group_name="test-gruopname",
    heartbeat_ttl=10,
    ordered_consume=True)

    package main

import (
	"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/tls"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tls.NewConsumerGroup(ctx, "TLSConsumerGroupDemo", &tls.ConsumerGroupArgs{
			ProjectId: pulumi.String("c6fef4c1-041f-43*****"),
			TopicIdLists: pulumi.StringArray{
				pulumi.String("bead2d9c*****"),
			},
			ConsumerGroupName: pulumi.String("test-gruopname"),
			HeartbeatTtl:      pulumi.Int(10),
			OrderedConsume:    pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;

return await Deployment.RunAsync(() => 
{
    var tLSConsumerGroupDemo = new Bytepluscc.Tls.ConsumerGroup("TLSConsumerGroupDemo", new()
    {
        ProjectId = "c6fef4c1-041f-43*****",
        TopicIdLists = new[]
        {
            "bead2d9c*****",
        },
        ConsumerGroupName = "test-gruopname",
        HeartbeatTtl = 10,
        OrderedConsume = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.tls.ConsumerGroup;
import com.byteplus.bytepluscc.tls.ConsumerGroupArgs;
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 tLSConsumerGroupDemo = new ConsumerGroup("tLSConsumerGroupDemo", ConsumerGroupArgs.builder()
            .projectId("c6fef4c1-041f-43*****")
            .topicIdLists("bead2d9c*****")
            .consumerGroupName("test-gruopname")
            .heartbeatTtl(10)
            .orderedConsume(true)
            .build());

    }
}

    resources:
  tLSConsumerGroupDemo:
    type: bytepluscc:tls:ConsumerGroup
    name: TLSConsumerGroupDemo
    properties:
      projectId: c6fef4c1-041f-43*****
      topicIdLists:
        - bead2d9c*****
      consumerGroupName: test-gruopname
      heartbeatTtl: 10
      orderedConsume: true

    Create ConsumerGroup Resource

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

    Constructor syntax

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

@overload
def ConsumerGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  consumer_group_name: Optional[str] = None,
                  heartbeat_ttl: Optional[int] = None,
                  ordered_consume: Optional[bool] = None,
                  project_id: Optional[str] = None,
                  topic_id_lists: Optional[Sequence[str]] = None)
    func NewConsumerGroup(ctx *Context, name string, args ConsumerGroupArgs, opts ...ResourceOption) (*ConsumerGroup, error)
    public ConsumerGroup(string name, ConsumerGroupArgs args, CustomResourceOptions? opts = null)
    public ConsumerGroup(String name, ConsumerGroupArgs args)
public ConsumerGroup(String name, ConsumerGroupArgs args, CustomResourceOptions options)

    type: bytepluscc:tls:ConsumerGroup
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 ConsumerGroupArgs
    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 ConsumerGroupArgs
    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 ConsumerGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConsumerGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConsumerGroupArgs
    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 consumerGroupResource = new Bytepluscc.Tls.ConsumerGroup("consumerGroupResource", new()
{
    ConsumerGroupName = "string",
    HeartbeatTtl = 0,
    OrderedConsume = false,
    ProjectId = "string",
    TopicIdLists = new[]
    {
        "string",
    },
});

    example, err := tls.NewConsumerGroup(ctx, "consumerGroupResource", &tls.ConsumerGroupArgs{
	ConsumerGroupName: pulumi.String("string"),
	HeartbeatTtl:      pulumi.Int(0),
	OrderedConsume:    pulumi.Bool(false),
	ProjectId:         pulumi.String("string"),
	TopicIdLists: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var consumerGroupResource = new ConsumerGroup("consumerGroupResource", ConsumerGroupArgs.builder()
    .consumerGroupName("string")
    .heartbeatTtl(0)
    .orderedConsume(false)
    .projectId("string")
    .topicIdLists("string")
    .build());

    consumer_group_resource = bytepluscc.tls.ConsumerGroup("consumerGroupResource",
    consumer_group_name="string",
    heartbeat_ttl=0,
    ordered_consume=False,
    project_id="string",
    topic_id_lists=["string"])

    const consumerGroupResource = new bytepluscc.tls.ConsumerGroup("consumerGroupResource", {
    consumerGroupName: "string",
    heartbeatTtl: 0,
    orderedConsume: false,
    projectId: "string",
    topicIdLists: ["string"],
});

    type: bytepluscc:tls:ConsumerGroup
properties:
    consumerGroupName: string
    heartbeatTtl: 0
    orderedConsume: false
    projectId: string
    topicIdLists:
        - string

    ConsumerGroup 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 ConsumerGroup resource accepts the following input properties:

    ConsumerGroupName string
    Consumer group name.
    HeartbeatTtl int
    Heartbeat timeout in seconds. Value range: 1~300.
    OrderedConsume bool
    Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
    ProjectId string
    ID of the log project to which the consumer group belongs.
    TopicIdLists List<string>
    List of log topic IDs to be consumed by the consumer group.
    ConsumerGroupName string
    Consumer group name.
    HeartbeatTtl int
    Heartbeat timeout in seconds. Value range: 1~300.
    OrderedConsume bool
    Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
    ProjectId string
    ID of the log project to which the consumer group belongs.
    TopicIdLists []string
    List of log topic IDs to be consumed by the consumer group.
    consumerGroupName String
    Consumer group name.
    heartbeatTtl Integer
    Heartbeat timeout in seconds. Value range: 1~300.
    orderedConsume Boolean
    Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
    projectId String
    ID of the log project to which the consumer group belongs.
    topicIdLists List<String>
    List of log topic IDs to be consumed by the consumer group.
    consumerGroupName string
    Consumer group name.
    heartbeatTtl number
    Heartbeat timeout in seconds. Value range: 1~300.
    orderedConsume boolean
    Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
    projectId string
    ID of the log project to which the consumer group belongs.
    topicIdLists string[]
    List of log topic IDs to be consumed by the consumer group.
    consumer_group_name str
    Consumer group name.
    heartbeat_ttl int
    Heartbeat timeout in seconds. Value range: 1~300.
    ordered_consume bool
    Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
    project_id str
    ID of the log project to which the consumer group belongs.
    topic_id_lists Sequence[str]
    List of log topic IDs to be consumed by the consumer group.
    consumerGroupName String
    Consumer group name.
    heartbeatTtl Number
    Heartbeat timeout in seconds. Value range: 1~300.
    orderedConsume Boolean
    Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
    projectId String
    ID of the log project to which the consumer group belongs.
    topicIdLists List<String>
    List of log topic IDs to be consumed by the consumer group.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectName string
    Name of the log project to which the consumer group belongs.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectName string
    Name of the log project to which the consumer group belongs.
    id String
    The provider-assigned unique ID for this managed resource.
    projectName String
    Name of the log project to which the consumer group belongs.
    id string
    The provider-assigned unique ID for this managed resource.
    projectName string
    Name of the log project to which the consumer group belongs.
    id str
    The provider-assigned unique ID for this managed resource.
    project_name str
    Name of the log project to which the consumer group belongs.
    id String
    The provider-assigned unique ID for this managed resource.
    projectName String
    Name of the log project to which the consumer group belongs.

    Look up Existing ConsumerGroup Resource

    Get an existing ConsumerGroup 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?: ConsumerGroupState, opts?: CustomResourceOptions): ConsumerGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        consumer_group_name: Optional[str] = None,
        heartbeat_ttl: Optional[int] = None,
        ordered_consume: Optional[bool] = None,
        project_id: Optional[str] = None,
        project_name: Optional[str] = None,
        topic_id_lists: Optional[Sequence[str]] = None) -> ConsumerGroup
    func GetConsumerGroup(ctx *Context, name string, id IDInput, state *ConsumerGroupState, opts ...ResourceOption) (*ConsumerGroup, error)
    public static ConsumerGroup Get(string name, Input<string> id, ConsumerGroupState? state, CustomResourceOptions? opts = null)
    public static ConsumerGroup get(String name, Output<String> id, ConsumerGroupState state, CustomResourceOptions options)
    resources:  _:    type: bytepluscc:tls:ConsumerGroup    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:
    ConsumerGroupName string
    Consumer group name.
    HeartbeatTtl int
    Heartbeat timeout in seconds. Value range: 1~300.
    OrderedConsume bool
    Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
    ProjectId string
    ID of the log project to which the consumer group belongs.
    ProjectName string
    Name of the log project to which the consumer group belongs.
    TopicIdLists List<string>
    List of log topic IDs to be consumed by the consumer group.
    ConsumerGroupName string
    Consumer group name.
    HeartbeatTtl int
    Heartbeat timeout in seconds. Value range: 1~300.
    OrderedConsume bool
    Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
    ProjectId string
    ID of the log project to which the consumer group belongs.
    ProjectName string
    Name of the log project to which the consumer group belongs.
    TopicIdLists []string
    List of log topic IDs to be consumed by the consumer group.
    consumerGroupName String
    Consumer group name.
    heartbeatTtl Integer
    Heartbeat timeout in seconds. Value range: 1~300.
    orderedConsume Boolean
    Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
    projectId String
    ID of the log project to which the consumer group belongs.
    projectName String
    Name of the log project to which the consumer group belongs.
    topicIdLists List<String>
    List of log topic IDs to be consumed by the consumer group.
    consumerGroupName string
    Consumer group name.
    heartbeatTtl number
    Heartbeat timeout in seconds. Value range: 1~300.
    orderedConsume boolean
    Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
    projectId string
    ID of the log project to which the consumer group belongs.
    projectName string
    Name of the log project to which the consumer group belongs.
    topicIdLists string[]
    List of log topic IDs to be consumed by the consumer group.
    consumer_group_name str
    Consumer group name.
    heartbeat_ttl int
    Heartbeat timeout in seconds. Value range: 1~300.
    ordered_consume bool
    Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
    project_id str
    ID of the log project to which the consumer group belongs.
    project_name str
    Name of the log project to which the consumer group belongs.
    topic_id_lists Sequence[str]
    List of log topic IDs to be consumed by the consumer group.
    consumerGroupName String
    Consumer group name.
    heartbeatTtl Number
    Heartbeat timeout in seconds. Value range: 1~300.
    orderedConsume Boolean
    Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
    projectId String
    ID of the log project to which the consumer group belongs.
    projectName String
    Name of the log project to which the consumer group belongs.
    topicIdLists List<String>
    List of log topic IDs to be consumed by the consumer group.

    Import

    $ pulumi import bytepluscc:tls/consumerGroup:ConsumerGroup example "project_id|consumer_group_name"

    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
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.