tencentcloud 1.81.189, Apr 30 25

tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getCkafkaTopics

Explore with Pulumi AI

tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

Example Usage

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

const example = tencentcloud.getCkafkaTopics({
    instanceId: "ckafka-vv7wp5nx",
    topicName: "tf_example",
});

import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_ckafka_topics(instance_id="ckafka-vv7wp5nx",
    topic_name="tf_example")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetCkafkaTopics(ctx, &tencentcloud.GetCkafkaTopicsArgs{
			InstanceId: "ckafka-vv7wp5nx",
			TopicName:  pulumi.StringRef("tf_example"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetCkafkaTopics.Invoke(new()
    {
        InstanceId = "ckafka-vv7wp5nx",
        TopicName = "tf_example",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetCkafkaTopicsArgs;
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 example = TencentcloudFunctions.getCkafkaTopics(GetCkafkaTopicsArgs.builder()
            .instanceId("ckafka-vv7wp5nx")
            .topicName("tf_example")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: tencentcloud:getCkafkaTopics
      arguments:
        instanceId: ckafka-vv7wp5nx
        topicName: tf_example

Using getCkafkaTopics

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 getCkafkaTopics(args: GetCkafkaTopicsArgs, opts?: InvokeOptions): Promise<GetCkafkaTopicsResult>
function getCkafkaTopicsOutput(args: GetCkafkaTopicsOutputArgs, opts?: InvokeOptions): Output<GetCkafkaTopicsResult>

def get_ckafka_topics(id: Optional[str] = None,
                      instance_id: Optional[str] = None,
                      result_output_file: Optional[str] = None,
                      topic_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCkafkaTopicsResult
def get_ckafka_topics_output(id: Optional[pulumi.Input[str]] = None,
                      instance_id: Optional[pulumi.Input[str]] = None,
                      result_output_file: Optional[pulumi.Input[str]] = None,
                      topic_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCkafkaTopicsResult]

func GetCkafkaTopics(ctx *Context, args *GetCkafkaTopicsArgs, opts ...InvokeOption) (*GetCkafkaTopicsResult, error)
func GetCkafkaTopicsOutput(ctx *Context, args *GetCkafkaTopicsOutputArgs, opts ...InvokeOption) GetCkafkaTopicsResultOutput

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

public static class GetCkafkaTopics 
{
    public static Task<GetCkafkaTopicsResult> InvokeAsync(GetCkafkaTopicsArgs args, InvokeOptions? opts = null)
    public static Output<GetCkafkaTopicsResult> Invoke(GetCkafkaTopicsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCkafkaTopicsResult> getCkafkaTopics(GetCkafkaTopicsArgs args, InvokeOptions options)
public static Output<GetCkafkaTopicsResult> getCkafkaTopics(GetCkafkaTopicsArgs args, InvokeOptions options)

fn::invoke:
  function: tencentcloud:index/getCkafkaTopics:getCkafkaTopics
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string: Ckafka instance ID.
Id string
ResultOutputFile string: Used to store results.
TopicName string: Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). The length range is from 1 to 64.

InstanceId string: Ckafka instance ID.
Id string
ResultOutputFile string: Used to store results.
TopicName string: Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). The length range is from 1 to 64.

instanceId String: Ckafka instance ID.
id String
resultOutputFile String: Used to store results.
topicName String: Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). The length range is from 1 to 64.

instanceId string: Ckafka instance ID.
id string
resultOutputFile string: Used to store results.
topicName string: Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). The length range is from 1 to 64.

instance_id str: Ckafka instance ID.
id str
result_output_file str: Used to store results.
topic_name str: Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). The length range is from 1 to 64.

instanceId String: Ckafka instance ID.
id String
resultOutputFile String: Used to store results.
topicName String: Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). The length range is from 1 to 64.

getCkafkaTopics Result

The following output properties are available:

Id string
InstanceId string
InstanceLists List<GetCkafkaTopicsInstanceList>: A list of instances. Each element contains the following attributes.
ResultOutputFile string
TopicName string: Name of the CKafka topic.

Id string
InstanceId string
InstanceLists []GetCkafkaTopicsInstanceList: A list of instances. Each element contains the following attributes.
ResultOutputFile string
TopicName string: Name of the CKafka topic.

id String
instanceId String
instanceLists List<GetCkafkaTopicsInstanceList>: A list of instances. Each element contains the following attributes.
resultOutputFile String
topicName String: Name of the CKafka topic.

id string
instanceId string
instanceLists GetCkafkaTopicsInstanceList[]: A list of instances. Each element contains the following attributes.
resultOutputFile string
topicName string: Name of the CKafka topic.

id str
instance_id str
instance_lists Sequence[GetCkafkaTopicsInstanceList]: A list of instances. Each element contains the following attributes.
result_output_file str
topic_name str: Name of the CKafka topic.

id String
instanceId String
instanceLists List<Property Map>: A list of instances. Each element contains the following attributes.
resultOutputFile String
topicName String: Name of the CKafka topic.

Supporting Types

GetCkafkaTopicsInstanceList

CleanUpPolicy string: Clear log policy, log clear mode. delete: logs are deleted according to the storage time, compact: logs are compressed according to the key, compact, delete: logs are compressed according to the key and will be deleted according to the storage time.
CreateTime string: Create time of the CKafka topic.
EnableWhiteList bool: Whether to open the IP Whitelist. true: open, false: close.
ForwardCosBucket string: Data backup cos bucket: the bucket address that is dumped to cos.
ForwardInterval double: Periodic frequency of data backup to cos.
ForwardStatus double: Data backup cos status. 1: do not open data backup, 0: open data backup.
IpWhiteListCount double: IP Whitelist count.
MaxMessageBytes double: Max message bytes.
Note string: CKafka topic note description.
PartitionNum double: The number of partition.
ReplicaNum double: The number of replica.
Retention double: Message can be selected. Retention time(unit ms).
Segment double: Segment scrolling time, in ms.
SegmentBytes double: Number of bytes rolled by shard.
SyncReplicaMinNum double: Min number of sync replicas.
TopicId string: ID of the CKafka topic.
TopicName string: Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). The length range is from 1 to 64.
UncleanLeaderElectionEnable bool: Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.

CleanUpPolicy string: Clear log policy, log clear mode. delete: logs are deleted according to the storage time, compact: logs are compressed according to the key, compact, delete: logs are compressed according to the key and will be deleted according to the storage time.
CreateTime string: Create time of the CKafka topic.
EnableWhiteList bool: Whether to open the IP Whitelist. true: open, false: close.
ForwardCosBucket string: Data backup cos bucket: the bucket address that is dumped to cos.
ForwardInterval float64: Periodic frequency of data backup to cos.
ForwardStatus float64: Data backup cos status. 1: do not open data backup, 0: open data backup.
IpWhiteListCount float64: IP Whitelist count.
MaxMessageBytes float64: Max message bytes.
Note string: CKafka topic note description.
PartitionNum float64: The number of partition.
ReplicaNum float64: The number of replica.
Retention float64: Message can be selected. Retention time(unit ms).
Segment float64: Segment scrolling time, in ms.
SegmentBytes float64: Number of bytes rolled by shard.
SyncReplicaMinNum float64: Min number of sync replicas.
TopicId string: ID of the CKafka topic.
TopicName string: Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). The length range is from 1 to 64.
UncleanLeaderElectionEnable bool: Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.

cleanUpPolicy String: Clear log policy, log clear mode. delete: logs are deleted according to the storage time, compact: logs are compressed according to the key, compact, delete: logs are compressed according to the key and will be deleted according to the storage time.
createTime String: Create time of the CKafka topic.
enableWhiteList Boolean: Whether to open the IP Whitelist. true: open, false: close.
forwardCosBucket String: Data backup cos bucket: the bucket address that is dumped to cos.
forwardInterval Double: Periodic frequency of data backup to cos.
forwardStatus Double: Data backup cos status. 1: do not open data backup, 0: open data backup.
ipWhiteListCount Double: IP Whitelist count.
maxMessageBytes Double: Max message bytes.
note String: CKafka topic note description.
partitionNum Double: The number of partition.
replicaNum Double: The number of replica.
retention Double: Message can be selected. Retention time(unit ms).
segment Double: Segment scrolling time, in ms.
segmentBytes Double: Number of bytes rolled by shard.
syncReplicaMinNum Double: Min number of sync replicas.
topicId String: ID of the CKafka topic.
topicName String: Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). The length range is from 1 to 64.
uncleanLeaderElectionEnable Boolean: Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.

cleanUpPolicy string: Clear log policy, log clear mode. delete: logs are deleted according to the storage time, compact: logs are compressed according to the key, compact, delete: logs are compressed according to the key and will be deleted according to the storage time.
createTime string: Create time of the CKafka topic.
enableWhiteList boolean: Whether to open the IP Whitelist. true: open, false: close.
forwardCosBucket string: Data backup cos bucket: the bucket address that is dumped to cos.
forwardInterval number: Periodic frequency of data backup to cos.
forwardStatus number: Data backup cos status. 1: do not open data backup, 0: open data backup.
ipWhiteListCount number: IP Whitelist count.
maxMessageBytes number: Max message bytes.
note string: CKafka topic note description.
partitionNum number: The number of partition.
replicaNum number: The number of replica.
retention number: Message can be selected. Retention time(unit ms).
segment number: Segment scrolling time, in ms.
segmentBytes number: Number of bytes rolled by shard.
syncReplicaMinNum number: Min number of sync replicas.
topicId string: ID of the CKafka topic.
topicName string: Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). The length range is from 1 to 64.
uncleanLeaderElectionEnable boolean: Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.

clean_up_policy str: Clear log policy, log clear mode. delete: logs are deleted according to the storage time, compact: logs are compressed according to the key, compact, delete: logs are compressed according to the key and will be deleted according to the storage time.
create_time str: Create time of the CKafka topic.
enable_white_list bool: Whether to open the IP Whitelist. true: open, false: close.
forward_cos_bucket str: Data backup cos bucket: the bucket address that is dumped to cos.
forward_interval float: Periodic frequency of data backup to cos.
forward_status float: Data backup cos status. 1: do not open data backup, 0: open data backup.
ip_white_list_count float: IP Whitelist count.
max_message_bytes float: Max message bytes.
note str: CKafka topic note description.
partition_num float: The number of partition.
replica_num float: The number of replica.
retention float: Message can be selected. Retention time(unit ms).
segment float: Segment scrolling time, in ms.
segment_bytes float: Number of bytes rolled by shard.
sync_replica_min_num float: Min number of sync replicas.
topic_id str: ID of the CKafka topic.
topic_name str: Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). The length range is from 1 to 64.
unclean_leader_election_enable bool: Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.

