Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. CkafkaTopic
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.CkafkaTopic

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Use this resource to create ckafka topic.

    Example Usage

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

const example = new tencentcloud.CkafkaTopic("example", {
    cleanUpPolicy: "delete",
    enableWhiteList: true,
    instanceId: "ckafka-bzmjpavn",
    ipWhiteLists: [
        "1.1.1.1",
        "2.2.2.2",
    ],
    maxMessageBytes: 4096,
    note: "topic note",
    partitionNum: 2,
    replicaNum: 4,
    retention: 60000,
    segment: 86400000,
    syncReplicaMinNum: 2,
    topicName: "tf-example",
    uncleanLeaderElectionEnable: false,
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.CkafkaTopic("example",
    clean_up_policy="delete",
    enable_white_list=True,
    instance_id="ckafka-bzmjpavn",
    ip_white_lists=[
        "1.1.1.1",
        "2.2.2.2",
    ],
    max_message_bytes=4096,
    note="topic note",
    partition_num=2,
    replica_num=4,
    retention=60000,
    segment=86400000,
    sync_replica_min_num=2,
    topic_name="tf-example",
    unclean_leader_election_enable=False)

    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.NewCkafkaTopic(ctx, "example", &tencentcloud.CkafkaTopicArgs{
			CleanUpPolicy:   pulumi.String("delete"),
			EnableWhiteList: pulumi.Bool(true),
			InstanceId:      pulumi.String("ckafka-bzmjpavn"),
			IpWhiteLists: pulumi.StringArray{
				pulumi.String("1.1.1.1"),
				pulumi.String("2.2.2.2"),
			},
			MaxMessageBytes:             pulumi.Float64(4096),
			Note:                        pulumi.String("topic note"),
			PartitionNum:                pulumi.Float64(2),
			ReplicaNum:                  pulumi.Float64(4),
			Retention:                   pulumi.Float64(60000),
			Segment:                     pulumi.Float64(86400000),
			SyncReplicaMinNum:           pulumi.Float64(2),
			TopicName:                   pulumi.String("tf-example"),
			UncleanLeaderElectionEnable: pulumi.Bool(false),
		})
		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 = new Tencentcloud.CkafkaTopic("example", new()
    {
        CleanUpPolicy = "delete",
        EnableWhiteList = true,
        InstanceId = "ckafka-bzmjpavn",
        IpWhiteLists = new[]
        {
            "1.1.1.1",
            "2.2.2.2",
        },
        MaxMessageBytes = 4096,
        Note = "topic note",
        PartitionNum = 2,
        ReplicaNum = 4,
        Retention = 60000,
        Segment = 86400000,
        SyncReplicaMinNum = 2,
        TopicName = "tf-example",
        UncleanLeaderElectionEnable = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.CkafkaTopic;
import com.pulumi.tencentcloud.CkafkaTopicArgs;
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 example = new CkafkaTopic("example", CkafkaTopicArgs.builder()
            .cleanUpPolicy("delete")
            .enableWhiteList(true)
            .instanceId("ckafka-bzmjpavn")
            .ipWhiteLists(            
                "1.1.1.1",
                "2.2.2.2")
            .maxMessageBytes(4096)
            .note("topic note")
            .partitionNum(2)
            .replicaNum(4)
            .retention(60000)
            .segment(86400000)
            .syncReplicaMinNum(2)
            .topicName("tf-example")
            .uncleanLeaderElectionEnable(false)
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:CkafkaTopic
    properties:
      cleanUpPolicy: delete
      enableWhiteList: true
      instanceId: ckafka-bzmjpavn
      ipWhiteLists:
        - 1.1.1.1
        - 2.2.2.2
      maxMessageBytes: 4096
      note: topic note
      partitionNum: 2
      replicaNum: 4
      retention: 60000
      segment: 8.64e+07
      syncReplicaMinNum: 2
      topicName: tf-example
      uncleanLeaderElectionEnable: false

    Create CkafkaTopic Resource

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

    Constructor syntax

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

@overload
def CkafkaTopic(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                partition_num: Optional[float] = None,
                topic_name: Optional[str] = None,
                replica_num: Optional[float] = None,
                instance_id: Optional[str] = None,
                note: Optional[str] = None,
                max_message_bytes: Optional[float] = None,
                ckafka_topic_id: Optional[str] = None,
                ip_white_lists: Optional[Sequence[str]] = None,
                enable_white_list: Optional[bool] = None,
                retention: Optional[float] = None,
                segment: Optional[float] = None,
                sync_replica_min_num: Optional[float] = None,
                clean_up_policy: Optional[str] = None,
                unclean_leader_election_enable: Optional[bool] = None)
    func NewCkafkaTopic(ctx *Context, name string, args CkafkaTopicArgs, opts ...ResourceOption) (*CkafkaTopic, error)
    public CkafkaTopic(string name, CkafkaTopicArgs args, CustomResourceOptions? opts = null)
    public CkafkaTopic(String name, CkafkaTopicArgs args)
public CkafkaTopic(String name, CkafkaTopicArgs args, CustomResourceOptions options)

    type: tencentcloud:CkafkaTopic
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 CkafkaTopicArgs
    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 CkafkaTopicArgs
    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 CkafkaTopicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CkafkaTopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CkafkaTopicArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    InstanceId string
    Ckafka instance ID.
    PartitionNum double
    The number of partition.
    ReplicaNum double
    The number of replica.
    TopicName string
    Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-).
    CkafkaTopicId string
    ID of the resource.
    CleanUpPolicy string
    Clear log policy, log clear mode, default is delete. 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.
    EnableWhiteList bool
    Whether to open the ip whitelist, true: open, false: close.
    IpWhiteLists List<string>
    Ip whitelist, quota limit, required when enableWhileList=true.
    MaxMessageBytes double
    Max message bytes. min: 1024 Byte(1KB), max: 8388608 Byte(8MB).
    Note string
    The subject note. It must start with a letter, and the remaining part can contain letters, numbers and dashes (-).
    Retention double
    Message can be selected. Retention time, unit is ms, the current minimum value is 60000ms.
    Segment double
    Segment scrolling time, in ms, the current minimum is 3600000ms.
    SyncReplicaMinNum double
    Min number of sync replicas, Default is 1.
    UncleanLeaderElectionEnable bool
    Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.
    InstanceId string
    Ckafka instance ID.
    PartitionNum float64
    The number of partition.
    ReplicaNum float64
    The number of replica.
    TopicName string
    Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-).
    CkafkaTopicId string
    ID of the resource.
    CleanUpPolicy string
    Clear log policy, log clear mode, default is delete. 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.
    EnableWhiteList bool
    Whether to open the ip whitelist, true: open, false: close.
    IpWhiteLists []string
    Ip whitelist, quota limit, required when enableWhileList=true.
    MaxMessageBytes float64
    Max message bytes. min: 1024 Byte(1KB), max: 8388608 Byte(8MB).
    Note string
    The subject note. It must start with a letter, and the remaining part can contain letters, numbers and dashes (-).
    Retention float64
    Message can be selected. Retention time, unit is ms, the current minimum value is 60000ms.
    Segment float64
    Segment scrolling time, in ms, the current minimum is 3600000ms.
    SyncReplicaMinNum float64
    Min number of sync replicas, Default is 1.
    UncleanLeaderElectionEnable bool
    Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.
    instanceId String
    Ckafka instance ID.
    partitionNum Double
    The number of partition.
    replicaNum Double
    The number of replica.
    topicName String
    Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-).
    ckafkaTopicId String
    ID of the resource.
    cleanUpPolicy String
    Clear log policy, log clear mode, default is delete. 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.
    enableWhiteList Boolean
    Whether to open the ip whitelist, true: open, false: close.
    ipWhiteLists List<String>
    Ip whitelist, quota limit, required when enableWhileList=true.
    maxMessageBytes Double
    Max message bytes. min: 1024 Byte(1KB), max: 8388608 Byte(8MB).
    note String
    The subject note. It must start with a letter, and the remaining part can contain letters, numbers and dashes (-).
    retention Double
    Message can be selected. Retention time, unit is ms, the current minimum value is 60000ms.
    segment Double
    Segment scrolling time, in ms, the current minimum is 3600000ms.
    syncReplicaMinNum Double
    Min number of sync replicas, Default is 1.
    uncleanLeaderElectionEnable Boolean
    Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.
    instanceId string
    Ckafka instance ID.
    partitionNum number
    The number of partition.
    replicaNum number
    The number of replica.
    topicName string
    Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-).
    ckafkaTopicId string
    ID of the resource.
    cleanUpPolicy string
    Clear log policy, log clear mode, default is delete. 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.
    enableWhiteList boolean
    Whether to open the ip whitelist, true: open, false: close.
    ipWhiteLists string[]
    Ip whitelist, quota limit, required when enableWhileList=true.
    maxMessageBytes number
    Max message bytes. min: 1024 Byte(1KB), max: 8388608 Byte(8MB).
    note string
    The subject note. It must start with a letter, and the remaining part can contain letters, numbers and dashes (-).
    retention number
    Message can be selected. Retention time, unit is ms, the current minimum value is 60000ms.
    segment number
    Segment scrolling time, in ms, the current minimum is 3600000ms.
    syncReplicaMinNum number
    Min number of sync replicas, Default is 1.
    uncleanLeaderElectionEnable boolean
    Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.
    instance_id str
    Ckafka instance ID.
    partition_num float
    The number of partition.
    replica_num float
    The number of replica.
    topic_name str
    Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-).
    ckafka_topic_id str
    ID of the resource.
    clean_up_policy str
    Clear log policy, log clear mode, default is delete. 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.
    enable_white_list bool
    Whether to open the ip whitelist, true: open, false: close.
    ip_white_lists Sequence[str]
    Ip whitelist, quota limit, required when enableWhileList=true.
    max_message_bytes float
    Max message bytes. min: 1024 Byte(1KB), max: 8388608 Byte(8MB).
    note str
    The subject note. It must start with a letter, and the remaining part can contain letters, numbers and dashes (-).
    retention float
    Message can be selected. Retention time, unit is ms, the current minimum value is 60000ms.
    segment float
    Segment scrolling time, in ms, the current minimum is 3600000ms.
    sync_replica_min_num float
    Min number of sync replicas, Default is 1.
    unclean_leader_election_enable bool
    Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.
    instanceId String
    Ckafka instance ID.
    partitionNum Number
    The number of partition.
    replicaNum Number
    The number of replica.
    topicName String
    Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-).
    ckafkaTopicId String
    ID of the resource.
    cleanUpPolicy String
    Clear log policy, log clear mode, default is delete. 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.
    enableWhiteList Boolean
    Whether to open the ip whitelist, true: open, false: close.
    ipWhiteLists List<String>
    Ip whitelist, quota limit, required when enableWhileList=true.
    maxMessageBytes Number
    Max message bytes. min: 1024 Byte(1KB), max: 8388608 Byte(8MB).
    note String
    The subject note. It must start with a letter, and the remaining part can contain letters, numbers and dashes (-).
    retention Number
    Message can be selected. Retention time, unit is ms, the current minimum value is 60000ms.
    segment Number
    Segment scrolling time, in ms, the current minimum is 3600000ms.
    syncReplicaMinNum Number
    Min number of sync replicas, Default is 1.
    uncleanLeaderElectionEnable Boolean
    Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.

    Outputs

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

    CreateTime string
    Create time of the CKafka topic.
    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. Valid values: 0, 1. 1: do not open data backup, 0: open data backup.
    Id string
    The provider-assigned unique ID for this managed resource.
    MessageStorageLocation string
    Message storage location.
    SegmentBytes double
    Number of bytes rolled by shard.
    CreateTime string
    Create time of the CKafka topic.
    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. Valid values: 0, 1. 1: do not open data backup, 0: open data backup.
    Id string
    The provider-assigned unique ID for this managed resource.
    MessageStorageLocation string
    Message storage location.
    SegmentBytes float64
    Number of bytes rolled by shard.
    createTime String
    Create time of the CKafka topic.
    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. Valid values: 0, 1. 1: do not open data backup, 0: open data backup.
    id String
    The provider-assigned unique ID for this managed resource.
    messageStorageLocation String
    Message storage location.
    segmentBytes Double
    Number of bytes rolled by shard.
    createTime string
    Create time of the CKafka topic.
    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. Valid values: 0, 1. 1: do not open data backup, 0: open data backup.
    id string
    The provider-assigned unique ID for this managed resource.
    messageStorageLocation string
    Message storage location.
    segmentBytes number
    Number of bytes rolled by shard.
    create_time str
    Create time of the CKafka topic.
    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. Valid values: 0, 1. 1: do not open data backup, 0: open data backup.
    id str
    The provider-assigned unique ID for this managed resource.
    message_storage_location str
    Message storage location.
    segment_bytes float
    Number of bytes rolled by shard.
    createTime String
    Create time of the CKafka topic.
    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. Valid values: 0, 1. 1: do not open data backup, 0: open data backup.
    id String
    The provider-assigned unique ID for this managed resource.
    messageStorageLocation String
    Message storage location.
    segmentBytes Number
    Number of bytes rolled by shard.

    Look up Existing CkafkaTopic Resource

    Get an existing CkafkaTopic 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?: CkafkaTopicState, opts?: CustomResourceOptions): CkafkaTopic
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ckafka_topic_id: Optional[str] = None,
        clean_up_policy: Optional[str] = None,
        create_time: Optional[str] = None,
        enable_white_list: Optional[bool] = None,
        forward_cos_bucket: Optional[str] = None,
        forward_interval: Optional[float] = None,
        forward_status: Optional[float] = None,
        instance_id: Optional[str] = None,
        ip_white_lists: Optional[Sequence[str]] = None,
        max_message_bytes: Optional[float] = None,
        message_storage_location: Optional[str] = None,
        note: Optional[str] = None,
        partition_num: Optional[float] = None,
        replica_num: Optional[float] = None,
        retention: Optional[float] = None,
        segment: Optional[float] = None,
        segment_bytes: Optional[float] = None,
        sync_replica_min_num: Optional[float] = None,
        topic_name: Optional[str] = None,
        unclean_leader_election_enable: Optional[bool] = None) -> CkafkaTopic
    func GetCkafkaTopic(ctx *Context, name string, id IDInput, state *CkafkaTopicState, opts ...ResourceOption) (*CkafkaTopic, error)
    public static CkafkaTopic Get(string name, Input<string> id, CkafkaTopicState? state, CustomResourceOptions? opts = null)
    public static CkafkaTopic get(String name, Output<String> id, CkafkaTopicState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:CkafkaTopic    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:
    CkafkaTopicId string
    ID of the resource.
    CleanUpPolicy string
    Clear log policy, log clear mode, default is delete. 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. Valid values: 0, 1. 1: do not open data backup, 0: open data backup.
    InstanceId string
    Ckafka instance ID.
    IpWhiteLists List<string>
    Ip whitelist, quota limit, required when enableWhileList=true.
    MaxMessageBytes double
    Max message bytes. min: 1024 Byte(1KB), max: 8388608 Byte(8MB).
    MessageStorageLocation string
    Message storage location.
    Note string
    The subject note. It must start with a letter, and the remaining part can contain letters, numbers and dashes (-).
    PartitionNum double
    The number of partition.
    ReplicaNum double
    The number of replica.
    Retention double
    Message can be selected. Retention time, unit is ms, the current minimum value is 60000ms.
    Segment double
    Segment scrolling time, in ms, the current minimum is 3600000ms.
    SegmentBytes double
    Number of bytes rolled by shard.
    SyncReplicaMinNum double
    Min number of sync replicas, Default is 1.
    TopicName string
    Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-).
    UncleanLeaderElectionEnable bool
    Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.
    CkafkaTopicId string
    ID of the resource.
    CleanUpPolicy string
    Clear log policy, log clear mode, default is delete. 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. Valid values: 0, 1. 1: do not open data backup, 0: open data backup.
    InstanceId string
    Ckafka instance ID.
    IpWhiteLists []string
    Ip whitelist, quota limit, required when enableWhileList=true.
    MaxMessageBytes float64
    Max message bytes. min: 1024 Byte(1KB), max: 8388608 Byte(8MB).
    MessageStorageLocation string
    Message storage location.
    Note string
    The subject note. It must start with a letter, and the remaining part can contain letters, numbers and dashes (-).
    PartitionNum float64
    The number of partition.
    ReplicaNum float64
    The number of replica.
    Retention float64
    Message can be selected. Retention time, unit is ms, the current minimum value is 60000ms.
    Segment float64
    Segment scrolling time, in ms, the current minimum is 3600000ms.
    SegmentBytes float64
    Number of bytes rolled by shard.
    SyncReplicaMinNum float64
    Min number of sync replicas, Default is 1.
    TopicName string
    Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-).
    UncleanLeaderElectionEnable bool
    Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.
    ckafkaTopicId String
    ID of the resource.
    cleanUpPolicy String
    Clear log policy, log clear mode, default is delete. 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. Valid values: 0, 1. 1: do not open data backup, 0: open data backup.
    instanceId String
    Ckafka instance ID.
    ipWhiteLists List<String>
    Ip whitelist, quota limit, required when enableWhileList=true.
    maxMessageBytes Double
    Max message bytes. min: 1024 Byte(1KB), max: 8388608 Byte(8MB).
    messageStorageLocation String
    Message storage location.
    note String
    The subject note. It must start with a letter, and the remaining part can contain letters, numbers and dashes (-).
    partitionNum Double
    The number of partition.
    replicaNum Double
    The number of replica.
    retention Double
    Message can be selected. Retention time, unit is ms, the current minimum value is 60000ms.
    segment Double
    Segment scrolling time, in ms, the current minimum is 3600000ms.
    segmentBytes Double
    Number of bytes rolled by shard.
    syncReplicaMinNum Double
    Min number of sync replicas, Default is 1.
    topicName String
    Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-).
    uncleanLeaderElectionEnable Boolean
    Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.
    ckafkaTopicId string
    ID of the resource.
    cleanUpPolicy string
    Clear log policy, log clear mode, default is delete. 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. Valid values: 0, 1. 1: do not open data backup, 0: open data backup.
    instanceId string
    Ckafka instance ID.
    ipWhiteLists string[]
    Ip whitelist, quota limit, required when enableWhileList=true.
    maxMessageBytes number
    Max message bytes. min: 1024 Byte(1KB), max: 8388608 Byte(8MB).
    messageStorageLocation string
    Message storage location.
    note string
    The subject note. It must start with a letter, and the remaining part can contain letters, numbers and dashes (-).
    partitionNum number
    The number of partition.
    replicaNum number
    The number of replica.
    retention number
    Message can be selected. Retention time, unit is ms, the current minimum value is 60000ms.
    segment number
    Segment scrolling time, in ms, the current minimum is 3600000ms.
    segmentBytes number
    Number of bytes rolled by shard.
    syncReplicaMinNum number
    Min number of sync replicas, Default is 1.
    topicName string
    Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-).
    uncleanLeaderElectionEnable boolean
    Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.
    ckafka_topic_id str
    ID of the resource.
    clean_up_policy str
    Clear log policy, log clear mode, default is delete. 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. Valid values: 0, 1. 1: do not open data backup, 0: open data backup.
    instance_id str
    Ckafka instance ID.
    ip_white_lists Sequence[str]
    Ip whitelist, quota limit, required when enableWhileList=true.
    max_message_bytes float
    Max message bytes. min: 1024 Byte(1KB), max: 8388608 Byte(8MB).
    message_storage_location str
    Message storage location.
    note str
    The subject note. It must start with a letter, and the remaining part can contain letters, numbers and dashes (-).
    partition_num float
    The number of partition.
    replica_num float
    The number of replica.
    retention float
    Message can be selected. Retention time, unit is ms, the current minimum value is 60000ms.
    segment float
    Segment scrolling time, in ms, the current minimum is 3600000ms.
    segment_bytes float
    Number of bytes rolled by shard.
    sync_replica_min_num float
    Min number of sync replicas, Default is 1.
    topic_name str
    Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-).
    unclean_leader_election_enable bool
    Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.
    ckafkaTopicId String
    ID of the resource.
    cleanUpPolicy String
    Clear log policy, log clear mode, default is delete. 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. Valid values: 0, 1. 1: do not open data backup, 0: open data backup.
    instanceId String
    Ckafka instance ID.
    ipWhiteLists List<String>
    Ip whitelist, quota limit, required when enableWhileList=true.
    maxMessageBytes Number
    Max message bytes. min: 1024 Byte(1KB), max: 8388608 Byte(8MB).
    messageStorageLocation String
    Message storage location.
    note String
    The subject note. It must start with a letter, and the remaining part can contain letters, numbers and dashes (-).
    partitionNum Number
    The number of partition.
    replicaNum Number
    The number of replica.
    retention Number
    Message can be selected. Retention time, unit is ms, the current minimum value is 60000ms.
    segment Number
    Segment scrolling time, in ms, the current minimum is 3600000ms.
    segmentBytes Number
    Number of bytes rolled by shard.
    syncReplicaMinNum Number
    Min number of sync replicas, Default is 1.
    topicName String
    Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-).
    uncleanLeaderElectionEnable Boolean
    Whether to allow unsynchronized replicas to be selected as leader, default is false, true: allowed, false: not allowed.

    Import

    ckafka topic can be imported using the instance_id#topic_name, e.g.

    $ pulumi import tencentcloud:index/ckafkaTopic:CkafkaTopic example ckafka-f9ife4zz#tf-example

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud