1. Packages
  2. Volcengine
  3. API Docs
  4. kafka
  5. getTopics
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
volcengine logo
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine

    Use this data source to query detailed information of kafka topics

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@pulumi/volcengine";
    import * as volcengine from "@volcengine/pulumi";
    
    const fooZones = volcengine.ecs.getZones({});
    const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
        vpcName: "acc-test-vpc",
        cidrBlock: "172.16.0.0/16",
    });
    const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
        subnetName: "acc-test-subnet",
        cidrBlock: "172.16.0.0/24",
        zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
        vpcId: fooVpc.id,
    });
    const fooInstance = new volcengine.kafka.Instance("fooInstance", {
        instanceName: "acc-test-kafka",
        instanceDescription: "tf-test",
        version: "2.2.2",
        computeSpec: "kafka.20xrate.hw",
        subnetId: fooSubnet.id,
        userName: "tf-user",
        userPassword: "tf-pass!@q1",
        chargeType: "PostPaid",
        storageSpace: 300,
        partitionNumber: 350,
        projectName: "default",
        tags: [{
            key: "k1",
            value: "v1",
        }],
        parameters: [
            {
                parameterName: "MessageMaxByte",
                parameterValue: "12",
            },
            {
                parameterName: "LogRetentionHours",
                parameterValue: "70",
            },
        ],
    });
    const fooSaslUser = new volcengine.kafka.SaslUser("fooSaslUser", {
        userName: "acc-test-user",
        instanceId: fooInstance.id,
        userPassword: "suqsnis123!",
        description: "tf-test",
        allAuthority: true,
        passwordType: "Scram",
    });
    const fooTopic = new volcengine.kafka.Topic("fooTopic", {
        topicName: "acc-test-topic",
        instanceId: fooInstance.id,
        description: "tf-test",
        partitionNumber: 15,
        replicaNumber: 3,
        parameters: {
            minInsyncReplicaNumber: 2,
            messageMaxByte: 10,
            logRetentionHours: 96,
        },
        allAuthority: false,
        accessPolicies: [{
            userName: fooSaslUser.userName,
            accessPolicy: "Pub",
        }],
    });
    const default = volcengine.kafka.getTopicsOutput({
        instanceId: fooTopic.instanceId,
    });
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo_zones = volcengine.ecs.get_zones()
    foo_vpc = volcengine.vpc.Vpc("fooVpc",
        vpc_name="acc-test-vpc",
        cidr_block="172.16.0.0/16")
    foo_subnet = volcengine.vpc.Subnet("fooSubnet",
        subnet_name="acc-test-subnet",
        cidr_block="172.16.0.0/24",
        zone_id=foo_zones.zones[0].id,
        vpc_id=foo_vpc.id)
    foo_instance = volcengine.kafka.Instance("fooInstance",
        instance_name="acc-test-kafka",
        instance_description="tf-test",
        version="2.2.2",
        compute_spec="kafka.20xrate.hw",
        subnet_id=foo_subnet.id,
        user_name="tf-user",
        user_password="tf-pass!@q1",
        charge_type="PostPaid",
        storage_space=300,
        partition_number=350,
        project_name="default",
        tags=[volcengine.kafka.InstanceTagArgs(
            key="k1",
            value="v1",
        )],
        parameters=[
            volcengine.kafka.InstanceParameterArgs(
                parameter_name="MessageMaxByte",
                parameter_value="12",
            ),
            volcengine.kafka.InstanceParameterArgs(
                parameter_name="LogRetentionHours",
                parameter_value="70",
            ),
        ])
    foo_sasl_user = volcengine.kafka.SaslUser("fooSaslUser",
        user_name="acc-test-user",
        instance_id=foo_instance.id,
        user_password="suqsnis123!",
        description="tf-test",
        all_authority=True,
        password_type="Scram")
    foo_topic = volcengine.kafka.Topic("fooTopic",
        topic_name="acc-test-topic",
        instance_id=foo_instance.id,
        description="tf-test",
        partition_number=15,
        replica_number=3,
        parameters=volcengine.kafka.TopicParametersArgs(
            min_insync_replica_number=2,
            message_max_byte=10,
            log_retention_hours=96,
        ),
        all_authority=False,
        access_policies=[volcengine.kafka.TopicAccessPolicyArgs(
            user_name=foo_sasl_user.user_name,
            access_policy="Pub",
        )])
    default = volcengine.kafka.get_topics_output(instance_id=foo_topic.instance_id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/kafka"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		fooZones, err := ecs.GetZones(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
    			VpcName:   pulumi.String("acc-test-vpc"),
    			CidrBlock: pulumi.String("172.16.0.0/16"),
    		})
    		if err != nil {
    			return err
    		}
    		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
    			SubnetName: pulumi.String("acc-test-subnet"),
    			CidrBlock:  pulumi.String("172.16.0.0/24"),
    			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
    			VpcId:      fooVpc.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		fooInstance, err := kafka.NewInstance(ctx, "fooInstance", &kafka.InstanceArgs{
    			InstanceName:        pulumi.String("acc-test-kafka"),
    			InstanceDescription: pulumi.String("tf-test"),
    			Version:             pulumi.String("2.2.2"),
    			ComputeSpec:         pulumi.String("kafka.20xrate.hw"),
    			SubnetId:            fooSubnet.ID(),
    			UserName:            pulumi.String("tf-user"),
    			UserPassword:        pulumi.String("tf-pass!@q1"),
    			ChargeType:          pulumi.String("PostPaid"),
    			StorageSpace:        pulumi.Int(300),
    			PartitionNumber:     pulumi.Int(350),
    			ProjectName:         pulumi.String("default"),
    			Tags: kafka.InstanceTagArray{
    				&kafka.InstanceTagArgs{
    					Key:   pulumi.String("k1"),
    					Value: pulumi.String("v1"),
    				},
    			},
    			Parameters: kafka.InstanceParameterArray{
    				&kafka.InstanceParameterArgs{
    					ParameterName:  pulumi.String("MessageMaxByte"),
    					ParameterValue: pulumi.String("12"),
    				},
    				&kafka.InstanceParameterArgs{
    					ParameterName:  pulumi.String("LogRetentionHours"),
    					ParameterValue: pulumi.String("70"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		fooSaslUser, err := kafka.NewSaslUser(ctx, "fooSaslUser", &kafka.SaslUserArgs{
    			UserName:     pulumi.String("acc-test-user"),
    			InstanceId:   fooInstance.ID(),
    			UserPassword: pulumi.String("suqsnis123!"),
    			Description:  pulumi.String("tf-test"),
    			AllAuthority: pulumi.Bool(true),
    			PasswordType: pulumi.String("Scram"),
    		})
    		if err != nil {
    			return err
    		}
    		fooTopic, err := kafka.NewTopic(ctx, "fooTopic", &kafka.TopicArgs{
    			TopicName:       pulumi.String("acc-test-topic"),
    			InstanceId:      fooInstance.ID(),
    			Description:     pulumi.String("tf-test"),
    			PartitionNumber: pulumi.Int(15),
    			ReplicaNumber:   pulumi.Int(3),
    			Parameters: &kafka.TopicParametersArgs{
    				MinInsyncReplicaNumber: pulumi.Int(2),
    				MessageMaxByte:         pulumi.Int(10),
    				LogRetentionHours:      pulumi.Int(96),
    			},
    			AllAuthority: pulumi.Bool(false),
    			AccessPolicies: kafka.TopicAccessPolicyArray{
    				&kafka.TopicAccessPolicyArgs{
    					UserName:     fooSaslUser.UserName,
    					AccessPolicy: pulumi.String("Pub"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_ = kafka.GetTopicsOutput(ctx, kafka.GetTopicsOutputArgs{
    			InstanceId: fooTopic.InstanceId,
    		}, nil)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var fooZones = Volcengine.Ecs.GetZones.Invoke();
    
        var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
        {
            VpcName = "acc-test-vpc",
            CidrBlock = "172.16.0.0/16",
        });
    
        var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
        {
            SubnetName = "acc-test-subnet",
            CidrBlock = "172.16.0.0/24",
            ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
            VpcId = fooVpc.Id,
        });
    
        var fooInstance = new Volcengine.Kafka.Instance("fooInstance", new()
        {
            InstanceName = "acc-test-kafka",
            InstanceDescription = "tf-test",
            Version = "2.2.2",
            ComputeSpec = "kafka.20xrate.hw",
            SubnetId = fooSubnet.Id,
            UserName = "tf-user",
            UserPassword = "tf-pass!@q1",
            ChargeType = "PostPaid",
            StorageSpace = 300,
            PartitionNumber = 350,
            ProjectName = "default",
            Tags = new[]
            {
                new Volcengine.Kafka.Inputs.InstanceTagArgs
                {
                    Key = "k1",
                    Value = "v1",
                },
            },
            Parameters = new[]
            {
                new Volcengine.Kafka.Inputs.InstanceParameterArgs
                {
                    ParameterName = "MessageMaxByte",
                    ParameterValue = "12",
                },
                new Volcengine.Kafka.Inputs.InstanceParameterArgs
                {
                    ParameterName = "LogRetentionHours",
                    ParameterValue = "70",
                },
            },
        });
    
        var fooSaslUser = new Volcengine.Kafka.SaslUser("fooSaslUser", new()
        {
            UserName = "acc-test-user",
            InstanceId = fooInstance.Id,
            UserPassword = "suqsnis123!",
            Description = "tf-test",
            AllAuthority = true,
            PasswordType = "Scram",
        });
    
        var fooTopic = new Volcengine.Kafka.Topic("fooTopic", new()
        {
            TopicName = "acc-test-topic",
            InstanceId = fooInstance.Id,
            Description = "tf-test",
            PartitionNumber = 15,
            ReplicaNumber = 3,
            Parameters = new Volcengine.Kafka.Inputs.TopicParametersArgs
            {
                MinInsyncReplicaNumber = 2,
                MessageMaxByte = 10,
                LogRetentionHours = 96,
            },
            AllAuthority = false,
            AccessPolicies = new[]
            {
                new Volcengine.Kafka.Inputs.TopicAccessPolicyArgs
                {
                    UserName = fooSaslUser.UserName,
                    AccessPolicy = "Pub",
                },
            },
        });
    
        var @default = Volcengine.Kafka.GetTopics.Invoke(new()
        {
            InstanceId = fooTopic.InstanceId,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.ecs.EcsFunctions;
    import com.pulumi.volcengine.ecs.inputs.GetZonesArgs;
    import com.pulumi.volcengine.vpc.Vpc;
    import com.pulumi.volcengine.vpc.VpcArgs;
    import com.pulumi.volcengine.vpc.Subnet;
    import com.pulumi.volcengine.vpc.SubnetArgs;
    import com.pulumi.volcengine.kafka.Instance;
    import com.pulumi.volcengine.kafka.InstanceArgs;
    import com.pulumi.volcengine.kafka.inputs.InstanceTagArgs;
    import com.pulumi.volcengine.kafka.inputs.InstanceParameterArgs;
    import com.pulumi.volcengine.kafka.SaslUser;
    import com.pulumi.volcengine.kafka.SaslUserArgs;
    import com.pulumi.volcengine.kafka.Topic;
    import com.pulumi.volcengine.kafka.TopicArgs;
    import com.pulumi.volcengine.kafka.inputs.TopicParametersArgs;
    import com.pulumi.volcengine.kafka.inputs.TopicAccessPolicyArgs;
    import com.pulumi.volcengine.kafka.KafkaFunctions;
    import com.pulumi.volcengine.kafka.inputs.GetTopicsArgs;
    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 fooZones = EcsFunctions.getZones();
    
            var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
                .vpcName("acc-test-vpc")
                .cidrBlock("172.16.0.0/16")
                .build());
    
            var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
                .subnetName("acc-test-subnet")
                .cidrBlock("172.16.0.0/24")
                .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .vpcId(fooVpc.id())
                .build());
    
            var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
                .instanceName("acc-test-kafka")
                .instanceDescription("tf-test")
                .version("2.2.2")
                .computeSpec("kafka.20xrate.hw")
                .subnetId(fooSubnet.id())
                .userName("tf-user")
                .userPassword("tf-pass!@q1")
                .chargeType("PostPaid")
                .storageSpace(300)
                .partitionNumber(350)
                .projectName("default")
                .tags(InstanceTagArgs.builder()
                    .key("k1")
                    .value("v1")
                    .build())
                .parameters(            
                    InstanceParameterArgs.builder()
                        .parameterName("MessageMaxByte")
                        .parameterValue("12")
                        .build(),
                    InstanceParameterArgs.builder()
                        .parameterName("LogRetentionHours")
                        .parameterValue("70")
                        .build())
                .build());
    
            var fooSaslUser = new SaslUser("fooSaslUser", SaslUserArgs.builder()        
                .userName("acc-test-user")
                .instanceId(fooInstance.id())
                .userPassword("suqsnis123!")
                .description("tf-test")
                .allAuthority(true)
                .passwordType("Scram")
                .build());
    
            var fooTopic = new Topic("fooTopic", TopicArgs.builder()        
                .topicName("acc-test-topic")
                .instanceId(fooInstance.id())
                .description("tf-test")
                .partitionNumber(15)
                .replicaNumber(3)
                .parameters(TopicParametersArgs.builder()
                    .minInsyncReplicaNumber(2)
                    .messageMaxByte(10)
                    .logRetentionHours(96)
                    .build())
                .allAuthority(false)
                .accessPolicies(TopicAccessPolicyArgs.builder()
                    .userName(fooSaslUser.userName())
                    .accessPolicy("Pub")
                    .build())
                .build());
    
            final var default = KafkaFunctions.getTopics(GetTopicsArgs.builder()
                .instanceId(fooTopic.instanceId())
                .build());
    
        }
    }
    
    resources:
      fooVpc:
        type: volcengine:vpc:Vpc
        properties:
          vpcName: acc-test-vpc
          cidrBlock: 172.16.0.0/16
      fooSubnet:
        type: volcengine:vpc:Subnet
        properties:
          subnetName: acc-test-subnet
          cidrBlock: 172.16.0.0/24
          zoneId: ${fooZones.zones[0].id}
          vpcId: ${fooVpc.id}
      fooInstance:
        type: volcengine:kafka:Instance
        properties:
          instanceName: acc-test-kafka
          instanceDescription: tf-test
          version: 2.2.2
          computeSpec: kafka.20xrate.hw
          subnetId: ${fooSubnet.id}
          userName: tf-user
          userPassword: tf-pass!@q1
          chargeType: PostPaid
          storageSpace: 300
          partitionNumber: 350
          projectName: default
          tags:
            - key: k1
              value: v1
          parameters:
            - parameterName: MessageMaxByte
              parameterValue: '12'
            - parameterName: LogRetentionHours
              parameterValue: '70'
      fooSaslUser:
        type: volcengine:kafka:SaslUser
        properties:
          userName: acc-test-user
          instanceId: ${fooInstance.id}
          userPassword: suqsnis123!
          description: tf-test
          allAuthority: true
          passwordType: Scram
      fooTopic:
        type: volcengine:kafka:Topic
        properties:
          topicName: acc-test-topic
          instanceId: ${fooInstance.id}
          description: tf-test
          partitionNumber: 15
          replicaNumber: 3
          parameters:
            minInsyncReplicaNumber: 2
            messageMaxByte: 10
            logRetentionHours: 96
          allAuthority: false
          accessPolicies:
            - userName: ${fooSaslUser.userName}
              accessPolicy: Pub
    variables:
      fooZones:
        fn::invoke:
          Function: volcengine:ecs:getZones
          Arguments: {}
      default:
        fn::invoke:
          Function: volcengine:kafka:getTopics
          Arguments:
            instanceId: ${fooTopic.instanceId}
    

    Using getTopics

    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 getTopics(args: GetTopicsArgs, opts?: InvokeOptions): Promise<GetTopicsResult>
    function getTopicsOutput(args: GetTopicsOutputArgs, opts?: InvokeOptions): Output<GetTopicsResult>
    def get_topics(instance_id: Optional[str] = None,
                   name_regex: Optional[str] = None,
                   output_file: Optional[str] = None,
                   partition_number: Optional[int] = None,
                   replica_number: Optional[int] = None,
                   tags: Optional[Sequence[GetTopicsTag]] = None,
                   topic_name: Optional[str] = None,
                   user_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetTopicsResult
    def get_topics_output(instance_id: Optional[pulumi.Input[str]] = None,
                   name_regex: Optional[pulumi.Input[str]] = None,
                   output_file: Optional[pulumi.Input[str]] = None,
                   partition_number: Optional[pulumi.Input[int]] = None,
                   replica_number: Optional[pulumi.Input[int]] = None,
                   tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetTopicsTagArgs]]]] = None,
                   topic_name: Optional[pulumi.Input[str]] = None,
                   user_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetTopicsResult]
    func GetTopics(ctx *Context, args *GetTopicsArgs, opts ...InvokeOption) (*GetTopicsResult, error)
    func GetTopicsOutput(ctx *Context, args *GetTopicsOutputArgs, opts ...InvokeOption) GetTopicsResultOutput

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

    public static class GetTopics 
    {
        public static Task<GetTopicsResult> InvokeAsync(GetTopicsArgs args, InvokeOptions? opts = null)
        public static Output<GetTopicsResult> Invoke(GetTopicsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTopicsResult> getTopics(GetTopicsArgs args, InvokeOptions options)
    public static Output<GetTopicsResult> getTopics(GetTopicsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcengine:kafka/getTopics:getTopics
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The id of kafka instance.
    NameRegex string
    A Name Regex of kafka topic.
    OutputFile string
    File name where to save data source results.
    PartitionNumber int
    The number of partition in kafka topic.
    ReplicaNumber int
    The number of replica in kafka topic.
    Tags List<GetTopicsTag>
    Tags.
    TopicName string
    The name of kafka topic. This field supports fuzzy query.
    UserName string
    When a user name is specified, only the access policy of the specified user for this Topic will be returned.
    InstanceId string
    The id of kafka instance.
    NameRegex string
    A Name Regex of kafka topic.
    OutputFile string
    File name where to save data source results.
    PartitionNumber int
    The number of partition in kafka topic.
    ReplicaNumber int
    The number of replica in kafka topic.
    Tags []GetTopicsTag
    Tags.
    TopicName string
    The name of kafka topic. This field supports fuzzy query.
    UserName string
    When a user name is specified, only the access policy of the specified user for this Topic will be returned.
    instanceId String
    The id of kafka instance.
    nameRegex String
    A Name Regex of kafka topic.
    outputFile String
    File name where to save data source results.
    partitionNumber Integer
    The number of partition in kafka topic.
    replicaNumber Integer
    The number of replica in kafka topic.
    tags List<GetTopicsTag>
    Tags.
    topicName String
    The name of kafka topic. This field supports fuzzy query.
    userName String
    When a user name is specified, only the access policy of the specified user for this Topic will be returned.
    instanceId string
    The id of kafka instance.
    nameRegex string
    A Name Regex of kafka topic.
    outputFile string
    File name where to save data source results.
    partitionNumber number
    The number of partition in kafka topic.
    replicaNumber number
    The number of replica in kafka topic.
    tags GetTopicsTag[]
    Tags.
    topicName string
    The name of kafka topic. This field supports fuzzy query.
    userName string
    When a user name is specified, only the access policy of the specified user for this Topic will be returned.
    instance_id str
    The id of kafka instance.
    name_regex str
    A Name Regex of kafka topic.
    output_file str
    File name where to save data source results.
    partition_number int
    The number of partition in kafka topic.
    replica_number int
    The number of replica in kafka topic.
    tags Sequence[GetTopicsTag]
    Tags.
    topic_name str
    The name of kafka topic. This field supports fuzzy query.
    user_name str
    When a user name is specified, only the access policy of the specified user for this Topic will be returned.
    instanceId String
    The id of kafka instance.
    nameRegex String
    A Name Regex of kafka topic.
    outputFile String
    File name where to save data source results.
    partitionNumber Number
    The number of partition in kafka topic.
    replicaNumber Number
    The number of replica in kafka topic.
    tags List<Property Map>
    Tags.
    topicName String
    The name of kafka topic. This field supports fuzzy query.
    userName String
    When a user name is specified, only the access policy of the specified user for this Topic will be returned.

    getTopics Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Topics List<GetTopicsTopic>
    The collection of query.
    TotalCount int
    The total count of query.
    NameRegex string
    OutputFile string
    PartitionNumber int
    The number of partition in the kafka topic.
    ReplicaNumber int
    The number of replica in the kafka topic.
    Tags List<GetTopicsTag>
    Tags.
    TopicName string
    The name of the kafka topic.
    UserName string
    The name of SASL user.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Topics []GetTopicsTopic
    The collection of query.
    TotalCount int
    The total count of query.
    NameRegex string
    OutputFile string
    PartitionNumber int
    The number of partition in the kafka topic.
    ReplicaNumber int
    The number of replica in the kafka topic.
    Tags []GetTopicsTag
    Tags.
    TopicName string
    The name of the kafka topic.
    UserName string
    The name of SASL user.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    topics List<GetTopicsTopic>
    The collection of query.
    totalCount Integer
    The total count of query.
    nameRegex String
    outputFile String
    partitionNumber Integer
    The number of partition in the kafka topic.
    replicaNumber Integer
    The number of replica in the kafka topic.
    tags List<GetTopicsTag>
    Tags.
    topicName String
    The name of the kafka topic.
    userName String
    The name of SASL user.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    topics GetTopicsTopic[]
    The collection of query.
    totalCount number
    The total count of query.
    nameRegex string
    outputFile string
    partitionNumber number
    The number of partition in the kafka topic.
    replicaNumber number
    The number of replica in the kafka topic.
    tags GetTopicsTag[]
    Tags.
    topicName string
    The name of the kafka topic.
    userName string
    The name of SASL user.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    topics Sequence[GetTopicsTopic]
    The collection of query.
    total_count int
    The total count of query.
    name_regex str
    output_file str
    partition_number int
    The number of partition in the kafka topic.
    replica_number int
    The number of replica in the kafka topic.
    tags Sequence[GetTopicsTag]
    Tags.
    topic_name str
    The name of the kafka topic.
    user_name str
    The name of SASL user.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    topics List<Property Map>
    The collection of query.
    totalCount Number
    The total count of query.
    nameRegex String
    outputFile String
    partitionNumber Number
    The number of partition in the kafka topic.
    replicaNumber Number
    The number of replica in the kafka topic.
    tags List<Property Map>
    Tags.
    topicName String
    The name of the kafka topic.
    userName String
    The name of SASL user.

    Supporting Types

    GetTopicsTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    GetTopicsTopic

    AccessPolicies List<GetTopicsTopicAccessPolicy>
    The access policies info of the kafka topic.
    AllAuthority bool
    Whether the kafka topic is configured to be accessible by all users.
    CleanupPolicies List<string>
    The cleanup policy of the kafka topic.
    CreateTime string
    The create time of the kafka topic.
    Description string
    The description of the kafka topic.
    LogRetentionHours int
    The retention hours of log.
    Parameters GetTopicsTopicParameters
    The parameters of the kafka topic.
    PartitionNumber int
    The number of partition in kafka topic.
    ReplicaNumber int
    The number of replica in kafka topic.
    Status string
    The status of the kafka topic.
    Tags List<GetTopicsTopicTag>
    Tags.
    TopicName string
    The name of kafka topic. This field supports fuzzy query.
    UsedStoragePercentageInInstance int
    The used storage percentage in instance.
    UsedStorageSpaceInBytes int
    The total storage space size already used by the current Topic.
    AccessPolicies []GetTopicsTopicAccessPolicy
    The access policies info of the kafka topic.
    AllAuthority bool
    Whether the kafka topic is configured to be accessible by all users.
    CleanupPolicies []string
    The cleanup policy of the kafka topic.
    CreateTime string
    The create time of the kafka topic.
    Description string
    The description of the kafka topic.
    LogRetentionHours int
    The retention hours of log.
    Parameters GetTopicsTopicParameters
    The parameters of the kafka topic.
    PartitionNumber int
    The number of partition in kafka topic.
    ReplicaNumber int
    The number of replica in kafka topic.
    Status string
    The status of the kafka topic.
    Tags []GetTopicsTopicTag
    Tags.
    TopicName string
    The name of kafka topic. This field supports fuzzy query.
    UsedStoragePercentageInInstance int
    The used storage percentage in instance.
    UsedStorageSpaceInBytes int
    The total storage space size already used by the current Topic.
    accessPolicies List<GetTopicsTopicAccessPolicy>
    The access policies info of the kafka topic.
    allAuthority Boolean
    Whether the kafka topic is configured to be accessible by all users.
    cleanupPolicies List<String>
    The cleanup policy of the kafka topic.
    createTime String
    The create time of the kafka topic.
    description String
    The description of the kafka topic.
    logRetentionHours Integer
    The retention hours of log.
    parameters GetTopicsTopicParameters
    The parameters of the kafka topic.
    partitionNumber Integer
    The number of partition in kafka topic.
    replicaNumber Integer
    The number of replica in kafka topic.
    status String
    The status of the kafka topic.
    tags List<GetTopicsTopicTag>
    Tags.
    topicName String
    The name of kafka topic. This field supports fuzzy query.
    usedStoragePercentageInInstance Integer
    The used storage percentage in instance.
    usedStorageSpaceInBytes Integer
    The total storage space size already used by the current Topic.
    accessPolicies GetTopicsTopicAccessPolicy[]
    The access policies info of the kafka topic.
    allAuthority boolean
    Whether the kafka topic is configured to be accessible by all users.
    cleanupPolicies string[]
    The cleanup policy of the kafka topic.
    createTime string
    The create time of the kafka topic.
    description string
    The description of the kafka topic.
    logRetentionHours number
    The retention hours of log.
    parameters GetTopicsTopicParameters
    The parameters of the kafka topic.
    partitionNumber number
    The number of partition in kafka topic.
    replicaNumber number
    The number of replica in kafka topic.
    status string
    The status of the kafka topic.
    tags GetTopicsTopicTag[]
    Tags.
    topicName string
    The name of kafka topic. This field supports fuzzy query.
    usedStoragePercentageInInstance number
    The used storage percentage in instance.
    usedStorageSpaceInBytes number
    The total storage space size already used by the current Topic.
    access_policies Sequence[GetTopicsTopicAccessPolicy]
    The access policies info of the kafka topic.
    all_authority bool
    Whether the kafka topic is configured to be accessible by all users.
    cleanup_policies Sequence[str]
    The cleanup policy of the kafka topic.
    create_time str
    The create time of the kafka topic.
    description str
    The description of the kafka topic.
    log_retention_hours int
    The retention hours of log.
    parameters GetTopicsTopicParameters
    The parameters of the kafka topic.
    partition_number int
    The number of partition in kafka topic.
    replica_number int
    The number of replica in kafka topic.
    status str
    The status of the kafka topic.
    tags Sequence[GetTopicsTopicTag]
    Tags.
    topic_name str
    The name of kafka topic. This field supports fuzzy query.
    used_storage_percentage_in_instance int
    The used storage percentage in instance.
    used_storage_space_in_bytes int
    The total storage space size already used by the current Topic.
    accessPolicies List<Property Map>
    The access policies info of the kafka topic.
    allAuthority Boolean
    Whether the kafka topic is configured to be accessible by all users.
    cleanupPolicies List<String>
    The cleanup policy of the kafka topic.
    createTime String
    The create time of the kafka topic.
    description String
    The description of the kafka topic.
    logRetentionHours Number
    The retention hours of log.
    parameters Property Map
    The parameters of the kafka topic.
    partitionNumber Number
    The number of partition in kafka topic.
    replicaNumber Number
    The number of replica in kafka topic.
    status String
    The status of the kafka topic.
    tags List<Property Map>
    Tags.
    topicName String
    The name of kafka topic. This field supports fuzzy query.
    usedStoragePercentageInInstance Number
    The used storage percentage in instance.
    usedStorageSpaceInBytes Number
    The total storage space size already used by the current Topic.

    GetTopicsTopicAccessPolicy

    AccessPolicy string
    The access policy of SASL user.
    UserName string
    When a user name is specified, only the access policy of the specified user for this Topic will be returned.
    AccessPolicy string
    The access policy of SASL user.
    UserName string
    When a user name is specified, only the access policy of the specified user for this Topic will be returned.
    accessPolicy String
    The access policy of SASL user.
    userName String
    When a user name is specified, only the access policy of the specified user for this Topic will be returned.
    accessPolicy string
    The access policy of SASL user.
    userName string
    When a user name is specified, only the access policy of the specified user for this Topic will be returned.
    access_policy str
    The access policy of SASL user.
    user_name str
    When a user name is specified, only the access policy of the specified user for this Topic will be returned.
    accessPolicy String
    The access policy of SASL user.
    userName String
    When a user name is specified, only the access policy of the specified user for this Topic will be returned.

    GetTopicsTopicParameters

    LogRetentionHours int
    The retention hours of log.
    MessageMaxByte int
    The max byte of message.
    MinInsyncReplicaNumber int
    The min number of sync replica.
    LogRetentionHours int
    The retention hours of log.
    MessageMaxByte int
    The max byte of message.
    MinInsyncReplicaNumber int
    The min number of sync replica.
    logRetentionHours Integer
    The retention hours of log.
    messageMaxByte Integer
    The max byte of message.
    minInsyncReplicaNumber Integer
    The min number of sync replica.
    logRetentionHours number
    The retention hours of log.
    messageMaxByte number
    The max byte of message.
    minInsyncReplicaNumber number
    The min number of sync replica.
    log_retention_hours int
    The retention hours of log.
    message_max_byte int
    The max byte of message.
    min_insync_replica_number int
    The min number of sync replica.
    logRetentionHours Number
    The retention hours of log.
    messageMaxByte Number
    The max byte of message.
    minInsyncReplicaNumber Number
    The min number of sync replica.

    GetTopicsTopicTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Viewing docs for Volcengine v0.0.47
    published on Friday, Mar 13, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.