cleanUpPolicy String: Clear log policy, log clear mode. delete: logs are deleted according to the storage time, compact: logs are compressed according to the key, compact, delete: logs are compressed according to the key and will be deleted according to the storage time.
createTime String: Create time of the CKafka topic.
enableWhiteList Boolean: Whether to open the IP Whitelist. true: open, false: close.
forwardCosBucket String: Data backup cos bucket: the bucket address that is dumped to cos.
forwardInterval Number: Periodic frequency of data backup to cos.
forwardStatus Number: Data backup cos status. 1: do not open data backup, 0: open data backup.
ipWhiteListCount Number: IP Whitelist count.
maxMessageBytes Number: Max message bytes.
note String: CKafka topic note description.
partitionNum Number: The number of partition.
replicaNum Number: The number of replica.
retention Number: Message can be selected. Retention time(unit ms).
segment Number: Segment scrolling time, in ms.
segmentBytes Number: Number of bytes rolled by shard.
syncReplicaMinNum Number: Min number of sync replicas.
topicId String: ID of the CKafka topic.
topicName String: Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). The length range is from 1 to 64.
uncleanLeaderElectionEnable Boolean: Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.

Package Details

Repository: tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes: This Pulumi package is based on the tencentcloud Terraform Provider.

tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getCkafkaTopics

On this page

On this page

Example Usage

Using getCkafkaTopics

getCkafkaTopics Result

Supporting Types

GetCkafkaTopicsInstanceList

Package Details

On this page

On this page