1. Packages
  2. Volcengine
  3. API Docs
  4. tls
  5. ConsumerGroups
Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.tls.ConsumerGroups

volcengine logo
Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine
    Deprecated: volcengine.tls.ConsumerGroups has been deprecated in favor of volcengine.tls.getConsumerGroups

    Use this data source to query detailed information of tls consumer groups

    Example Usage

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

const all = volcengine.tls.getConsumerGroups({});
export const allConsumerGroups = all.then(all => all.consumerGroups);
const byName = volcengine.tls.getConsumerGroups({
    consumerGroupName: "test-consumer-group",
});
export const byNameConsumerGroups = byName.then(byName => byName.consumerGroups);
const byProject = volcengine.tls.getConsumerGroups({
    projectId: "project-123456",
});
export const byProjectConsumerGroups = byProject.then(byProject => byProject.consumerGroups);
const byTopic = volcengine.tls.getConsumerGroups({
    topicId: "topic-123456",
});
export const byTopicConsumerGroups = byTopic.then(byTopic => byTopic.consumerGroups);
const withMultipleFilters = volcengine.tls.getConsumerGroups({
    projectId: "project-123456",
    consumerGroupName: "test",
});
export const multipleFiltersConsumerGroups = withMultipleFilters.then(withMultipleFilters => withMultipleFilters.consumerGroups);

    import pulumi
import pulumi_volcengine as volcengine

all = volcengine.tls.get_consumer_groups()
pulumi.export("allConsumerGroups", all.consumer_groups)
by_name = volcengine.tls.get_consumer_groups(consumer_group_name="test-consumer-group")
pulumi.export("byNameConsumerGroups", by_name.consumer_groups)
by_project = volcengine.tls.get_consumer_groups(project_id="project-123456")
pulumi.export("byProjectConsumerGroups", by_project.consumer_groups)
by_topic = volcengine.tls.get_consumer_groups(topic_id="topic-123456")
pulumi.export("byTopicConsumerGroups", by_topic.consumer_groups)
with_multiple_filters = volcengine.tls.get_consumer_groups(project_id="project-123456",
    consumer_group_name="test")
pulumi.export("multipleFiltersConsumerGroups", with_multiple_filters.consumer_groups)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		all, err := tls.GetConsumerGroups(ctx, nil, nil)
		if err != nil {
			return err
		}
		ctx.Export("allConsumerGroups", all.ConsumerGroups)
		byName, err := tls.GetConsumerGroups(ctx, &tls.GetConsumerGroupsArgs{
			ConsumerGroupName: pulumi.StringRef("test-consumer-group"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("byNameConsumerGroups", byName.ConsumerGroups)
		byProject, err := tls.GetConsumerGroups(ctx, &tls.GetConsumerGroupsArgs{
			ProjectId: pulumi.StringRef("project-123456"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("byProjectConsumerGroups", byProject.ConsumerGroups)
		byTopic, err := tls.GetConsumerGroups(ctx, &tls.GetConsumerGroupsArgs{
			TopicId: pulumi.StringRef("topic-123456"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("byTopicConsumerGroups", byTopic.ConsumerGroups)
		withMultipleFilters, err := tls.GetConsumerGroups(ctx, &tls.GetConsumerGroupsArgs{
			ProjectId:         pulumi.StringRef("project-123456"),
			ConsumerGroupName: pulumi.StringRef("test"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("multipleFiltersConsumerGroups", withMultipleFilters.ConsumerGroups)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var all = Volcengine.Tls.GetConsumerGroups.Invoke();

    var byName = Volcengine.Tls.GetConsumerGroups.Invoke(new()
    {
        ConsumerGroupName = "test-consumer-group",
    });

    var byProject = Volcengine.Tls.GetConsumerGroups.Invoke(new()
    {
        ProjectId = "project-123456",
    });

    var byTopic = Volcengine.Tls.GetConsumerGroups.Invoke(new()
    {
        TopicId = "topic-123456",
    });

    var withMultipleFilters = Volcengine.Tls.GetConsumerGroups.Invoke(new()
    {
        ProjectId = "project-123456",
        ConsumerGroupName = "test",
    });

    return new Dictionary<string, object?>
    {
        ["allConsumerGroups"] = all.Apply(getConsumerGroupsResult => getConsumerGroupsResult.ConsumerGroups),
        ["byNameConsumerGroups"] = byName.Apply(getConsumerGroupsResult => getConsumerGroupsResult.ConsumerGroups),
        ["byProjectConsumerGroups"] = byProject.Apply(getConsumerGroupsResult => getConsumerGroupsResult.ConsumerGroups),
        ["byTopicConsumerGroups"] = byTopic.Apply(getConsumerGroupsResult => getConsumerGroupsResult.ConsumerGroups),
        ["multipleFiltersConsumerGroups"] = withMultipleFilters.Apply(getConsumerGroupsResult => getConsumerGroupsResult.ConsumerGroups),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tls.TlsFunctions;
import com.pulumi.volcengine.tls.inputs.GetConsumerGroupsArgs;
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) {
        final var all = TlsFunctions.getConsumerGroups();

        ctx.export("allConsumerGroups", all.applyValue(getConsumerGroupsResult -> getConsumerGroupsResult.consumerGroups()));
        final var byName = TlsFunctions.getConsumerGroups(GetConsumerGroupsArgs.builder()
            .consumerGroupName("test-consumer-group")
            .build());

        ctx.export("byNameConsumerGroups", byName.applyValue(getConsumerGroupsResult -> getConsumerGroupsResult.consumerGroups()));
        final var byProject = TlsFunctions.getConsumerGroups(GetConsumerGroupsArgs.builder()
            .projectId("project-123456")
            .build());

        ctx.export("byProjectConsumerGroups", byProject.applyValue(getConsumerGroupsResult -> getConsumerGroupsResult.consumerGroups()));
        final var byTopic = TlsFunctions.getConsumerGroups(GetConsumerGroupsArgs.builder()
            .topicId("topic-123456")
            .build());

        ctx.export("byTopicConsumerGroups", byTopic.applyValue(getConsumerGroupsResult -> getConsumerGroupsResult.consumerGroups()));
        final var withMultipleFilters = TlsFunctions.getConsumerGroups(GetConsumerGroupsArgs.builder()
            .projectId("project-123456")
            .consumerGroupName("test")
            .build());

        ctx.export("multipleFiltersConsumerGroups", withMultipleFilters.applyValue(getConsumerGroupsResult -> getConsumerGroupsResult.consumerGroups()));
    }
}

    variables:
  all:
    fn::invoke:
      Function: volcengine:tls:getConsumerGroups
      Arguments: {}
  byName:
    fn::invoke:
      Function: volcengine:tls:getConsumerGroups
      Arguments:
        consumerGroupName: test-consumer-group
  byProject:
    fn::invoke:
      Function: volcengine:tls:getConsumerGroups
      Arguments:
        projectId: project-123456
  byTopic:
    fn::invoke:
      Function: volcengine:tls:getConsumerGroups
      Arguments:
        topicId: topic-123456
  withMultipleFilters:
    fn::invoke:
      Function: volcengine:tls:getConsumerGroups
      Arguments:
        projectId: project-123456
        consumerGroupName: test
outputs:
  allConsumerGroups: ${all.consumerGroups} # Example with consumer group name filter
  byNameConsumerGroups: ${byName.consumerGroups} # Example with project filter
  byProjectConsumerGroups: ${byProject.consumerGroups} # Example with topic filter
  byTopicConsumerGroups: ${byTopic.consumerGroups} # Example with multiple filters
  multipleFiltersConsumerGroups: ${withMultipleFilters.consumerGroups}

    Using ConsumerGroups

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function consumerGroups(args: ConsumerGroupsArgs, opts?: InvokeOptions): Promise<ConsumerGroupsResult>
function consumerGroupsOutput(args: ConsumerGroupsOutputArgs, opts?: InvokeOptions): Output<ConsumerGroupsResult>
    def consumer_groups(consumer_group_name: Optional[str] = None,
                    iam_project_name: Optional[str] = None,
                    name_regex: Optional[str] = None,
                    output_file: Optional[str] = None,
                    project_id: Optional[str] = None,
                    project_name: Optional[str] = None,
                    topic_id: Optional[str] = None,
                    topic_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> ConsumerGroupsResult
def consumer_groups_output(consumer_group_name: Optional[pulumi.Input[str]] = None,
                    iam_project_name: Optional[pulumi.Input[str]] = None,
                    name_regex: Optional[pulumi.Input[str]] = None,
                    output_file: Optional[pulumi.Input[str]] = None,
                    project_id: Optional[pulumi.Input[str]] = None,
                    project_name: Optional[pulumi.Input[str]] = None,
                    topic_id: Optional[pulumi.Input[str]] = None,
                    topic_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[ConsumerGroupsResult]
    func ConsumerGroups(ctx *Context, args *ConsumerGroupsArgs, opts ...InvokeOption) (*ConsumerGroupsResult, error)
func ConsumerGroupsOutput(ctx *Context, args *ConsumerGroupsOutputArgs, opts ...InvokeOption) ConsumerGroupsResultOutput
    public static class ConsumerGroups 
{
    public static Task<ConsumerGroupsResult> InvokeAsync(ConsumerGroupsArgs args, InvokeOptions? opts = null)
    public static Output<ConsumerGroupsResult> Invoke(ConsumerGroupsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<ConsumerGroupsResult> consumerGroups(ConsumerGroupsArgs args, InvokeOptions options)
public static Output<ConsumerGroupsResult> consumerGroups(ConsumerGroupsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:tls:ConsumerGroups
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ConsumerGroupName string
    The name of the consumer group.
    IamProjectName string
    IAM log project name.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    ProjectId string
    The log project ID to which the consumption group belongs.
    ProjectName string
    The name of the log item to which the consumption group belongs.
    TopicId string
    The log topic ID to which the consumer belongs.
    TopicName string
    The name of the log topic to which the consumption group belongs.
    ConsumerGroupName string
    The name of the consumer group.
    IamProjectName string
    IAM log project name.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    ProjectId string
    The log project ID to which the consumption group belongs.
    ProjectName string
    The name of the log item to which the consumption group belongs.
    TopicId string
    The log topic ID to which the consumer belongs.
    TopicName string
    The name of the log topic to which the consumption group belongs.
    consumerGroupName String
    The name of the consumer group.
    iamProjectName String
    IAM log project name.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    projectId String
    The log project ID to which the consumption group belongs.
    projectName String
    The name of the log item to which the consumption group belongs.
    topicId String
    The log topic ID to which the consumer belongs.
    topicName String
    The name of the log topic to which the consumption group belongs.
    consumerGroupName string
    The name of the consumer group.
    iamProjectName string
    IAM log project name.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    projectId string
    The log project ID to which the consumption group belongs.
    projectName string
    The name of the log item to which the consumption group belongs.
    topicId string
    The log topic ID to which the consumer belongs.
    topicName string
    The name of the log topic to which the consumption group belongs.
    consumer_group_name str
    The name of the consumer group.
    iam_project_name str
    IAM log project name.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    project_id str
    The log project ID to which the consumption group belongs.
    project_name str
    The name of the log item to which the consumption group belongs.
    topic_id str
    The log topic ID to which the consumer belongs.
    topic_name str
    The name of the log topic to which the consumption group belongs.
    consumerGroupName String
    The name of the consumer group.
    iamProjectName String
    IAM log project name.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    projectId String
    The log project ID to which the consumption group belongs.
    projectName String
    The name of the log item to which the consumption group belongs.
    topicId String
    The log topic ID to which the consumer belongs.
    topicName String
    The name of the log topic to which the consumption group belongs.

    ConsumerGroups Result

    The following output properties are available:

    ConsumerGroups List<ConsumerGroupsConsumerGroup>
    List of log service consumption groups.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    ConsumerGroupName string
    The name of the consumer group.
    IamProjectName string
    NameRegex string
    OutputFile string
    ProjectId string
    The log project ID to which the consumption group belongs.
    ProjectName string
    The name of the log item to which the consumption group belongs.
    TopicId string
    The list of log topic ids to be consumed by the consumer group.
    TopicName string
    ConsumerGroups []ConsumerGroupsConsumerGroup
    List of log service consumption groups.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    ConsumerGroupName string
    The name of the consumer group.
    IamProjectName string
    NameRegex string
    OutputFile string
    ProjectId string
    The log project ID to which the consumption group belongs.
    ProjectName string
    The name of the log item to which the consumption group belongs.
    TopicId string
    The list of log topic ids to be consumed by the consumer group.
    TopicName string
    consumerGroups List<ConsumerGroupsConsumerGroup>
    List of log service consumption groups.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    consumerGroupName String
    The name of the consumer group.
    iamProjectName String
    nameRegex String
    outputFile String
    projectId String
    The log project ID to which the consumption group belongs.
    projectName String
    The name of the log item to which the consumption group belongs.
    topicId String
    The list of log topic ids to be consumed by the consumer group.
    topicName String
    consumerGroups ConsumerGroupsConsumerGroup[]
    List of log service consumption groups.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    consumerGroupName string
    The name of the consumer group.
    iamProjectName string
    nameRegex string
    outputFile string
    projectId string
    The log project ID to which the consumption group belongs.
    projectName string
    The name of the log item to which the consumption group belongs.
    topicId string
    The list of log topic ids to be consumed by the consumer group.
    topicName string
    consumer_groups Sequence[ConsumerGroupsConsumerGroup]
    List of log service consumption groups.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    consumer_group_name str
    The name of the consumer group.
    iam_project_name str
    name_regex str
    output_file str
    project_id str
    The log project ID to which the consumption group belongs.
    project_name str
    The name of the log item to which the consumption group belongs.
    topic_id str
    The list of log topic ids to be consumed by the consumer group.
    topic_name str
    consumerGroups List<Property Map>
    List of log service consumption groups.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of query.
    consumerGroupName String
    The name of the consumer group.
    iamProjectName String
    nameRegex String
    outputFile String
    projectId String
    The log project ID to which the consumption group belongs.
    projectName String
    The name of the log item to which the consumption group belongs.
    topicId String
    The list of log topic ids to be consumed by the consumer group.
    topicName String

    Supporting Types

    ConsumerGroupsConsumerGroup

    ConsumerGroupName string
    The name of the consumer group.
    HeartbeatTtl int
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    OrderedConsume bool
    Whether to consume in sequence.
    ProjectId string
    The log project ID to which the consumption group belongs.
    ProjectName string
    The name of the log item to which the consumption group belongs.
    TopicIds List<string>
    The log topic ID to which the consumer belongs.
    ConsumerGroupName string
    The name of the consumer group.
    HeartbeatTtl int
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    OrderedConsume bool
    Whether to consume in sequence.
    ProjectId string
    The log project ID to which the consumption group belongs.
    ProjectName string
    The name of the log item to which the consumption group belongs.
    TopicIds []string
    The log topic ID to which the consumer belongs.
    consumerGroupName String
    The name of the consumer group.
    heartbeatTtl Integer
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    orderedConsume Boolean
    Whether to consume in sequence.
    projectId String
    The log project ID to which the consumption group belongs.
    projectName String
    The name of the log item to which the consumption group belongs.
    topicIds List<String>
    The log topic ID to which the consumer belongs.
    consumerGroupName string
    The name of the consumer group.
    heartbeatTtl number
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    orderedConsume boolean
    Whether to consume in sequence.
    projectId string
    The log project ID to which the consumption group belongs.
    projectName string
    The name of the log item to which the consumption group belongs.
    topicIds string[]
    The log topic ID to which the consumer belongs.
    consumer_group_name str
    The name of the consumer group.
    heartbeat_ttl int
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    ordered_consume bool
    Whether to consume in sequence.
    project_id str
    The log project ID to which the consumption group belongs.
    project_name str
    The name of the log item to which the consumption group belongs.
    topic_ids Sequence[str]
    The log topic ID to which the consumer belongs.
    consumerGroupName String
    The name of the consumer group.
    heartbeatTtl Number
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    orderedConsume Boolean
    Whether to consume in sequence.
    projectId String
    The log project ID to which the consumption group belongs.
    projectName String
    The name of the log item to which the consumption group belongs.
    topicIds List<String>
    The log topic ID to which the consumer belongs.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate