1. Packages
  2. Volcengine
  3. API Docs
  4. tls
  5. getKafkaConsumers
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.tls.getKafkaConsumers

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of tls kafka consumers

    Example Usage

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

const default = volcengine.tls.getKafkaConsumers({
    ids: [
        "65d67d34-c5b4-4ec8-b3a9-175d33668b45",
        "cfb5c08b-0c7a-44fa-8971-8afc12f1b123",
        "edf051ed-3c46-49ba-9339-bea628fedc15",
    ],
});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.tls.get_kafka_consumers(ids=[
    "65d67d34-c5b4-4ec8-b3a9-175d33668b45",
    "cfb5c08b-0c7a-44fa-8971-8afc12f1b123",
    "edf051ed-3c46-49ba-9339-bea628fedc15",
])

    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 {
		_, err := tls.GetKafkaConsumers(ctx, &tls.GetKafkaConsumersArgs{
			Ids: []string{
				"65d67d34-c5b4-4ec8-b3a9-175d33668b45",
				"cfb5c08b-0c7a-44fa-8971-8afc12f1b123",
				"edf051ed-3c46-49ba-9339-bea628fedc15",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Tls.GetKafkaConsumers.Invoke(new()
    {
        Ids = new[]
        {
            "65d67d34-c5b4-4ec8-b3a9-175d33668b45",
            "cfb5c08b-0c7a-44fa-8971-8afc12f1b123",
            "edf051ed-3c46-49ba-9339-bea628fedc15",
        },
    });

});

    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.GetKafkaConsumersArgs;
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 default = TlsFunctions.getKafkaConsumers(GetKafkaConsumersArgs.builder()
            .ids(            
                "65d67d34-c5b4-4ec8-b3a9-175d33668b45",
                "cfb5c08b-0c7a-44fa-8971-8afc12f1b123",
                "edf051ed-3c46-49ba-9339-bea628fedc15")
            .build());

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:tls:getKafkaConsumers
      Arguments:
        ids:
          - 65d67d34-c5b4-4ec8-b3a9-175d33668b45
          - cfb5c08b-0c7a-44fa-8971-8afc12f1b123
          - edf051ed-3c46-49ba-9339-bea628fedc15

    Using getKafkaConsumers

    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 getKafkaConsumers(args: GetKafkaConsumersArgs, opts?: InvokeOptions): Promise<GetKafkaConsumersResult>
function getKafkaConsumersOutput(args: GetKafkaConsumersOutputArgs, opts?: InvokeOptions): Output<GetKafkaConsumersResult>
    def get_kafka_consumers(ids: Optional[Sequence[str]] = None,
                        output_file: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetKafkaConsumersResult
def get_kafka_consumers_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        output_file: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetKafkaConsumersResult]
    func GetKafkaConsumers(ctx *Context, args *GetKafkaConsumersArgs, opts ...InvokeOption) (*GetKafkaConsumersResult, error)
func GetKafkaConsumersOutput(ctx *Context, args *GetKafkaConsumersOutputArgs, opts ...InvokeOption) GetKafkaConsumersResultOutput

    > Note: This function is named GetKafkaConsumers in the Go SDK.

    public static class GetKafkaConsumers 
{
    public static Task<GetKafkaConsumersResult> InvokeAsync(GetKafkaConsumersArgs args, InvokeOptions? opts = null)
    public static Output<GetKafkaConsumersResult> Invoke(GetKafkaConsumersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKafkaConsumersResult> getKafkaConsumers(GetKafkaConsumersArgs args, InvokeOptions options)
public static Output<GetKafkaConsumersResult> getKafkaConsumers(GetKafkaConsumersArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:tls/getKafkaConsumers:getKafkaConsumers
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of topic IDs.
    OutputFile string
    File name where to save data source results.
    Ids []string
    A list of topic IDs.
    OutputFile string
    File name where to save data source results.
    ids List<String>
    A list of topic IDs.
    outputFile String
    File name where to save data source results.
    ids string[]
    A list of topic IDs.
    outputFile string
    File name where to save data source results.
    ids Sequence[str]
    A list of topic IDs.
    output_file str
    File name where to save data source results.
    ids List<String>
    A list of topic IDs.
    outputFile String
    File name where to save data source results.

    getKafkaConsumers Result

    The following output properties are available:

    Datas List<GetKafkaConsumersData>
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    Ids List<string>
    OutputFile string
    Datas []GetKafkaConsumersData
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    Ids []string
    OutputFile string
    datas List<GetKafkaConsumersData>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    ids List<String>
    outputFile String
    datas GetKafkaConsumersData[]
    The collection of query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    ids string[]
    outputFile string
    datas Sequence[GetKafkaConsumersData]
    The collection of query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    ids Sequence[str]
    output_file str
    datas List<Property Map>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of query.
    ids List<String>
    outputFile String

    Supporting Types

    GetKafkaConsumersData

    AllowConsume bool
    Whether allow consume.
    ConsumeTopic string
    The topic of consume.
    TopicId string
    The ID of Topic.
    AllowConsume bool
    Whether allow consume.
    ConsumeTopic string
    The topic of consume.
    TopicId string
    The ID of Topic.
    allowConsume Boolean
    Whether allow consume.
    consumeTopic String
    The topic of consume.
    topicId String
    The ID of Topic.
    allowConsume boolean
    Whether allow consume.
    consumeTopic string
    The topic of consume.
    topicId string
    The ID of Topic.
    allow_consume bool
    Whether allow consume.
    consume_topic str
    The topic of consume.
    topic_id str
    The ID of Topic.
    allowConsume Boolean
    Whether allow consume.
    consumeTopic String
    The topic of consume.
    topicId String
    The ID of Topic.

    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.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate