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

tencentcloud.CkafkaRoute

Explore with Pulumi AI

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

    Provides a resource to create a ckafka route

    Example Usage

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

const example = new tencentcloud.CkafkaRoute("example", {
    accessType: 0,
    instanceId: "ckafka-8j4rodrr",
    publicNetwork: 3,
    subnetId: "subnet-j5vja918",
    vipType: 3,
    vpcId: "vpc-axrsmmrv",
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.CkafkaRoute("example",
    access_type=0,
    instance_id="ckafka-8j4rodrr",
    public_network=3,
    subnet_id="subnet-j5vja918",
    vip_type=3,
    vpc_id="vpc-axrsmmrv")

    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.NewCkafkaRoute(ctx, "example", &tencentcloud.CkafkaRouteArgs{
			AccessType:    pulumi.Float64(0),
			InstanceId:    pulumi.String("ckafka-8j4rodrr"),
			PublicNetwork: pulumi.Float64(3),
			SubnetId:      pulumi.String("subnet-j5vja918"),
			VipType:       pulumi.Float64(3),
			VpcId:         pulumi.String("vpc-axrsmmrv"),
		})
		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.CkafkaRoute("example", new()
    {
        AccessType = 0,
        InstanceId = "ckafka-8j4rodrr",
        PublicNetwork = 3,
        SubnetId = "subnet-j5vja918",
        VipType = 3,
        VpcId = "vpc-axrsmmrv",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.CkafkaRoute;
import com.pulumi.tencentcloud.CkafkaRouteArgs;
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 CkafkaRoute("example", CkafkaRouteArgs.builder()
            .accessType(0)
            .instanceId("ckafka-8j4rodrr")
            .publicNetwork(3)
            .subnetId("subnet-j5vja918")
            .vipType(3)
            .vpcId("vpc-axrsmmrv")
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:CkafkaRoute
    properties:
      accessType: 0
      instanceId: ckafka-8j4rodrr
      publicNetwork: 3
      subnetId: subnet-j5vja918
      vipType: 3
      vpcId: vpc-axrsmmrv

    Create CkafkaRoute Resource

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

    Constructor syntax

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

@overload
def CkafkaRoute(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                instance_id: Optional[str] = None,
                vip_type: Optional[float] = None,
                access_type: Optional[float] = None,
                auth_flag: Optional[float] = None,
                caller_appid: Optional[float] = None,
                ckafka_route_id: Optional[str] = None,
                ip: Optional[str] = None,
                public_network: Optional[float] = None,
                subnet_id: Optional[str] = None,
                vpc_id: Optional[str] = None)
    func NewCkafkaRoute(ctx *Context, name string, args CkafkaRouteArgs, opts ...ResourceOption) (*CkafkaRoute, error)
    public CkafkaRoute(string name, CkafkaRouteArgs args, CustomResourceOptions? opts = null)
    public CkafkaRoute(String name, CkafkaRouteArgs args)
public CkafkaRoute(String name, CkafkaRouteArgs args, CustomResourceOptions options)

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

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

    InstanceId string
    Instance id.
    VipType double
    Routing network type (3:vpc routing; 4: standard support routing; 7: professional support routing).
    AccessType double
    Access type. Valid values:

    • 0: PLAINTEXT (in clear text, supported by both the old version and the community version without user information)
    • 1: SASL_PLAINTEXT (in clear text, but at the beginning of the data, authentication will be logged in through SASL, which is only supported by the community version)
    • 2: SSL (SSL encrypted communication without user information, supported by both older and community versions)
    • 3: SASL_SSL (SSL encrypted communication. When the data starts, authentication will be logged in through SASL. Only the community version supports it).
    AuthFlag double
    Auth flag.
    CallerAppid double
    Caller appid.
    CkafkaRouteId string
    ID of the resource.
    Ip string
    Ip.
    PublicNetwork double
    Public network.
    SubnetId string
    Subnet id.
    VpcId string
    Vpc id.
    InstanceId string
    Instance id.
    VipType float64
    Routing network type (3:vpc routing; 4: standard support routing; 7: professional support routing).
    AccessType float64
    Access type. Valid values:

    • 0: PLAINTEXT (in clear text, supported by both the old version and the community version without user information)
    • 1: SASL_PLAINTEXT (in clear text, but at the beginning of the data, authentication will be logged in through SASL, which is only supported by the community version)
    • 2: SSL (SSL encrypted communication without user information, supported by both older and community versions)
    • 3: SASL_SSL (SSL encrypted communication. When the data starts, authentication will be logged in through SASL. Only the community version supports it).
    AuthFlag float64
    Auth flag.
    CallerAppid float64
    Caller appid.
    CkafkaRouteId string
    ID of the resource.
    Ip string
    Ip.
    PublicNetwork float64
    Public network.
    SubnetId string
    Subnet id.
    VpcId string
    Vpc id.
    instanceId String
    Instance id.
    vipType Double
    Routing network type (3:vpc routing; 4: standard support routing; 7: professional support routing).
    accessType Double
    Access type. Valid values:

    • 0: PLAINTEXT (in clear text, supported by both the old version and the community version without user information)
    • 1: SASL_PLAINTEXT (in clear text, but at the beginning of the data, authentication will be logged in through SASL, which is only supported by the community version)
    • 2: SSL (SSL encrypted communication without user information, supported by both older and community versions)
    • 3: SASL_SSL (SSL encrypted communication. When the data starts, authentication will be logged in through SASL. Only the community version supports it).
    authFlag Double
    Auth flag.
    callerAppid Double
    Caller appid.
    ckafkaRouteId String
    ID of the resource.
    ip String
    Ip.
    publicNetwork Double
    Public network.
    subnetId String
    Subnet id.
    vpcId String
    Vpc id.
    instanceId string
    Instance id.
    vipType number
    Routing network type (3:vpc routing; 4: standard support routing; 7: professional support routing).
    accessType number
    Access type. Valid values:

    • 0: PLAINTEXT (in clear text, supported by both the old version and the community version without user information)
    • 1: SASL_PLAINTEXT (in clear text, but at the beginning of the data, authentication will be logged in through SASL, which is only supported by the community version)
    • 2: SSL (SSL encrypted communication without user information, supported by both older and community versions)
    • 3: SASL_SSL (SSL encrypted communication. When the data starts, authentication will be logged in through SASL. Only the community version supports it).
    authFlag number
    Auth flag.
    callerAppid number
    Caller appid.
    ckafkaRouteId string
    ID of the resource.
    ip string
    Ip.
    publicNetwork number
    Public network.
    subnetId string
    Subnet id.
    vpcId string
    Vpc id.
    instance_id str
    Instance id.
    vip_type float
    Routing network type (3:vpc routing; 4: standard support routing; 7: professional support routing).
    access_type float
    Access type. Valid values:

    • 0: PLAINTEXT (in clear text, supported by both the old version and the community version without user information)
    • 1: SASL_PLAINTEXT (in clear text, but at the beginning of the data, authentication will be logged in through SASL, which is only supported by the community version)
    • 2: SSL (SSL encrypted communication without user information, supported by both older and community versions)
    • 3: SASL_SSL (SSL encrypted communication. When the data starts, authentication will be logged in through SASL. Only the community version supports it).
    auth_flag float
    Auth flag.
    caller_appid float
    Caller appid.
    ckafka_route_id str
    ID of the resource.
    ip str
    Ip.
    public_network float
    Public network.
    subnet_id str
    Subnet id.
    vpc_id str
    Vpc id.
    instanceId String
    Instance id.
    vipType Number
    Routing network type (3:vpc routing; 4: standard support routing; 7: professional support routing).
    accessType Number
    Access type. Valid values:

    • 0: PLAINTEXT (in clear text, supported by both the old version and the community version without user information)
    • 1: SASL_PLAINTEXT (in clear text, but at the beginning of the data, authentication will be logged in through SASL, which is only supported by the community version)
    • 2: SSL (SSL encrypted communication without user information, supported by both older and community versions)
    • 3: SASL_SSL (SSL encrypted communication. When the data starts, authentication will be logged in through SASL. Only the community version supports it).
    authFlag Number
    Auth flag.
    callerAppid Number
    Caller appid.
    ckafkaRouteId String
    ID of the resource.
    ip String
    Ip.
    publicNetwork Number
    Public network.
    subnetId String
    Subnet id.
    vpcId String
    Vpc id.

    Outputs

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

    BrokerVipLists List<CkafkaRouteBrokerVipList>
    Virtual IP list (1 to 1 broker nodes).
    Id string
    The provider-assigned unique ID for this managed resource.
    VipLists List<CkafkaRouteVipList>
    Virtual IP list.
    BrokerVipLists []CkafkaRouteBrokerVipList
    Virtual IP list (1 to 1 broker nodes).
    Id string
    The provider-assigned unique ID for this managed resource.
    VipLists []CkafkaRouteVipList
    Virtual IP list.
    brokerVipLists List<CkafkaRouteBrokerVipList>
    Virtual IP list (1 to 1 broker nodes).
    id String
    The provider-assigned unique ID for this managed resource.
    vipLists List<CkafkaRouteVipList>
    Virtual IP list.
    brokerVipLists CkafkaRouteBrokerVipList[]
    Virtual IP list (1 to 1 broker nodes).
    id string
    The provider-assigned unique ID for this managed resource.
    vipLists CkafkaRouteVipList[]
    Virtual IP list.
    broker_vip_lists Sequence[CkafkaRouteBrokerVipList]
    Virtual IP list (1 to 1 broker nodes).
    id str
    The provider-assigned unique ID for this managed resource.
    vip_lists Sequence[CkafkaRouteVipList]
    Virtual IP list.
    brokerVipLists List<Property Map>
    Virtual IP list (1 to 1 broker nodes).
    id String
    The provider-assigned unique ID for this managed resource.
    vipLists List<Property Map>
    Virtual IP list.

    Look up Existing CkafkaRoute Resource

    Get an existing CkafkaRoute 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?: CkafkaRouteState, opts?: CustomResourceOptions): CkafkaRoute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_type: Optional[float] = None,
        auth_flag: Optional[float] = None,
        broker_vip_lists: Optional[Sequence[CkafkaRouteBrokerVipListArgs]] = None,
        caller_appid: Optional[float] = None,
        ckafka_route_id: Optional[str] = None,
        instance_id: Optional[str] = None,
        ip: Optional[str] = None,
        public_network: Optional[float] = None,
        subnet_id: Optional[str] = None,
        vip_lists: Optional[Sequence[CkafkaRouteVipListArgs]] = None,
        vip_type: Optional[float] = None,
        vpc_id: Optional[str] = None) -> CkafkaRoute
    func GetCkafkaRoute(ctx *Context, name string, id IDInput, state *CkafkaRouteState, opts ...ResourceOption) (*CkafkaRoute, error)
    public static CkafkaRoute Get(string name, Input<string> id, CkafkaRouteState? state, CustomResourceOptions? opts = null)
    public static CkafkaRoute get(String name, Output<String> id, CkafkaRouteState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:CkafkaRoute    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:
    AccessType double
    Access type. Valid values:

    • 0: PLAINTEXT (in clear text, supported by both the old version and the community version without user information)
    • 1: SASL_PLAINTEXT (in clear text, but at the beginning of the data, authentication will be logged in through SASL, which is only supported by the community version)
    • 2: SSL (SSL encrypted communication without user information, supported by both older and community versions)
    • 3: SASL_SSL (SSL encrypted communication. When the data starts, authentication will be logged in through SASL. Only the community version supports it).
    AuthFlag double
    Auth flag.
    BrokerVipLists List<CkafkaRouteBrokerVipList>
    Virtual IP list (1 to 1 broker nodes).
    CallerAppid double
    Caller appid.
    CkafkaRouteId string
    ID of the resource.
    InstanceId string
    Instance id.
    Ip string
    Ip.
    PublicNetwork double
    Public network.
    SubnetId string
    Subnet id.
    VipLists List<CkafkaRouteVipList>
    Virtual IP list.
    VipType double
    Routing network type (3:vpc routing; 4: standard support routing; 7: professional support routing).
    VpcId string
    Vpc id.
    AccessType float64
    Access type. Valid values:

    • 0: PLAINTEXT (in clear text, supported by both the old version and the community version without user information)
    • 1: SASL_PLAINTEXT (in clear text, but at the beginning of the data, authentication will be logged in through SASL, which is only supported by the community version)
    • 2: SSL (SSL encrypted communication without user information, supported by both older and community versions)
    • 3: SASL_SSL (SSL encrypted communication. When the data starts, authentication will be logged in through SASL. Only the community version supports it).
    AuthFlag float64
    Auth flag.
    BrokerVipLists []CkafkaRouteBrokerVipListArgs
    Virtual IP list (1 to 1 broker nodes).
    CallerAppid float64
    Caller appid.
    CkafkaRouteId string
    ID of the resource.
    InstanceId string
    Instance id.
    Ip string
    Ip.
    PublicNetwork float64
    Public network.
    SubnetId string
    Subnet id.
    VipLists []CkafkaRouteVipListArgs
    Virtual IP list.
    VipType float64
    Routing network type (3:vpc routing; 4: standard support routing; 7: professional support routing).
    VpcId string
    Vpc id.
    accessType Double
    Access type. Valid values:

    • 0: PLAINTEXT (in clear text, supported by both the old version and the community version without user information)
    • 1: SASL_PLAINTEXT (in clear text, but at the beginning of the data, authentication will be logged in through SASL, which is only supported by the community version)
    • 2: SSL (SSL encrypted communication without user information, supported by both older and community versions)
    • 3: SASL_SSL (SSL encrypted communication. When the data starts, authentication will be logged in through SASL. Only the community version supports it).
    authFlag Double
    Auth flag.
    brokerVipLists List<CkafkaRouteBrokerVipList>
    Virtual IP list (1 to 1 broker nodes).
    callerAppid Double
    Caller appid.
    ckafkaRouteId String
    ID of the resource.
    instanceId String
    Instance id.
    ip String
    Ip.
    publicNetwork Double
    Public network.
    subnetId String
    Subnet id.
    vipLists List<CkafkaRouteVipList>
    Virtual IP list.
    vipType Double
    Routing network type (3:vpc routing; 4: standard support routing; 7: professional support routing).
    vpcId String
    Vpc id.
    accessType number
    Access type. Valid values:

    • 0: PLAINTEXT (in clear text, supported by both the old version and the community version without user information)
    • 1: SASL_PLAINTEXT (in clear text, but at the beginning of the data, authentication will be logged in through SASL, which is only supported by the community version)
    • 2: SSL (SSL encrypted communication without user information, supported by both older and community versions)
    • 3: SASL_SSL (SSL encrypted communication. When the data starts, authentication will be logged in through SASL. Only the community version supports it).
    authFlag number
    Auth flag.
    brokerVipLists CkafkaRouteBrokerVipList[]
    Virtual IP list (1 to 1 broker nodes).
    callerAppid number
    Caller appid.
    ckafkaRouteId string
    ID of the resource.
    instanceId string
    Instance id.
    ip string
    Ip.
    publicNetwork number
    Public network.
    subnetId string
    Subnet id.
    vipLists CkafkaRouteVipList[]
    Virtual IP list.
    vipType number
    Routing network type (3:vpc routing; 4: standard support routing; 7: professional support routing).
    vpcId string
    Vpc id.
    access_type float
    Access type. Valid values:

    • 0: PLAINTEXT (in clear text, supported by both the old version and the community version without user information)
    • 1: SASL_PLAINTEXT (in clear text, but at the beginning of the data, authentication will be logged in through SASL, which is only supported by the community version)
    • 2: SSL (SSL encrypted communication without user information, supported by both older and community versions)
    • 3: SASL_SSL (SSL encrypted communication. When the data starts, authentication will be logged in through SASL. Only the community version supports it).
    auth_flag float
    Auth flag.
    broker_vip_lists Sequence[CkafkaRouteBrokerVipListArgs]
    Virtual IP list (1 to 1 broker nodes).
    caller_appid float
    Caller appid.
    ckafka_route_id str
    ID of the resource.
    instance_id str
    Instance id.
    ip str
    Ip.
    public_network float
    Public network.
    subnet_id str
    Subnet id.
    vip_lists Sequence[CkafkaRouteVipListArgs]
    Virtual IP list.
    vip_type float
    Routing network type (3:vpc routing; 4: standard support routing; 7: professional support routing).
    vpc_id str
    Vpc id.
    accessType Number
    Access type. Valid values:

    • 0: PLAINTEXT (in clear text, supported by both the old version and the community version without user information)
    • 1: SASL_PLAINTEXT (in clear text, but at the beginning of the data, authentication will be logged in through SASL, which is only supported by the community version)
    • 2: SSL (SSL encrypted communication without user information, supported by both older and community versions)
    • 3: SASL_SSL (SSL encrypted communication. When the data starts, authentication will be logged in through SASL. Only the community version supports it).
    authFlag Number
    Auth flag.
    brokerVipLists List<Property Map>
    Virtual IP list (1 to 1 broker nodes).
    callerAppid Number
    Caller appid.
    ckafkaRouteId String
    ID of the resource.
    instanceId String
    Instance id.
    ip String
    Ip.
    publicNetwork Number
    Public network.
    subnetId String
    Subnet id.
    vipLists List<Property Map>
    Virtual IP list.
    vipType Number
    Routing network type (3:vpc routing; 4: standard support routing; 7: professional support routing).
    vpcId String
    Vpc id.

    Supporting Types

    CkafkaRouteBrokerVipList, CkafkaRouteBrokerVipListArgs

    Vip string
    Virtual IP.
    Vport string
    Virtual port.
    Vip string
    Virtual IP.
    Vport string
    Virtual port.
    vip String
    Virtual IP.
    vport String
    Virtual port.
    vip string
    Virtual IP.
    vport string
    Virtual port.
    vip str
    Virtual IP.
    vport str
    Virtual port.
    vip String
    Virtual IP.
    vport String
    Virtual port.

    CkafkaRouteVipList, CkafkaRouteVipListArgs

    Vip string
    Virtual IP.
    Vport string
    Virtual port.
    Vip string
    Virtual IP.
    Vport string
    Virtual port.
    vip String
    Virtual IP.
    vport String
    Virtual port.
    vip string
    Virtual IP.
    vport string
    Virtual port.
    vip str
    Virtual IP.
    vport str
    Virtual port.
    vip String
    Virtual IP.
    vport String
    Virtual port.

    Import

    ckafka route can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/ckafkaRoute:CkafkaRoute example ckafka-8j4rodrr#135912

    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