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

tencentcloud.CkafkaInstance

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 instance.

    Example Usage

    Basic Instance

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

const config = new pulumi.Config();
const vpcId = config.get("vpcId") || "vpc-68vi2d3h";
const subnetId = config.get("subnetId") || "subnet-ob6clqwk";
const gz = tencentcloud.getAvailabilityZonesByProduct({
    name: "ap-guangzhou-3",
    product: "ckafka",
});
const kafkaInstancePrepaid = new tencentcloud.CkafkaInstance("kafkaInstancePrepaid", {
    instanceName: "ckafka-instance-prepaid",
    zoneId: gz.then(gz => gz.zones?.[0]?.id),
    period: 1,
    vpcId: vpcId,
    subnetId: subnetId,
    msgRetentionTime: 1300,
    renewFlag: 0,
    kafkaVersion: "2.4.1",
    diskSize: 200,
    diskType: "CLOUD_BASIC",
    bandWidth: 20,
    partition: 400,
    specificationsType: "standard",
    instanceType: 2,
    config: {
        autoCreateTopicEnable: true,
        defaultNumPartitions: 3,
        defaultReplicationFactor: 3,
    },
    dynamicRetentionConfig: {
        enable: 1,
    },
});
const kafkaInstancePostpaid = new tencentcloud.CkafkaInstance("kafkaInstancePostpaid", {
    instanceName: "ckafka-instance-postpaid",
    zoneId: gz.then(gz => gz.zones?.[0]?.id),
    vpcId: vpcId,
    subnetId: subnetId,
    msgRetentionTime: 1300,
    kafkaVersion: "1.1.1",
    diskSize: 200,
    bandWidth: 20,
    diskType: "CLOUD_BASIC",
    partition: 400,
    chargeType: "POSTPAID_BY_HOUR",
    config: {
        autoCreateTopicEnable: true,
        defaultNumPartitions: 3,
        defaultReplicationFactor: 3,
    },
    dynamicRetentionConfig: {
        enable: 1,
    },
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

config = pulumi.Config()
vpc_id = config.get("vpcId")
if vpc_id is None:
    vpc_id = "vpc-68vi2d3h"
subnet_id = config.get("subnetId")
if subnet_id is None:
    subnet_id = "subnet-ob6clqwk"
gz = tencentcloud.get_availability_zones_by_product(name="ap-guangzhou-3",
    product="ckafka")
kafka_instance_prepaid = tencentcloud.CkafkaInstance("kafkaInstancePrepaid",
    instance_name="ckafka-instance-prepaid",
    zone_id=gz.zones[0].id,
    period=1,
    vpc_id=vpc_id,
    subnet_id=subnet_id,
    msg_retention_time=1300,
    renew_flag=0,
    kafka_version="2.4.1",
    disk_size=200,
    disk_type="CLOUD_BASIC",
    band_width=20,
    partition=400,
    specifications_type="standard",
    instance_type=2,
    config={
        "auto_create_topic_enable": True,
        "default_num_partitions": 3,
        "default_replication_factor": 3,
    },
    dynamic_retention_config={
        "enable": 1,
    })
kafka_instance_postpaid = tencentcloud.CkafkaInstance("kafkaInstancePostpaid",
    instance_name="ckafka-instance-postpaid",
    zone_id=gz.zones[0].id,
    vpc_id=vpc_id,
    subnet_id=subnet_id,
    msg_retention_time=1300,
    kafka_version="1.1.1",
    disk_size=200,
    band_width=20,
    disk_type="CLOUD_BASIC",
    partition=400,
    charge_type="POSTPAID_BY_HOUR",
    config={
        "auto_create_topic_enable": True,
        "default_num_partitions": 3,
        "default_replication_factor": 3,
    },
    dynamic_retention_config={
        "enable": 1,
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		vpcId := "vpc-68vi2d3h"
		if param := cfg.Get("vpcId"); param != "" {
			vpcId = param
		}
		subnetId := "subnet-ob6clqwk"
		if param := cfg.Get("subnetId"); param != "" {
			subnetId = param
		}
		gz, err := tencentcloud.GetAvailabilityZonesByProduct(ctx, &tencentcloud.GetAvailabilityZonesByProductArgs{
			Name:    pulumi.StringRef("ap-guangzhou-3"),
			Product: "ckafka",
		}, nil)
		if err != nil {
			return err
		}
		_, err = tencentcloud.NewCkafkaInstance(ctx, "kafkaInstancePrepaid", &tencentcloud.CkafkaInstanceArgs{
			InstanceName:       pulumi.String("ckafka-instance-prepaid"),
			ZoneId:             pulumi.String(gz.Zones[0].Id),
			Period:             pulumi.Float64(1),
			VpcId:              pulumi.String(vpcId),
			SubnetId:           pulumi.String(subnetId),
			MsgRetentionTime:   pulumi.Float64(1300),
			RenewFlag:          pulumi.Float64(0),
			KafkaVersion:       pulumi.String("2.4.1"),
			DiskSize:           pulumi.Float64(200),
			DiskType:           pulumi.String("CLOUD_BASIC"),
			BandWidth:          pulumi.Float64(20),
			Partition:          pulumi.Float64(400),
			SpecificationsType: pulumi.String("standard"),
			InstanceType:       pulumi.Float64(2),
			Config: &tencentcloud.CkafkaInstanceConfigArgs{
				AutoCreateTopicEnable:    pulumi.Bool(true),
				DefaultNumPartitions:     pulumi.Float64(3),
				DefaultReplicationFactor: pulumi.Float64(3),
			},
			DynamicRetentionConfig: &tencentcloud.CkafkaInstanceDynamicRetentionConfigArgs{
				Enable: pulumi.Float64(1),
			},
		})
		if err != nil {
			return err
		}
		_, err = tencentcloud.NewCkafkaInstance(ctx, "kafkaInstancePostpaid", &tencentcloud.CkafkaInstanceArgs{
			InstanceName:     pulumi.String("ckafka-instance-postpaid"),
			ZoneId:           pulumi.String(gz.Zones[0].Id),
			VpcId:            pulumi.String(vpcId),
			SubnetId:         pulumi.String(subnetId),
			MsgRetentionTime: pulumi.Float64(1300),
			KafkaVersion:     pulumi.String("1.1.1"),
			DiskSize:         pulumi.Float64(200),
			BandWidth:        pulumi.Float64(20),
			DiskType:         pulumi.String("CLOUD_BASIC"),
			Partition:        pulumi.Float64(400),
			ChargeType:       pulumi.String("POSTPAID_BY_HOUR"),
			Config: &tencentcloud.CkafkaInstanceConfigArgs{
				AutoCreateTopicEnable:    pulumi.Bool(true),
				DefaultNumPartitions:     pulumi.Float64(3),
				DefaultReplicationFactor: pulumi.Float64(3),
			},
			DynamicRetentionConfig: &tencentcloud.CkafkaInstanceDynamicRetentionConfigArgs{
				Enable: pulumi.Float64(1),
			},
		})
		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 config = new Config();
    var vpcId = config.Get("vpcId") ?? "vpc-68vi2d3h";
    var subnetId = config.Get("subnetId") ?? "subnet-ob6clqwk";
    var gz = Tencentcloud.GetAvailabilityZonesByProduct.Invoke(new()
    {
        Name = "ap-guangzhou-3",
        Product = "ckafka",
    });

    var kafkaInstancePrepaid = new Tencentcloud.CkafkaInstance("kafkaInstancePrepaid", new()
    {
        InstanceName = "ckafka-instance-prepaid",
        ZoneId = gz.Apply(getAvailabilityZonesByProductResult => getAvailabilityZonesByProductResult.Zones[0]?.Id),
        Period = 1,
        VpcId = vpcId,
        SubnetId = subnetId,
        MsgRetentionTime = 1300,
        RenewFlag = 0,
        KafkaVersion = "2.4.1",
        DiskSize = 200,
        DiskType = "CLOUD_BASIC",
        BandWidth = 20,
        Partition = 400,
        SpecificationsType = "standard",
        InstanceType = 2,
        Config = new Tencentcloud.Inputs.CkafkaInstanceConfigArgs
        {
            AutoCreateTopicEnable = true,
            DefaultNumPartitions = 3,
            DefaultReplicationFactor = 3,
        },
        DynamicRetentionConfig = new Tencentcloud.Inputs.CkafkaInstanceDynamicRetentionConfigArgs
        {
            Enable = 1,
        },
    });

    var kafkaInstancePostpaid = new Tencentcloud.CkafkaInstance("kafkaInstancePostpaid", new()
    {
        InstanceName = "ckafka-instance-postpaid",
        ZoneId = gz.Apply(getAvailabilityZonesByProductResult => getAvailabilityZonesByProductResult.Zones[0]?.Id),
        VpcId = vpcId,
        SubnetId = subnetId,
        MsgRetentionTime = 1300,
        KafkaVersion = "1.1.1",
        DiskSize = 200,
        BandWidth = 20,
        DiskType = "CLOUD_BASIC",
        Partition = 400,
        ChargeType = "POSTPAID_BY_HOUR",
        Config = new Tencentcloud.Inputs.CkafkaInstanceConfigArgs
        {
            AutoCreateTopicEnable = true,
            DefaultNumPartitions = 3,
            DefaultReplicationFactor = 3,
        },
        DynamicRetentionConfig = new Tencentcloud.Inputs.CkafkaInstanceDynamicRetentionConfigArgs
        {
            Enable = 1,
        },
    });

});

    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.GetAvailabilityZonesByProductArgs;
import com.pulumi.tencentcloud.CkafkaInstance;
import com.pulumi.tencentcloud.CkafkaInstanceArgs;
import com.pulumi.tencentcloud.inputs.CkafkaInstanceConfigArgs;
import com.pulumi.tencentcloud.inputs.CkafkaInstanceDynamicRetentionConfigArgs;
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 config = ctx.config();
        final var vpcId = config.get("vpcId").orElse("vpc-68vi2d3h");
        final var subnetId = config.get("subnetId").orElse("subnet-ob6clqwk");
        final var gz = TencentcloudFunctions.getAvailabilityZonesByProduct(GetAvailabilityZonesByProductArgs.builder()
            .name("ap-guangzhou-3")
            .product("ckafka")
            .build());

        var kafkaInstancePrepaid = new CkafkaInstance("kafkaInstancePrepaid", CkafkaInstanceArgs.builder()
            .instanceName("ckafka-instance-prepaid")
            .zoneId(gz.applyValue(getAvailabilityZonesByProductResult -> getAvailabilityZonesByProductResult.zones()[0].id()))
            .period(1)
            .vpcId(vpcId)
            .subnetId(subnetId)
            .msgRetentionTime(1300)
            .renewFlag(0)
            .kafkaVersion("2.4.1")
            .diskSize(200)
            .diskType("CLOUD_BASIC")
            .bandWidth(20)
            .partition(400)
            .specificationsType("standard")
            .instanceType(2)
            .config(CkafkaInstanceConfigArgs.builder()
                .autoCreateTopicEnable(true)
                .defaultNumPartitions(3)
                .defaultReplicationFactor(3)
                .build())
            .dynamicRetentionConfig(CkafkaInstanceDynamicRetentionConfigArgs.builder()
                .enable(1)
                .build())
            .build());

        var kafkaInstancePostpaid = new CkafkaInstance("kafkaInstancePostpaid", CkafkaInstanceArgs.builder()
            .instanceName("ckafka-instance-postpaid")
            .zoneId(gz.applyValue(getAvailabilityZonesByProductResult -> getAvailabilityZonesByProductResult.zones()[0].id()))
            .vpcId(vpcId)
            .subnetId(subnetId)
            .msgRetentionTime(1300)
            .kafkaVersion("1.1.1")
            .diskSize(200)
            .bandWidth(20)
            .diskType("CLOUD_BASIC")
            .partition(400)
            .chargeType("POSTPAID_BY_HOUR")
            .config(CkafkaInstanceConfigArgs.builder()
                .autoCreateTopicEnable(true)
                .defaultNumPartitions(3)
                .defaultReplicationFactor(3)
                .build())
            .dynamicRetentionConfig(CkafkaInstanceDynamicRetentionConfigArgs.builder()
                .enable(1)
                .build())
            .build());

    }
}

    configuration:
  vpcId:
    type: string
    default: vpc-68vi2d3h
  subnetId:
    type: string
    default: subnet-ob6clqwk
resources:
  kafkaInstancePrepaid:
    type: tencentcloud:CkafkaInstance
    properties:
      instanceName: ckafka-instance-prepaid
      zoneId: ${gz.zones[0].id}
      period: 1
      vpcId: ${vpcId}
      subnetId: ${subnetId}
      msgRetentionTime: 1300
      renewFlag: 0
      kafkaVersion: 2.4.1
      diskSize: 200
      diskType: CLOUD_BASIC
      bandWidth: 20
      partition: 400
      specificationsType: standard
      instanceType: 2
      config:
        autoCreateTopicEnable: true
        defaultNumPartitions: 3
        defaultReplicationFactor: 3
      dynamicRetentionConfig:
        enable: 1
  kafkaInstancePostpaid:
    type: tencentcloud:CkafkaInstance
    properties:
      instanceName: ckafka-instance-postpaid
      zoneId: ${gz.zones[0].id}
      vpcId: ${vpcId}
      subnetId: ${subnetId}
      msgRetentionTime: 1300
      kafkaVersion: 1.1.1
      diskSize: 200
      bandWidth: 20
      diskType: CLOUD_BASIC
      partition: 400
      chargeType: POSTPAID_BY_HOUR
      config:
        autoCreateTopicEnable: true
        defaultNumPartitions: 3
        defaultReplicationFactor: 3
      dynamicRetentionConfig:
        enable: 1
variables:
  gz:
    fn::invoke:
      function: tencentcloud:getAvailabilityZonesByProduct
      arguments:
        name: ap-guangzhou-3
        product: ckafka

    Multi zone Instance

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

const config = new pulumi.Config();
const vpcId = config.get("vpcId") || "vpc-68vi2d3h";
const subnetId = config.get("subnetId") || "subnet-ob6clqwk";
const gz3 = tencentcloud.getAvailabilityZonesByProduct({
    name: "ap-guangzhou-3",
    product: "ckafka",
});
const gz6 = tencentcloud.getAvailabilityZonesByProduct({
    name: "ap-guangzhou-6",
    product: "ckafka",
});
const kafkaInstance = new tencentcloud.CkafkaInstance("kafkaInstance", {
    instanceName: "ckafka-instance-maz-tf-test",
    zoneId: gz3.then(gz3 => gz3.zones?.[0]?.id),
    multiZoneFlag: true,
    zoneIds: [
        gz3.then(gz3 => gz3.zones?.[0]?.id),
        gz6.then(gz6 => gz6.zones?.[0]?.id),
    ],
    period: 1,
    vpcId: vpcId,
    subnetId: subnetId,
    msgRetentionTime: 1300,
    renewFlag: 0,
    kafkaVersion: "1.1.1",
    diskSize: 500,
    diskType: "CLOUD_BASIC",
    config: {
        autoCreateTopicEnable: true,
        defaultNumPartitions: 3,
        defaultReplicationFactor: 3,
    },
    dynamicRetentionConfig: {
        enable: 1,
    },
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

config = pulumi.Config()
vpc_id = config.get("vpcId")
if vpc_id is None:
    vpc_id = "vpc-68vi2d3h"
subnet_id = config.get("subnetId")
if subnet_id is None:
    subnet_id = "subnet-ob6clqwk"
gz3 = tencentcloud.get_availability_zones_by_product(name="ap-guangzhou-3",
    product="ckafka")
gz6 = tencentcloud.get_availability_zones_by_product(name="ap-guangzhou-6",
    product="ckafka")
kafka_instance = tencentcloud.CkafkaInstance("kafkaInstance",
    instance_name="ckafka-instance-maz-tf-test",
    zone_id=gz3.zones[0].id,
    multi_zone_flag=True,
    zone_ids=[
        gz3.zones[0].id,
        gz6.zones[0].id,
    ],
    period=1,
    vpc_id=vpc_id,
    subnet_id=subnet_id,
    msg_retention_time=1300,
    renew_flag=0,
    kafka_version="1.1.1",
    disk_size=500,
    disk_type="CLOUD_BASIC",
    config={
        "auto_create_topic_enable": True,
        "default_num_partitions": 3,
        "default_replication_factor": 3,
    },
    dynamic_retention_config={
        "enable": 1,
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		vpcId := "vpc-68vi2d3h"
		if param := cfg.Get("vpcId"); param != "" {
			vpcId = param
		}
		subnetId := "subnet-ob6clqwk"
		if param := cfg.Get("subnetId"); param != "" {
			subnetId = param
		}
		gz3, err := tencentcloud.GetAvailabilityZonesByProduct(ctx, &tencentcloud.GetAvailabilityZonesByProductArgs{
			Name:    pulumi.StringRef("ap-guangzhou-3"),
			Product: "ckafka",
		}, nil)
		if err != nil {
			return err
		}
		gz6, err := tencentcloud.GetAvailabilityZonesByProduct(ctx, &tencentcloud.GetAvailabilityZonesByProductArgs{
			Name:    pulumi.StringRef("ap-guangzhou-6"),
			Product: "ckafka",
		}, nil)
		if err != nil {
			return err
		}
		_, err = tencentcloud.NewCkafkaInstance(ctx, "kafkaInstance", &tencentcloud.CkafkaInstanceArgs{
			InstanceName:  pulumi.String("ckafka-instance-maz-tf-test"),
			ZoneId:        pulumi.String(gz3.Zones[0].Id),
			MultiZoneFlag: pulumi.Bool(true),
			ZoneIds: pulumi.Float64Array{
				pulumi.String(gz3.Zones[0].Id),
				pulumi.String(gz6.Zones[0].Id),
			},
			Period:           pulumi.Float64(1),
			VpcId:            pulumi.String(vpcId),
			SubnetId:         pulumi.String(subnetId),
			MsgRetentionTime: pulumi.Float64(1300),
			RenewFlag:        pulumi.Float64(0),
			KafkaVersion:     pulumi.String("1.1.1"),
			DiskSize:         pulumi.Float64(500),
			DiskType:         pulumi.String("CLOUD_BASIC"),
			Config: &tencentcloud.CkafkaInstanceConfigArgs{
				AutoCreateTopicEnable:    pulumi.Bool(true),
				DefaultNumPartitions:     pulumi.Float64(3),
				DefaultReplicationFactor: pulumi.Float64(3),
			},
			DynamicRetentionConfig: &tencentcloud.CkafkaInstanceDynamicRetentionConfigArgs{
				Enable: pulumi.Float64(1),
			},
		})
		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 config = new Config();
    var vpcId = config.Get("vpcId") ?? "vpc-68vi2d3h";
    var subnetId = config.Get("subnetId") ?? "subnet-ob6clqwk";
    var gz3 = Tencentcloud.GetAvailabilityZonesByProduct.Invoke(new()
    {
        Name = "ap-guangzhou-3",
        Product = "ckafka",
    });

    var gz6 = Tencentcloud.GetAvailabilityZonesByProduct.Invoke(new()
    {
        Name = "ap-guangzhou-6",
        Product = "ckafka",
    });

    var kafkaInstance = new Tencentcloud.CkafkaInstance("kafkaInstance", new()
    {
        InstanceName = "ckafka-instance-maz-tf-test",
        ZoneId = gz3.Apply(getAvailabilityZonesByProductResult => getAvailabilityZonesByProductResult.Zones[0]?.Id),
        MultiZoneFlag = true,
        ZoneIds = new[]
        {
            gz3.Apply(getAvailabilityZonesByProductResult => getAvailabilityZonesByProductResult.Zones[0]?.Id),
            gz6.Apply(getAvailabilityZonesByProductResult => getAvailabilityZonesByProductResult.Zones[0]?.Id),
        },
        Period = 1,
        VpcId = vpcId,
        SubnetId = subnetId,
        MsgRetentionTime = 1300,
        RenewFlag = 0,
        KafkaVersion = "1.1.1",
        DiskSize = 500,
        DiskType = "CLOUD_BASIC",
        Config = new Tencentcloud.Inputs.CkafkaInstanceConfigArgs
        {
            AutoCreateTopicEnable = true,
            DefaultNumPartitions = 3,
            DefaultReplicationFactor = 3,
        },
        DynamicRetentionConfig = new Tencentcloud.Inputs.CkafkaInstanceDynamicRetentionConfigArgs
        {
            Enable = 1,
        },
    });

});

    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.GetAvailabilityZonesByProductArgs;
import com.pulumi.tencentcloud.CkafkaInstance;
import com.pulumi.tencentcloud.CkafkaInstanceArgs;
import com.pulumi.tencentcloud.inputs.CkafkaInstanceConfigArgs;
import com.pulumi.tencentcloud.inputs.CkafkaInstanceDynamicRetentionConfigArgs;
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 config = ctx.config();
        final var vpcId = config.get("vpcId").orElse("vpc-68vi2d3h");
        final var subnetId = config.get("subnetId").orElse("subnet-ob6clqwk");
        final var gz3 = TencentcloudFunctions.getAvailabilityZonesByProduct(GetAvailabilityZonesByProductArgs.builder()
            .name("ap-guangzhou-3")
            .product("ckafka")
            .build());

        final var gz6 = TencentcloudFunctions.getAvailabilityZonesByProduct(GetAvailabilityZonesByProductArgs.builder()
            .name("ap-guangzhou-6")
            .product("ckafka")
            .build());

        var kafkaInstance = new CkafkaInstance("kafkaInstance", CkafkaInstanceArgs.builder()
            .instanceName("ckafka-instance-maz-tf-test")
            .zoneId(gz3.applyValue(getAvailabilityZonesByProductResult -> getAvailabilityZonesByProductResult.zones()[0].id()))
            .multiZoneFlag(true)
            .zoneIds(            
                gz3.applyValue(getAvailabilityZonesByProductResult -> getAvailabilityZonesByProductResult.zones()[0].id()),
                gz6.applyValue(getAvailabilityZonesByProductResult -> getAvailabilityZonesByProductResult.zones()[0].id()))
            .period(1)
            .vpcId(vpcId)
            .subnetId(subnetId)
            .msgRetentionTime(1300)
            .renewFlag(0)
            .kafkaVersion("1.1.1")
            .diskSize(500)
            .diskType("CLOUD_BASIC")
            .config(CkafkaInstanceConfigArgs.builder()
                .autoCreateTopicEnable(true)
                .defaultNumPartitions(3)
                .defaultReplicationFactor(3)
                .build())
            .dynamicRetentionConfig(CkafkaInstanceDynamicRetentionConfigArgs.builder()
                .enable(1)
                .build())
            .build());

    }
}

    configuration:
  vpcId:
    type: string
    default: vpc-68vi2d3h
  subnetId:
    type: string
    default: subnet-ob6clqwk
resources:
  kafkaInstance:
    type: tencentcloud:CkafkaInstance
    properties:
      instanceName: ckafka-instance-maz-tf-test
      zoneId: ${gz3.zones[0].id}
      multiZoneFlag: true
      zoneIds:
        - ${gz3.zones[0].id}
        - ${gz6.zones[0].id}
      period: 1
      vpcId: ${vpcId}
      subnetId: ${subnetId}
      msgRetentionTime: 1300
      renewFlag: 0
      kafkaVersion: 1.1.1
      diskSize: 500
      diskType: CLOUD_BASIC
      config:
        autoCreateTopicEnable: true
        defaultNumPartitions: 3
        defaultReplicationFactor: 3
      dynamicRetentionConfig:
        enable: 1
variables:
  gz3:
    fn::invoke:
      function: tencentcloud:getAvailabilityZonesByProduct
      arguments:
        name: ap-guangzhou-3
        product: ckafka
  gz6:
    fn::invoke:
      function: tencentcloud:getAvailabilityZonesByProduct
      arguments:
        name: ap-guangzhou-6
        product: ckafka

    Create CkafkaInstance Resource

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

    Constructor syntax

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

@overload
def CkafkaInstance(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   instance_name: Optional[str] = None,
                   zone_id: Optional[float] = None,
                   msg_retention_time: Optional[float] = None,
                   upgrade_strategy: Optional[float] = None,
                   disk_size: Optional[float] = None,
                   disk_type: Optional[str] = None,
                   dynamic_retention_config: Optional[CkafkaInstanceDynamicRetentionConfigArgs] = None,
                   elastic_bandwidth_switch: Optional[float] = None,
                   ckafka_instance_id: Optional[str] = None,
                   instance_type: Optional[float] = None,
                   kafka_version: Optional[str] = None,
                   max_message_byte: Optional[float] = None,
                   band_width: Optional[float] = None,
                   multi_zone_flag: Optional[bool] = None,
                   config: Optional[CkafkaInstanceConfigArgs] = None,
                   public_network: Optional[float] = None,
                   partition: Optional[float] = None,
                   rebalance_time: Optional[float] = None,
                   renew_flag: Optional[float] = None,
                   specifications_type: Optional[str] = None,
                   subnet_id: Optional[str] = None,
                   tag_set: Optional[Mapping[str, str]] = None,
                   tags: Optional[Sequence[CkafkaInstanceTagArgs]] = None,
                   period: Optional[float] = None,
                   vpc_id: Optional[str] = None,
                   charge_type: Optional[str] = None,
                   zone_ids: Optional[Sequence[float]] = None)
    func NewCkafkaInstance(ctx *Context, name string, args CkafkaInstanceArgs, opts ...ResourceOption) (*CkafkaInstance, error)
    public CkafkaInstance(string name, CkafkaInstanceArgs args, CustomResourceOptions? opts = null)
    public CkafkaInstance(String name, CkafkaInstanceArgs args)
public CkafkaInstance(String name, CkafkaInstanceArgs args, CustomResourceOptions options)

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

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

    InstanceName string
    Instance name.
    ZoneId double
    Available zone id.
    BandWidth double
    Instance bandwidth in MBps.
    ChargeType string
    The charge type of instance. Valid values are PREPAID and POSTPAID_BY_HOUR. Default value is PREPAID.
    CkafkaInstanceId string
    ID of the resource.
    Config CkafkaInstanceConfig
    Instance configuration.
    DiskSize double
    Disk Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    DiskType string
    Type of disk.
    DynamicRetentionConfig CkafkaInstanceDynamicRetentionConfig
    Dynamic message retention policy configuration.
    ElasticBandwidthSwitch double
    Elastic bandwidth switch 0 not turned on 1 turned on (0 default). This takes effect only when the instance is created.
    InstanceType double
    Description of instance type. profession: 1, standard: 1(general), 2(standard), 3(advanced), 4(capacity), 5(specialized-1), 6(specialized-2), 7(specialized-3), 8(specialized-4), 9(exclusive).
    KafkaVersion string
    Kafka version (0.10.2/1.1.1/2.4.1).
    MaxMessageByte double
    The size of a single message in bytes at the instance level. Value range: `1024 - 1210241024 bytes (i.e., 1KB-12MB).
    MsgRetentionTime double
    The maximum retention time of instance logs, in minutes. the default is 10080 (7 days), the maximum is 30 days, and the default 0 is not filled, which means that the log retention time recovery policy is not enabled.
    MultiZoneFlag bool
    Indicates whether the instance is multi zones. NOTE: if set to true, zone_ids must set together.
    Partition double
    Partition Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    Period double
    Prepaid purchase time, such as 1, is one month.
    PublicNetwork double
    Bandwidth of the public network.
    RebalanceTime double
    Modification of the rebalancing time after upgrade.
    RenewFlag double
    Prepaid automatic renewal mark, 0 means the default state, the initial state, 1 means automatic renewal, 2 means clear no automatic renewal (user setting).
    SpecificationsType string
    Specifications type of instance. Allowed values are standard, profession. Default is profession.
    SubnetId string
    Subnet id, it will be basic network if not set.
    TagSet Dictionary<string, string>
    Tag set of instance.
    Tags List<CkafkaInstanceTag>
    It has been deprecated from version 1.78.5, because it do not support change. Use tag_set instead. Tags of instance. Partition size, the professional version does not need tag.

    Deprecated: Deprecated

    UpgradeStrategy double
    POSTPAID_BY_HOUR scale-down mode

    • 1: stable transformation;
    • 2: High-speed transformer.
    VpcId string
    Vpc id, it will be basic network if not set.
    ZoneIds List<double>
    List of available zone id. NOTE: this argument must set together with multi_zone_flag.
    InstanceName string
    Instance name.
    ZoneId float64
    Available zone id.
    BandWidth float64
    Instance bandwidth in MBps.
    ChargeType string
    The charge type of instance. Valid values are PREPAID and POSTPAID_BY_HOUR. Default value is PREPAID.
    CkafkaInstanceId string
    ID of the resource.
    Config CkafkaInstanceConfigArgs
    Instance configuration.
    DiskSize float64
    Disk Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    DiskType string
    Type of disk.
    DynamicRetentionConfig CkafkaInstanceDynamicRetentionConfigArgs
    Dynamic message retention policy configuration.
    ElasticBandwidthSwitch float64
    Elastic bandwidth switch 0 not turned on 1 turned on (0 default). This takes effect only when the instance is created.
    InstanceType float64
    Description of instance type. profession: 1, standard: 1(general), 2(standard), 3(advanced), 4(capacity), 5(specialized-1), 6(specialized-2), 7(specialized-3), 8(specialized-4), 9(exclusive).
    KafkaVersion string
    Kafka version (0.10.2/1.1.1/2.4.1).
    MaxMessageByte float64
    The size of a single message in bytes at the instance level. Value range: `1024 - 1210241024 bytes (i.e., 1KB-12MB).
    MsgRetentionTime float64
    The maximum retention time of instance logs, in minutes. the default is 10080 (7 days), the maximum is 30 days, and the default 0 is not filled, which means that the log retention time recovery policy is not enabled.
    MultiZoneFlag bool
    Indicates whether the instance is multi zones. NOTE: if set to true, zone_ids must set together.
    Partition float64
    Partition Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    Period float64
    Prepaid purchase time, such as 1, is one month.
    PublicNetwork float64
    Bandwidth of the public network.
    RebalanceTime float64
    Modification of the rebalancing time after upgrade.
    RenewFlag float64
    Prepaid automatic renewal mark, 0 means the default state, the initial state, 1 means automatic renewal, 2 means clear no automatic renewal (user setting).
    SpecificationsType string
    Specifications type of instance. Allowed values are standard, profession. Default is profession.
    SubnetId string
    Subnet id, it will be basic network if not set.
    TagSet map[string]string
    Tag set of instance.
    Tags []CkafkaInstanceTagArgs
    It has been deprecated from version 1.78.5, because it do not support change. Use tag_set instead. Tags of instance. Partition size, the professional version does not need tag.

    Deprecated: Deprecated

    UpgradeStrategy float64
    POSTPAID_BY_HOUR scale-down mode

    • 1: stable transformation;
    • 2: High-speed transformer.
    VpcId string
    Vpc id, it will be basic network if not set.
    ZoneIds []float64
    List of available zone id. NOTE: this argument must set together with multi_zone_flag.
    instanceName String
    Instance name.
    zoneId Double
    Available zone id.
    bandWidth Double
    Instance bandwidth in MBps.
    chargeType String
    The charge type of instance. Valid values are PREPAID and POSTPAID_BY_HOUR. Default value is PREPAID.
    ckafkaInstanceId String
    ID of the resource.
    config CkafkaInstanceConfig
    Instance configuration.
    diskSize Double
    Disk Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    diskType String
    Type of disk.
    dynamicRetentionConfig CkafkaInstanceDynamicRetentionConfig
    Dynamic message retention policy configuration.
    elasticBandwidthSwitch Double
    Elastic bandwidth switch 0 not turned on 1 turned on (0 default). This takes effect only when the instance is created.
    instanceType Double
    Description of instance type. profession: 1, standard: 1(general), 2(standard), 3(advanced), 4(capacity), 5(specialized-1), 6(specialized-2), 7(specialized-3), 8(specialized-4), 9(exclusive).
    kafkaVersion String
    Kafka version (0.10.2/1.1.1/2.4.1).
    maxMessageByte Double
    The size of a single message in bytes at the instance level. Value range: `1024 - 1210241024 bytes (i.e., 1KB-12MB).
    msgRetentionTime Double
    The maximum retention time of instance logs, in minutes. the default is 10080 (7 days), the maximum is 30 days, and the default 0 is not filled, which means that the log retention time recovery policy is not enabled.
    multiZoneFlag Boolean
    Indicates whether the instance is multi zones. NOTE: if set to true, zone_ids must set together.
    partition Double
    Partition Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    period Double
    Prepaid purchase time, such as 1, is one month.
    publicNetwork Double
    Bandwidth of the public network.
    rebalanceTime Double
    Modification of the rebalancing time after upgrade.
    renewFlag Double
    Prepaid automatic renewal mark, 0 means the default state, the initial state, 1 means automatic renewal, 2 means clear no automatic renewal (user setting).
    specificationsType String
    Specifications type of instance. Allowed values are standard, profession. Default is profession.
    subnetId String
    Subnet id, it will be basic network if not set.
    tagSet Map<String,String>
    Tag set of instance.
    tags List<CkafkaInstanceTag>
    It has been deprecated from version 1.78.5, because it do not support change. Use tag_set instead. Tags of instance. Partition size, the professional version does not need tag.

    Deprecated: Deprecated

    upgradeStrategy Double
    POSTPAID_BY_HOUR scale-down mode

    • 1: stable transformation;
    • 2: High-speed transformer.
    vpcId String
    Vpc id, it will be basic network if not set.
    zoneIds List<Double>
    List of available zone id. NOTE: this argument must set together with multi_zone_flag.
    instanceName string
    Instance name.
    zoneId number
    Available zone id.
    bandWidth number
    Instance bandwidth in MBps.
    chargeType string
    The charge type of instance. Valid values are PREPAID and POSTPAID_BY_HOUR. Default value is PREPAID.
    ckafkaInstanceId string
    ID of the resource.
    config CkafkaInstanceConfig
    Instance configuration.
    diskSize number
    Disk Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    diskType string
    Type of disk.
    dynamicRetentionConfig CkafkaInstanceDynamicRetentionConfig
    Dynamic message retention policy configuration.
    elasticBandwidthSwitch number
    Elastic bandwidth switch 0 not turned on 1 turned on (0 default). This takes effect only when the instance is created.
    instanceType number
    Description of instance type. profession: 1, standard: 1(general), 2(standard), 3(advanced), 4(capacity), 5(specialized-1), 6(specialized-2), 7(specialized-3), 8(specialized-4), 9(exclusive).
    kafkaVersion string
    Kafka version (0.10.2/1.1.1/2.4.1).
    maxMessageByte number
    The size of a single message in bytes at the instance level. Value range: `1024 - 1210241024 bytes (i.e., 1KB-12MB).
    msgRetentionTime number
    The maximum retention time of instance logs, in minutes. the default is 10080 (7 days), the maximum is 30 days, and the default 0 is not filled, which means that the log retention time recovery policy is not enabled.
    multiZoneFlag boolean
    Indicates whether the instance is multi zones. NOTE: if set to true, zone_ids must set together.
    partition number
    Partition Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    period number
    Prepaid purchase time, such as 1, is one month.
    publicNetwork number
    Bandwidth of the public network.
    rebalanceTime number
    Modification of the rebalancing time after upgrade.
    renewFlag number
    Prepaid automatic renewal mark, 0 means the default state, the initial state, 1 means automatic renewal, 2 means clear no automatic renewal (user setting).
    specificationsType string
    Specifications type of instance. Allowed values are standard, profession. Default is profession.
    subnetId string
    Subnet id, it will be basic network if not set.
    tagSet {[key: string]: string}
    Tag set of instance.
    tags CkafkaInstanceTag[]
    It has been deprecated from version 1.78.5, because it do not support change. Use tag_set instead. Tags of instance. Partition size, the professional version does not need tag.

    Deprecated: Deprecated

    upgradeStrategy number
    POSTPAID_BY_HOUR scale-down mode

    • 1: stable transformation;
    • 2: High-speed transformer.
    vpcId string
    Vpc id, it will be basic network if not set.
    zoneIds number[]
    List of available zone id. NOTE: this argument must set together with multi_zone_flag.
    instance_name str
    Instance name.
    zone_id float
    Available zone id.
    band_width float
    Instance bandwidth in MBps.
    charge_type str
    The charge type of instance. Valid values are PREPAID and POSTPAID_BY_HOUR. Default value is PREPAID.
    ckafka_instance_id str
    ID of the resource.
    config CkafkaInstanceConfigArgs
    Instance configuration.
    disk_size float
    Disk Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    disk_type str
    Type of disk.
    dynamic_retention_config CkafkaInstanceDynamicRetentionConfigArgs
    Dynamic message retention policy configuration.
    elastic_bandwidth_switch float
    Elastic bandwidth switch 0 not turned on 1 turned on (0 default). This takes effect only when the instance is created.
    instance_type float
    Description of instance type. profession: 1, standard: 1(general), 2(standard), 3(advanced), 4(capacity), 5(specialized-1), 6(specialized-2), 7(specialized-3), 8(specialized-4), 9(exclusive).
    kafka_version str
    Kafka version (0.10.2/1.1.1/2.4.1).
    max_message_byte float
    The size of a single message in bytes at the instance level. Value range: `1024 - 1210241024 bytes (i.e., 1KB-12MB).
    msg_retention_time float
    The maximum retention time of instance logs, in minutes. the default is 10080 (7 days), the maximum is 30 days, and the default 0 is not filled, which means that the log retention time recovery policy is not enabled.
    multi_zone_flag bool
    Indicates whether the instance is multi zones. NOTE: if set to true, zone_ids must set together.
    partition float
    Partition Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    period float
    Prepaid purchase time, such as 1, is one month.
    public_network float
    Bandwidth of the public network.
    rebalance_time float
    Modification of the rebalancing time after upgrade.
    renew_flag float
    Prepaid automatic renewal mark, 0 means the default state, the initial state, 1 means automatic renewal, 2 means clear no automatic renewal (user setting).
    specifications_type str
    Specifications type of instance. Allowed values are standard, profession. Default is profession.
    subnet_id str
    Subnet id, it will be basic network if not set.
    tag_set Mapping[str, str]
    Tag set of instance.
    tags Sequence[CkafkaInstanceTagArgs]
    It has been deprecated from version 1.78.5, because it do not support change. Use tag_set instead. Tags of instance. Partition size, the professional version does not need tag.

    Deprecated: Deprecated

    upgrade_strategy float
    POSTPAID_BY_HOUR scale-down mode

    • 1: stable transformation;
    • 2: High-speed transformer.
    vpc_id str
    Vpc id, it will be basic network if not set.
    zone_ids Sequence[float]
    List of available zone id. NOTE: this argument must set together with multi_zone_flag.
    instanceName String
    Instance name.
    zoneId Number
    Available zone id.
    bandWidth Number
    Instance bandwidth in MBps.
    chargeType String
    The charge type of instance. Valid values are PREPAID and POSTPAID_BY_HOUR. Default value is PREPAID.
    ckafkaInstanceId String
    ID of the resource.
    config Property Map
    Instance configuration.
    diskSize Number
    Disk Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    diskType String
    Type of disk.
    dynamicRetentionConfig Property Map
    Dynamic message retention policy configuration.
    elasticBandwidthSwitch Number
    Elastic bandwidth switch 0 not turned on 1 turned on (0 default). This takes effect only when the instance is created.
    instanceType Number
    Description of instance type. profession: 1, standard: 1(general), 2(standard), 3(advanced), 4(capacity), 5(specialized-1), 6(specialized-2), 7(specialized-3), 8(specialized-4), 9(exclusive).
    kafkaVersion String
    Kafka version (0.10.2/1.1.1/2.4.1).
    maxMessageByte Number
    The size of a single message in bytes at the instance level. Value range: `1024 - 1210241024 bytes (i.e., 1KB-12MB).
    msgRetentionTime Number
    The maximum retention time of instance logs, in minutes. the default is 10080 (7 days), the maximum is 30 days, and the default 0 is not filled, which means that the log retention time recovery policy is not enabled.
    multiZoneFlag Boolean
    Indicates whether the instance is multi zones. NOTE: if set to true, zone_ids must set together.
    partition Number
    Partition Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    period Number
    Prepaid purchase time, such as 1, is one month.
    publicNetwork Number
    Bandwidth of the public network.
    rebalanceTime Number
    Modification of the rebalancing time after upgrade.
    renewFlag Number
    Prepaid automatic renewal mark, 0 means the default state, the initial state, 1 means automatic renewal, 2 means clear no automatic renewal (user setting).
    specificationsType String
    Specifications type of instance. Allowed values are standard, profession. Default is profession.
    subnetId String
    Subnet id, it will be basic network if not set.
    tagSet Map<String>
    Tag set of instance.
    tags List<Property Map>
    It has been deprecated from version 1.78.5, because it do not support change. Use tag_set instead. Tags of instance. Partition size, the professional version does not need tag.

    Deprecated: Deprecated

    upgradeStrategy Number
    POSTPAID_BY_HOUR scale-down mode

    • 1: stable transformation;
    • 2: High-speed transformer.
    vpcId String
    Vpc id, it will be basic network if not set.
    zoneIds List<Number>
    List of available zone id. NOTE: this argument must set together with multi_zone_flag.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Vip string
    Vip of instance.
    Vport string
    Type of instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    Vip string
    Vip of instance.
    Vport string
    Type of instance.
    id String
    The provider-assigned unique ID for this managed resource.
    vip String
    Vip of instance.
    vport String
    Type of instance.
    id string
    The provider-assigned unique ID for this managed resource.
    vip string
    Vip of instance.
    vport string
    Type of instance.
    id str
    The provider-assigned unique ID for this managed resource.
    vip str
    Vip of instance.
    vport str
    Type of instance.
    id String
    The provider-assigned unique ID for this managed resource.
    vip String
    Vip of instance.
    vport String
    Type of instance.

    Look up Existing CkafkaInstance Resource

    Get an existing CkafkaInstance 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?: CkafkaInstanceState, opts?: CustomResourceOptions): CkafkaInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        band_width: Optional[float] = None,
        charge_type: Optional[str] = None,
        ckafka_instance_id: Optional[str] = None,
        config: Optional[CkafkaInstanceConfigArgs] = None,
        disk_size: Optional[float] = None,
        disk_type: Optional[str] = None,
        dynamic_retention_config: Optional[CkafkaInstanceDynamicRetentionConfigArgs] = None,
        elastic_bandwidth_switch: Optional[float] = None,
        instance_name: Optional[str] = None,
        instance_type: Optional[float] = None,
        kafka_version: Optional[str] = None,
        max_message_byte: Optional[float] = None,
        msg_retention_time: Optional[float] = None,
        multi_zone_flag: Optional[bool] = None,
        partition: Optional[float] = None,
        period: Optional[float] = None,
        public_network: Optional[float] = None,
        rebalance_time: Optional[float] = None,
        renew_flag: Optional[float] = None,
        specifications_type: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tag_set: Optional[Mapping[str, str]] = None,
        tags: Optional[Sequence[CkafkaInstanceTagArgs]] = None,
        upgrade_strategy: Optional[float] = None,
        vip: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vport: Optional[str] = None,
        zone_id: Optional[float] = None,
        zone_ids: Optional[Sequence[float]] = None) -> CkafkaInstance
    func GetCkafkaInstance(ctx *Context, name string, id IDInput, state *CkafkaInstanceState, opts ...ResourceOption) (*CkafkaInstance, error)
    public static CkafkaInstance Get(string name, Input<string> id, CkafkaInstanceState? state, CustomResourceOptions? opts = null)
    public static CkafkaInstance get(String name, Output<String> id, CkafkaInstanceState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:CkafkaInstance    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:
    BandWidth double
    Instance bandwidth in MBps.
    ChargeType string
    The charge type of instance. Valid values are PREPAID and POSTPAID_BY_HOUR. Default value is PREPAID.
    CkafkaInstanceId string
    ID of the resource.
    Config CkafkaInstanceConfig
    Instance configuration.
    DiskSize double
    Disk Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    DiskType string
    Type of disk.
    DynamicRetentionConfig CkafkaInstanceDynamicRetentionConfig
    Dynamic message retention policy configuration.
    ElasticBandwidthSwitch double
    Elastic bandwidth switch 0 not turned on 1 turned on (0 default). This takes effect only when the instance is created.
    InstanceName string
    Instance name.
    InstanceType double
    Description of instance type. profession: 1, standard: 1(general), 2(standard), 3(advanced), 4(capacity), 5(specialized-1), 6(specialized-2), 7(specialized-3), 8(specialized-4), 9(exclusive).
    KafkaVersion string
    Kafka version (0.10.2/1.1.1/2.4.1).
    MaxMessageByte double
    The size of a single message in bytes at the instance level. Value range: `1024 - 1210241024 bytes (i.e., 1KB-12MB).
    MsgRetentionTime double
    The maximum retention time of instance logs, in minutes. the default is 10080 (7 days), the maximum is 30 days, and the default 0 is not filled, which means that the log retention time recovery policy is not enabled.
    MultiZoneFlag bool
    Indicates whether the instance is multi zones. NOTE: if set to true, zone_ids must set together.
    Partition double
    Partition Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    Period double
    Prepaid purchase time, such as 1, is one month.
    PublicNetwork double
    Bandwidth of the public network.
    RebalanceTime double
    Modification of the rebalancing time after upgrade.
    RenewFlag double
    Prepaid automatic renewal mark, 0 means the default state, the initial state, 1 means automatic renewal, 2 means clear no automatic renewal (user setting).
    SpecificationsType string
    Specifications type of instance. Allowed values are standard, profession. Default is profession.
    SubnetId string
    Subnet id, it will be basic network if not set.
    TagSet Dictionary<string, string>
    Tag set of instance.
    Tags List<CkafkaInstanceTag>
    It has been deprecated from version 1.78.5, because it do not support change. Use tag_set instead. Tags of instance. Partition size, the professional version does not need tag.

    Deprecated: Deprecated

    UpgradeStrategy double
    POSTPAID_BY_HOUR scale-down mode

    • 1: stable transformation;
    • 2: High-speed transformer.
    Vip string
    Vip of instance.
    VpcId string
    Vpc id, it will be basic network if not set.
    Vport string
    Type of instance.
    ZoneId double
    Available zone id.
    ZoneIds List<double>
    List of available zone id. NOTE: this argument must set together with multi_zone_flag.
    BandWidth float64
    Instance bandwidth in MBps.
    ChargeType string
    The charge type of instance. Valid values are PREPAID and POSTPAID_BY_HOUR. Default value is PREPAID.
    CkafkaInstanceId string
    ID of the resource.
    Config CkafkaInstanceConfigArgs
    Instance configuration.
    DiskSize float64
    Disk Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    DiskType string
    Type of disk.
    DynamicRetentionConfig CkafkaInstanceDynamicRetentionConfigArgs
    Dynamic message retention policy configuration.
    ElasticBandwidthSwitch float64
    Elastic bandwidth switch 0 not turned on 1 turned on (0 default). This takes effect only when the instance is created.
    InstanceName string
    Instance name.
    InstanceType float64
    Description of instance type. profession: 1, standard: 1(general), 2(standard), 3(advanced), 4(capacity), 5(specialized-1), 6(specialized-2), 7(specialized-3), 8(specialized-4), 9(exclusive).
    KafkaVersion string
    Kafka version (0.10.2/1.1.1/2.4.1).
    MaxMessageByte float64
    The size of a single message in bytes at the instance level. Value range: `1024 - 1210241024 bytes (i.e., 1KB-12MB).
    MsgRetentionTime float64
    The maximum retention time of instance logs, in minutes. the default is 10080 (7 days), the maximum is 30 days, and the default 0 is not filled, which means that the log retention time recovery policy is not enabled.
    MultiZoneFlag bool
    Indicates whether the instance is multi zones. NOTE: if set to true, zone_ids must set together.
    Partition float64
    Partition Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    Period float64
    Prepaid purchase time, such as 1, is one month.
    PublicNetwork float64
    Bandwidth of the public network.
    RebalanceTime float64
    Modification of the rebalancing time after upgrade.
    RenewFlag float64
    Prepaid automatic renewal mark, 0 means the default state, the initial state, 1 means automatic renewal, 2 means clear no automatic renewal (user setting).
    SpecificationsType string
    Specifications type of instance. Allowed values are standard, profession. Default is profession.
    SubnetId string
    Subnet id, it will be basic network if not set.
    TagSet map[string]string
    Tag set of instance.
    Tags []CkafkaInstanceTagArgs
    It has been deprecated from version 1.78.5, because it do not support change. Use tag_set instead. Tags of instance. Partition size, the professional version does not need tag.

    Deprecated: Deprecated

    UpgradeStrategy float64
    POSTPAID_BY_HOUR scale-down mode

    • 1: stable transformation;
    • 2: High-speed transformer.
    Vip string
    Vip of instance.
    VpcId string
    Vpc id, it will be basic network if not set.
    Vport string
    Type of instance.
    ZoneId float64
    Available zone id.
    ZoneIds []float64
    List of available zone id. NOTE: this argument must set together with multi_zone_flag.
    bandWidth Double
    Instance bandwidth in MBps.
    chargeType String
    The charge type of instance. Valid values are PREPAID and POSTPAID_BY_HOUR. Default value is PREPAID.
    ckafkaInstanceId String
    ID of the resource.
    config CkafkaInstanceConfig
    Instance configuration.
    diskSize Double
    Disk Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    diskType String
    Type of disk.
    dynamicRetentionConfig CkafkaInstanceDynamicRetentionConfig
    Dynamic message retention policy configuration.
    elasticBandwidthSwitch Double
    Elastic bandwidth switch 0 not turned on 1 turned on (0 default). This takes effect only when the instance is created.
    instanceName String
    Instance name.
    instanceType Double
    Description of instance type. profession: 1, standard: 1(general), 2(standard), 3(advanced), 4(capacity), 5(specialized-1), 6(specialized-2), 7(specialized-3), 8(specialized-4), 9(exclusive).
    kafkaVersion String
    Kafka version (0.10.2/1.1.1/2.4.1).
    maxMessageByte Double
    The size of a single message in bytes at the instance level. Value range: `1024 - 1210241024 bytes (i.e., 1KB-12MB).
    msgRetentionTime Double
    The maximum retention time of instance logs, in minutes. the default is 10080 (7 days), the maximum is 30 days, and the default 0 is not filled, which means that the log retention time recovery policy is not enabled.
    multiZoneFlag Boolean
    Indicates whether the instance is multi zones. NOTE: if set to true, zone_ids must set together.
    partition Double
    Partition Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    period Double
    Prepaid purchase time, such as 1, is one month.
    publicNetwork Double
    Bandwidth of the public network.
    rebalanceTime Double
    Modification of the rebalancing time after upgrade.
    renewFlag Double
    Prepaid automatic renewal mark, 0 means the default state, the initial state, 1 means automatic renewal, 2 means clear no automatic renewal (user setting).
    specificationsType String
    Specifications type of instance. Allowed values are standard, profession. Default is profession.
    subnetId String
    Subnet id, it will be basic network if not set.
    tagSet Map<String,String>
    Tag set of instance.
    tags List<CkafkaInstanceTag>
    It has been deprecated from version 1.78.5, because it do not support change. Use tag_set instead. Tags of instance. Partition size, the professional version does not need tag.

    Deprecated: Deprecated

    upgradeStrategy Double
    POSTPAID_BY_HOUR scale-down mode

    • 1: stable transformation;
    • 2: High-speed transformer.
    vip String
    Vip of instance.
    vpcId String
    Vpc id, it will be basic network if not set.
    vport String
    Type of instance.
    zoneId Double
    Available zone id.
    zoneIds List<Double>
    List of available zone id. NOTE: this argument must set together with multi_zone_flag.
    bandWidth number
    Instance bandwidth in MBps.
    chargeType string
    The charge type of instance. Valid values are PREPAID and POSTPAID_BY_HOUR. Default value is PREPAID.
    ckafkaInstanceId string
    ID of the resource.
    config CkafkaInstanceConfig
    Instance configuration.
    diskSize number
    Disk Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    diskType string
    Type of disk.
    dynamicRetentionConfig CkafkaInstanceDynamicRetentionConfig
    Dynamic message retention policy configuration.
    elasticBandwidthSwitch number
    Elastic bandwidth switch 0 not turned on 1 turned on (0 default). This takes effect only when the instance is created.
    instanceName string
    Instance name.
    instanceType number
    Description of instance type. profession: 1, standard: 1(general), 2(standard), 3(advanced), 4(capacity), 5(specialized-1), 6(specialized-2), 7(specialized-3), 8(specialized-4), 9(exclusive).
    kafkaVersion string
    Kafka version (0.10.2/1.1.1/2.4.1).
    maxMessageByte number
    The size of a single message in bytes at the instance level. Value range: `1024 - 1210241024 bytes (i.e., 1KB-12MB).
    msgRetentionTime number
    The maximum retention time of instance logs, in minutes. the default is 10080 (7 days), the maximum is 30 days, and the default 0 is not filled, which means that the log retention time recovery policy is not enabled.
    multiZoneFlag boolean
    Indicates whether the instance is multi zones. NOTE: if set to true, zone_ids must set together.
    partition number
    Partition Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    period number
    Prepaid purchase time, such as 1, is one month.
    publicNetwork number
    Bandwidth of the public network.
    rebalanceTime number
    Modification of the rebalancing time after upgrade.
    renewFlag number
    Prepaid automatic renewal mark, 0 means the default state, the initial state, 1 means automatic renewal, 2 means clear no automatic renewal (user setting).
    specificationsType string
    Specifications type of instance. Allowed values are standard, profession. Default is profession.
    subnetId string
    Subnet id, it will be basic network if not set.
    tagSet {[key: string]: string}
    Tag set of instance.
    tags CkafkaInstanceTag[]
    It has been deprecated from version 1.78.5, because it do not support change. Use tag_set instead. Tags of instance. Partition size, the professional version does not need tag.

    Deprecated: Deprecated

    upgradeStrategy number
    POSTPAID_BY_HOUR scale-down mode

    • 1: stable transformation;
    • 2: High-speed transformer.
    vip string
    Vip of instance.
    vpcId string
    Vpc id, it will be basic network if not set.
    vport string
    Type of instance.
    zoneId number
    Available zone id.
    zoneIds number[]
    List of available zone id. NOTE: this argument must set together with multi_zone_flag.
    band_width float
    Instance bandwidth in MBps.
    charge_type str
    The charge type of instance. Valid values are PREPAID and POSTPAID_BY_HOUR. Default value is PREPAID.
    ckafka_instance_id str
    ID of the resource.
    config CkafkaInstanceConfigArgs
    Instance configuration.
    disk_size float
    Disk Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    disk_type str
    Type of disk.
    dynamic_retention_config CkafkaInstanceDynamicRetentionConfigArgs
    Dynamic message retention policy configuration.
    elastic_bandwidth_switch float
    Elastic bandwidth switch 0 not turned on 1 turned on (0 default). This takes effect only when the instance is created.
    instance_name str
    Instance name.
    instance_type float
    Description of instance type. profession: 1, standard: 1(general), 2(standard), 3(advanced), 4(capacity), 5(specialized-1), 6(specialized-2), 7(specialized-3), 8(specialized-4), 9(exclusive).
    kafka_version str
    Kafka version (0.10.2/1.1.1/2.4.1).
    max_message_byte float
    The size of a single message in bytes at the instance level. Value range: `1024 - 1210241024 bytes (i.e., 1KB-12MB).
    msg_retention_time float
    The maximum retention time of instance logs, in minutes. the default is 10080 (7 days), the maximum is 30 days, and the default 0 is not filled, which means that the log retention time recovery policy is not enabled.
    multi_zone_flag bool
    Indicates whether the instance is multi zones. NOTE: if set to true, zone_ids must set together.
    partition float
    Partition Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    period float
    Prepaid purchase time, such as 1, is one month.
    public_network float
    Bandwidth of the public network.
    rebalance_time float
    Modification of the rebalancing time after upgrade.
    renew_flag float
    Prepaid automatic renewal mark, 0 means the default state, the initial state, 1 means automatic renewal, 2 means clear no automatic renewal (user setting).
    specifications_type str
    Specifications type of instance. Allowed values are standard, profession. Default is profession.
    subnet_id str
    Subnet id, it will be basic network if not set.
    tag_set Mapping[str, str]
    Tag set of instance.
    tags Sequence[CkafkaInstanceTagArgs]
    It has been deprecated from version 1.78.5, because it do not support change. Use tag_set instead. Tags of instance. Partition size, the professional version does not need tag.

    Deprecated: Deprecated

    upgrade_strategy float
    POSTPAID_BY_HOUR scale-down mode

    • 1: stable transformation;
    • 2: High-speed transformer.
    vip str
    Vip of instance.
    vpc_id str
    Vpc id, it will be basic network if not set.
    vport str
    Type of instance.
    zone_id float
    Available zone id.
    zone_ids Sequence[float]
    List of available zone id. NOTE: this argument must set together with multi_zone_flag.
    bandWidth Number
    Instance bandwidth in MBps.
    chargeType String
    The charge type of instance. Valid values are PREPAID and POSTPAID_BY_HOUR. Default value is PREPAID.
    ckafkaInstanceId String
    ID of the resource.
    config Property Map
    Instance configuration.
    diskSize Number
    Disk Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    diskType String
    Type of disk.
    dynamicRetentionConfig Property Map
    Dynamic message retention policy configuration.
    elasticBandwidthSwitch Number
    Elastic bandwidth switch 0 not turned on 1 turned on (0 default). This takes effect only when the instance is created.
    instanceName String
    Instance name.
    instanceType Number
    Description of instance type. profession: 1, standard: 1(general), 2(standard), 3(advanced), 4(capacity), 5(specialized-1), 6(specialized-2), 7(specialized-3), 8(specialized-4), 9(exclusive).
    kafkaVersion String
    Kafka version (0.10.2/1.1.1/2.4.1).
    maxMessageByte Number
    The size of a single message in bytes at the instance level. Value range: `1024 - 1210241024 bytes (i.e., 1KB-12MB).
    msgRetentionTime Number
    The maximum retention time of instance logs, in minutes. the default is 10080 (7 days), the maximum is 30 days, and the default 0 is not filled, which means that the log retention time recovery policy is not enabled.
    multiZoneFlag Boolean
    Indicates whether the instance is multi zones. NOTE: if set to true, zone_ids must set together.
    partition Number
    Partition Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created.
    period Number
    Prepaid purchase time, such as 1, is one month.
    publicNetwork Number
    Bandwidth of the public network.
    rebalanceTime Number
    Modification of the rebalancing time after upgrade.
    renewFlag Number
    Prepaid automatic renewal mark, 0 means the default state, the initial state, 1 means automatic renewal, 2 means clear no automatic renewal (user setting).
    specificationsType String
    Specifications type of instance. Allowed values are standard, profession. Default is profession.
    subnetId String
    Subnet id, it will be basic network if not set.
    tagSet Map<String>
    Tag set of instance.
    tags List<Property Map>
    It has been deprecated from version 1.78.5, because it do not support change. Use tag_set instead. Tags of instance. Partition size, the professional version does not need tag.

    Deprecated: Deprecated

    upgradeStrategy Number
    POSTPAID_BY_HOUR scale-down mode

    • 1: stable transformation;
    • 2: High-speed transformer.
    vip String
    Vip of instance.
    vpcId String
    Vpc id, it will be basic network if not set.
    vport String
    Type of instance.
    zoneId Number
    Available zone id.
    zoneIds List<Number>
    List of available zone id. NOTE: this argument must set together with multi_zone_flag.

    Supporting Types

    CkafkaInstanceConfig, CkafkaInstanceConfigArgs

    AutoCreateTopicEnable bool
    Automatic creation. true: enabled, false: not enabled.
    DefaultNumPartitions double
    If auto.create.topic.enable is set to true and this value is not set, 3 will be used by default.
    DefaultReplicationFactor double
    If auto.create.topic.enable is set to true but this value is not set, 2 will be used by default.
    AutoCreateTopicEnable bool
    Automatic creation. true: enabled, false: not enabled.
    DefaultNumPartitions float64
    If auto.create.topic.enable is set to true and this value is not set, 3 will be used by default.
    DefaultReplicationFactor float64
    If auto.create.topic.enable is set to true but this value is not set, 2 will be used by default.
    autoCreateTopicEnable Boolean
    Automatic creation. true: enabled, false: not enabled.
    defaultNumPartitions Double
    If auto.create.topic.enable is set to true and this value is not set, 3 will be used by default.
    defaultReplicationFactor Double
    If auto.create.topic.enable is set to true but this value is not set, 2 will be used by default.
    autoCreateTopicEnable boolean
    Automatic creation. true: enabled, false: not enabled.
    defaultNumPartitions number
    If auto.create.topic.enable is set to true and this value is not set, 3 will be used by default.
    defaultReplicationFactor number
    If auto.create.topic.enable is set to true but this value is not set, 2 will be used by default.
    auto_create_topic_enable bool
    Automatic creation. true: enabled, false: not enabled.
    default_num_partitions float
    If auto.create.topic.enable is set to true and this value is not set, 3 will be used by default.
    default_replication_factor float
    If auto.create.topic.enable is set to true but this value is not set, 2 will be used by default.
    autoCreateTopicEnable Boolean
    Automatic creation. true: enabled, false: not enabled.
    defaultNumPartitions Number
    If auto.create.topic.enable is set to true and this value is not set, 3 will be used by default.
    defaultReplicationFactor Number
    If auto.create.topic.enable is set to true but this value is not set, 2 will be used by default.

    CkafkaInstanceDynamicRetentionConfig, CkafkaInstanceDynamicRetentionConfigArgs

    BottomRetention double
    Minimum retention time, in minutes.
    DiskQuotaPercentage double
    Disk quota threshold (in percentage) for triggering the message retention time change event.
    Enable double
    Whether the dynamic message retention time configuration is enabled. 0: disabled; 1: enabled.
    StepForwardPercentage double
    Percentage by which the message retention time is shortened each time.
    BottomRetention float64
    Minimum retention time, in minutes.
    DiskQuotaPercentage float64
    Disk quota threshold (in percentage) for triggering the message retention time change event.
    Enable float64
    Whether the dynamic message retention time configuration is enabled. 0: disabled; 1: enabled.
    StepForwardPercentage float64
    Percentage by which the message retention time is shortened each time.
    bottomRetention Double
    Minimum retention time, in minutes.
    diskQuotaPercentage Double
    Disk quota threshold (in percentage) for triggering the message retention time change event.
    enable Double
    Whether the dynamic message retention time configuration is enabled. 0: disabled; 1: enabled.
    stepForwardPercentage Double
    Percentage by which the message retention time is shortened each time.
    bottomRetention number
    Minimum retention time, in minutes.
    diskQuotaPercentage number
    Disk quota threshold (in percentage) for triggering the message retention time change event.
    enable number
    Whether the dynamic message retention time configuration is enabled. 0: disabled; 1: enabled.
    stepForwardPercentage number
    Percentage by which the message retention time is shortened each time.
    bottom_retention float
    Minimum retention time, in minutes.
    disk_quota_percentage float
    Disk quota threshold (in percentage) for triggering the message retention time change event.
    enable float
    Whether the dynamic message retention time configuration is enabled. 0: disabled; 1: enabled.
    step_forward_percentage float
    Percentage by which the message retention time is shortened each time.
    bottomRetention Number
    Minimum retention time, in minutes.
    diskQuotaPercentage Number
    Disk quota threshold (in percentage) for triggering the message retention time change event.
    enable Number
    Whether the dynamic message retention time configuration is enabled. 0: disabled; 1: enabled.
    stepForwardPercentage Number
    Percentage by which the message retention time is shortened each time.

    CkafkaInstanceTag, CkafkaInstanceTagArgs

    Key string
    Tag key.
    Value string
    Tag value.
    Key string
    Tag key.
    Value string
    Tag value.
    key String
    Tag key.
    value String
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key str
    Tag key.
    value str
    Tag value.
    key String
    Tag key.
    value String
    Tag value.

    Import

    ckafka instance can be imported using the instance_id, e.g.

    $ pulumi import tencentcloud:index/ckafkaInstance:CkafkaInstance foo ckafka-f9ife4zz

    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