Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. DmsKafkaInstance
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.DmsKafkaInstance

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

    Manage a DMS Kafka instance resources within FlexibleEngine.

    Example Usage

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

const test = flexibleengine.getDmsProduct({
    bandwidth: "100MB",
});
const exampleVpc = new flexibleengine.VpcV1("exampleVpc", {cidr: "192.168.0.0/16"});
const exampleSubnet = new flexibleengine.VpcSubnetV1("exampleSubnet", {
    cidr: "192.168.0.0/24",
    gatewayIp: "192.168.0.1",
    vpcId: exampleVpc.vpcV1Id,
});
const exampleSecgroup = new flexibleengine.NetworkingSecgroupV2("exampleSecgroup", {description: "My neutron security group"});
const product1 = new flexibleengine.DmsKafkaInstance("product1", {
    engineVersion: "2.3.0",
    bandwidth: "100MB",
    availabilityZones: data.flexibleengine_dms_product.product_1.availability_zones,
    productId: test.then(test => test.id),
    storageSpace: test.then(test => test.storageSpace),
    storageSpecCode: "dms.physical.storage.ultra",
    vpcId: exampleVpc.vpcV1Id,
    networkId: exampleSubnet.vpcSubnetV1Id,
    securityGroupId: exampleSecgroup.networkingSecgroupV2Id,
    managerUser: "admin",
    managerPassword: "AdminTest@123",
    accessUser: "user",
    password: "Kafkatest@123",
});

    import pulumi
import pulumi_flexibleengine as flexibleengine

test = flexibleengine.get_dms_product(bandwidth="100MB")
example_vpc = flexibleengine.VpcV1("exampleVpc", cidr="192.168.0.0/16")
example_subnet = flexibleengine.VpcSubnetV1("exampleSubnet",
    cidr="192.168.0.0/24",
    gateway_ip="192.168.0.1",
    vpc_id=example_vpc.vpc_v1_id)
example_secgroup = flexibleengine.NetworkingSecgroupV2("exampleSecgroup", description="My neutron security group")
product1 = flexibleengine.DmsKafkaInstance("product1",
    engine_version="2.3.0",
    bandwidth="100MB",
    availability_zones=data["flexibleengine_dms_product"]["product_1"]["availability_zones"],
    product_id=test.id,
    storage_space=test.storage_space,
    storage_spec_code="dms.physical.storage.ultra",
    vpc_id=example_vpc.vpc_v1_id,
    network_id=example_subnet.vpc_subnet_v1_id,
    security_group_id=example_secgroup.networking_secgroup_v2_id,
    manager_user="admin",
    manager_password="AdminTest@123",
    access_user="user",
    password="Kafkatest@123")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := flexibleengine.GetDmsProduct(ctx, &flexibleengine.GetDmsProductArgs{
			Bandwidth: "100MB",
		}, nil)
		if err != nil {
			return err
		}
		exampleVpc, err := flexibleengine.NewVpcV1(ctx, "exampleVpc", &flexibleengine.VpcV1Args{
			Cidr: pulumi.String("192.168.0.0/16"),
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := flexibleengine.NewVpcSubnetV1(ctx, "exampleSubnet", &flexibleengine.VpcSubnetV1Args{
			Cidr:      pulumi.String("192.168.0.0/24"),
			GatewayIp: pulumi.String("192.168.0.1"),
			VpcId:     exampleVpc.VpcV1Id,
		})
		if err != nil {
			return err
		}
		exampleSecgroup, err := flexibleengine.NewNetworkingSecgroupV2(ctx, "exampleSecgroup", &flexibleengine.NetworkingSecgroupV2Args{
			Description: pulumi.String("My neutron security group"),
		})
		if err != nil {
			return err
		}
		_, err = flexibleengine.NewDmsKafkaInstance(ctx, "product1", &flexibleengine.DmsKafkaInstanceArgs{
			EngineVersion:     pulumi.String("2.3.0"),
			Bandwidth:         pulumi.String("100MB"),
			AvailabilityZones: pulumi.Any(data.Flexibleengine_dms_product.Product_1.Availability_zones),
			ProductId:         pulumi.String(test.Id),
			StorageSpace:      pulumi.Float64(test.StorageSpace),
			StorageSpecCode:   pulumi.String("dms.physical.storage.ultra"),
			VpcId:             exampleVpc.VpcV1Id,
			NetworkId:         exampleSubnet.VpcSubnetV1Id,
			SecurityGroupId:   exampleSecgroup.NetworkingSecgroupV2Id,
			ManagerUser:       pulumi.String("admin"),
			ManagerPassword:   pulumi.String("AdminTest@123"),
			AccessUser:        pulumi.String("user"),
			Password:          pulumi.String("Kafkatest@123"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = Flexibleengine.GetDmsProduct.Invoke(new()
    {
        Bandwidth = "100MB",
    });

    var exampleVpc = new Flexibleengine.VpcV1("exampleVpc", new()
    {
        Cidr = "192.168.0.0/16",
    });

    var exampleSubnet = new Flexibleengine.VpcSubnetV1("exampleSubnet", new()
    {
        Cidr = "192.168.0.0/24",
        GatewayIp = "192.168.0.1",
        VpcId = exampleVpc.VpcV1Id,
    });

    var exampleSecgroup = new Flexibleengine.NetworkingSecgroupV2("exampleSecgroup", new()
    {
        Description = "My neutron security group",
    });

    var product1 = new Flexibleengine.DmsKafkaInstance("product1", new()
    {
        EngineVersion = "2.3.0",
        Bandwidth = "100MB",
        AvailabilityZones = data.Flexibleengine_dms_product.Product_1.Availability_zones,
        ProductId = test.Apply(getDmsProductResult => getDmsProductResult.Id),
        StorageSpace = test.Apply(getDmsProductResult => getDmsProductResult.StorageSpace),
        StorageSpecCode = "dms.physical.storage.ultra",
        VpcId = exampleVpc.VpcV1Id,
        NetworkId = exampleSubnet.VpcSubnetV1Id,
        SecurityGroupId = exampleSecgroup.NetworkingSecgroupV2Id,
        ManagerUser = "admin",
        ManagerPassword = "AdminTest@123",
        AccessUser = "user",
        Password = "Kafkatest@123",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.FlexibleengineFunctions;
import com.pulumi.flexibleengine.inputs.GetDmsProductArgs;
import com.pulumi.flexibleengine.VpcV1;
import com.pulumi.flexibleengine.VpcV1Args;
import com.pulumi.flexibleengine.VpcSubnetV1;
import com.pulumi.flexibleengine.VpcSubnetV1Args;
import com.pulumi.flexibleengine.NetworkingSecgroupV2;
import com.pulumi.flexibleengine.NetworkingSecgroupV2Args;
import com.pulumi.flexibleengine.DmsKafkaInstance;
import com.pulumi.flexibleengine.DmsKafkaInstanceArgs;
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 test = FlexibleengineFunctions.getDmsProduct(GetDmsProductArgs.builder()
            .bandwidth("100MB")
            .build());

        var exampleVpc = new VpcV1("exampleVpc", VpcV1Args.builder()
            .cidr("192.168.0.0/16")
            .build());

        var exampleSubnet = new VpcSubnetV1("exampleSubnet", VpcSubnetV1Args.builder()
            .cidr("192.168.0.0/24")
            .gatewayIp("192.168.0.1")
            .vpcId(exampleVpc.vpcV1Id())
            .build());

        var exampleSecgroup = new NetworkingSecgroupV2("exampleSecgroup", NetworkingSecgroupV2Args.builder()
            .description("My neutron security group")
            .build());

        var product1 = new DmsKafkaInstance("product1", DmsKafkaInstanceArgs.builder()
            .engineVersion("2.3.0")
            .bandwidth("100MB")
            .availabilityZones(data.flexibleengine_dms_product().product_1().availability_zones())
            .productId(test.applyValue(getDmsProductResult -> getDmsProductResult.id()))
            .storageSpace(test.applyValue(getDmsProductResult -> getDmsProductResult.storageSpace()))
            .storageSpecCode("dms.physical.storage.ultra")
            .vpcId(exampleVpc.vpcV1Id())
            .networkId(exampleSubnet.vpcSubnetV1Id())
            .securityGroupId(exampleSecgroup.networkingSecgroupV2Id())
            .managerUser("admin")
            .managerPassword("AdminTest@123")
            .accessUser("user")
            .password("Kafkatest@123")
            .build());

    }
}

    resources:
  exampleVpc:
    type: flexibleengine:VpcV1
    properties:
      cidr: 192.168.0.0/16
  exampleSubnet:
    type: flexibleengine:VpcSubnetV1
    properties:
      cidr: 192.168.0.0/24
      gatewayIp: 192.168.0.1
      vpcId: ${exampleVpc.vpcV1Id}
  exampleSecgroup:
    type: flexibleengine:NetworkingSecgroupV2
    properties:
      description: My neutron security group
  product1:
    type: flexibleengine:DmsKafkaInstance
    properties:
      engineVersion: 2.3.0
      bandwidth: 100MB
      availabilityZones: ${data.flexibleengine_dms_product.product_1.availability_zones}
      productId: ${test.id}
      storageSpace: ${test.storageSpace}
      storageSpecCode: dms.physical.storage.ultra
      vpcId: ${exampleVpc.vpcV1Id}
      networkId: ${exampleSubnet.vpcSubnetV1Id}
      securityGroupId: ${exampleSecgroup.networkingSecgroupV2Id}
      managerUser: admin
      managerPassword: AdminTest@123
      accessUser: user
      password: Kafkatest@123
variables:
  test:
    fn::invoke:
      function: flexibleengine:getDmsProduct
      arguments:
        bandwidth: 100MB

    Create DmsKafkaInstance Resource

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

    Constructor syntax

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

@overload
def DmsKafkaInstance(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     network_id: Optional[str] = None,
                     availability_zones: Optional[Sequence[str]] = None,
                     bandwidth: Optional[str] = None,
                     vpc_id: Optional[str] = None,
                     storage_space: Optional[float] = None,
                     security_group_id: Optional[str] = None,
                     product_id: Optional[str] = None,
                     manager_user: Optional[str] = None,
                     engine_version: Optional[str] = None,
                     manager_password: Optional[str] = None,
                     access_user: Optional[str] = None,
                     name: Optional[str] = None,
                     maintain_begin: Optional[str] = None,
                     password: Optional[str] = None,
                     maintain_end: Optional[str] = None,
                     region: Optional[str] = None,
                     enable_auto_topic: Optional[bool] = None,
                     dms_kafka_instance_id: Optional[str] = None,
                     storage_spec_code: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     timeouts: Optional[DmsKafkaInstanceTimeoutsArgs] = None,
                     description: Optional[str] = None)
    func NewDmsKafkaInstance(ctx *Context, name string, args DmsKafkaInstanceArgs, opts ...ResourceOption) (*DmsKafkaInstance, error)
    public DmsKafkaInstance(string name, DmsKafkaInstanceArgs args, CustomResourceOptions? opts = null)
    public DmsKafkaInstance(String name, DmsKafkaInstanceArgs args)
public DmsKafkaInstance(String name, DmsKafkaInstanceArgs args, CustomResourceOptions options)

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var dmsKafkaInstanceResource = new Flexibleengine.DmsKafkaInstance("dmsKafkaInstanceResource", new()
{
    NetworkId = "string",
    AvailabilityZones = new[]
    {
        "string",
    },
    Bandwidth = "string",
    VpcId = "string",
    StorageSpace = 0,
    SecurityGroupId = "string",
    ProductId = "string",
    ManagerUser = "string",
    EngineVersion = "string",
    ManagerPassword = "string",
    AccessUser = "string",
    Name = "string",
    MaintainBegin = "string",
    Password = "string",
    MaintainEnd = "string",
    Region = "string",
    EnableAutoTopic = false,
    DmsKafkaInstanceId = "string",
    StorageSpecCode = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Flexibleengine.Inputs.DmsKafkaInstanceTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
    Description = "string",
});

    example, err := flexibleengine.NewDmsKafkaInstance(ctx, "dmsKafkaInstanceResource", &flexibleengine.DmsKafkaInstanceArgs{
	NetworkId: pulumi.String("string"),
	AvailabilityZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	Bandwidth:          pulumi.String("string"),
	VpcId:              pulumi.String("string"),
	StorageSpace:       pulumi.Float64(0),
	SecurityGroupId:    pulumi.String("string"),
	ProductId:          pulumi.String("string"),
	ManagerUser:        pulumi.String("string"),
	EngineVersion:      pulumi.String("string"),
	ManagerPassword:    pulumi.String("string"),
	AccessUser:         pulumi.String("string"),
	Name:               pulumi.String("string"),
	MaintainBegin:      pulumi.String("string"),
	Password:           pulumi.String("string"),
	MaintainEnd:        pulumi.String("string"),
	Region:             pulumi.String("string"),
	EnableAutoTopic:    pulumi.Bool(false),
	DmsKafkaInstanceId: pulumi.String("string"),
	StorageSpecCode:    pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &flexibleengine.DmsKafkaInstanceTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
	Description: pulumi.String("string"),
})

    var dmsKafkaInstanceResource = new DmsKafkaInstance("dmsKafkaInstanceResource", DmsKafkaInstanceArgs.builder()
    .networkId("string")
    .availabilityZones("string")
    .bandwidth("string")
    .vpcId("string")
    .storageSpace(0)
    .securityGroupId("string")
    .productId("string")
    .managerUser("string")
    .engineVersion("string")
    .managerPassword("string")
    .accessUser("string")
    .name("string")
    .maintainBegin("string")
    .password("string")
    .maintainEnd("string")
    .region("string")
    .enableAutoTopic(false)
    .dmsKafkaInstanceId("string")
    .storageSpecCode("string")
    .tags(Map.of("string", "string"))
    .timeouts(DmsKafkaInstanceTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .description("string")
    .build());

    dms_kafka_instance_resource = flexibleengine.DmsKafkaInstance("dmsKafkaInstanceResource",
    network_id="string",
    availability_zones=["string"],
    bandwidth="string",
    vpc_id="string",
    storage_space=0,
    security_group_id="string",
    product_id="string",
    manager_user="string",
    engine_version="string",
    manager_password="string",
    access_user="string",
    name="string",
    maintain_begin="string",
    password="string",
    maintain_end="string",
    region="string",
    enable_auto_topic=False,
    dms_kafka_instance_id="string",
    storage_spec_code="string",
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
    },
    description="string")

    const dmsKafkaInstanceResource = new flexibleengine.DmsKafkaInstance("dmsKafkaInstanceResource", {
    networkId: "string",
    availabilityZones: ["string"],
    bandwidth: "string",
    vpcId: "string",
    storageSpace: 0,
    securityGroupId: "string",
    productId: "string",
    managerUser: "string",
    engineVersion: "string",
    managerPassword: "string",
    accessUser: "string",
    name: "string",
    maintainBegin: "string",
    password: "string",
    maintainEnd: "string",
    region: "string",
    enableAutoTopic: false,
    dmsKafkaInstanceId: "string",
    storageSpecCode: "string",
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
    },
    description: "string",
});

    type: flexibleengine:DmsKafkaInstance
properties:
    accessUser: string
    availabilityZones:
        - string
    bandwidth: string
    description: string
    dmsKafkaInstanceId: string
    enableAutoTopic: false
    engineVersion: string
    maintainBegin: string
    maintainEnd: string
    managerPassword: string
    managerUser: string
    name: string
    networkId: string
    password: string
    productId: string
    region: string
    securityGroupId: string
    storageSpace: 0
    storageSpecCode: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
    vpcId: string

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

    AvailabilityZones List<string>

    The names of the AZ where the Kafka instance resides. Changing this creates a new instance resource.

    NOTE: Deploy one availability zone or at least three availability zones. Do not select two availability zones. Deploy to more availability zones, the better the reliability and SLA coverage.

    Bandwidth string
    The baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. The valid values are 100MB, 300MB, 600MB and 1200MB. Changing this creates a new instance resource.
    NetworkId string
    Specifies the ID of a VPC subnet. Changing this creates a new instance resource.
    ProductId string
    Specifies a product ID. You can get the value from id of flexibleengine.getDmsProduct data source. Changing this creates a new instance resource.
    SecurityGroupId string
    Specifies the ID of a security group.
    StorageSpace double

    Specifies the message storage capacity, the unit is GB. Value range:

    • When bandwidth is 100MB: 600–90,000 GB
    • When bandwidth is 300MB: 1,200–90,000 GB
    • When bandwidth is 600MB: 2,400–90,000 GB
    • When bandwidth is 1,200MB: 4,800–90,000 GB

    Changing this creates a new instance resource.

    VpcId string
    Specifies the ID of a VPC. Changing this creates a new instance resource.
    AccessUser string
    Specifies a username who can accesse the instance with SASL authentication. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.
    Description string
    Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.
    DmsKafkaInstanceId string
    Specifies a resource ID in UUID format.
    EnableAutoTopic bool
    Specifies whether to enable automatic topic creation. If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist. Changing this creates a new instance resource.
    EngineVersion string
    Specifies the version of the Kafka engine. Valid values are "1.1.0" and "2.3.0". Defaults to 2.3.0. Changing this creates a new instance resource.
    MaintainBegin string
    Specifies the time at which a maintenance time window starts. Format: HH:mm:ss. The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00. The system automatically allocates the default start time 02:00:00.
    MaintainEnd string

    Specifies the time at which a maintenance time window ends. Format: HH:mm:ss. The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00. The system automatically allocates the default end time 06:00:00.

    NOTE: The start time and end time of a maintenance time window must be set in pairs.

    ManagerPassword string
    Specifies the password for logging in to the Kafka Manager. The password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_ =+\|[{}]:'",<.>/?). Changing this creates a new instance resource.
    ManagerUser string
    Specifies the username for logging in to the Kafka Manager. The username consists of 4 to 64 characters and can contain letters, digits, hyphens (-), and underscores (_). Changing this creates a new instance resource.
    Name string
    Specifies the name of the DMS Kafka instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, hyphens (-) and underscores (_).
    Password string

    Specifies the password of the access user. A password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). Changing this creates a new instance resource.

    NOTE: If access_user and password are specified, Kafka SASL_SSL will be automatically enabled.

    Region string
    Specifies the region in which to create the DMS Kafka instance resource. If omitted, the provider-level region will be used. Changing this creates a new instance resource.
    StorageSpecCode string

    Specifies the storage I/O specification. Value range:

    • When bandwidth is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 600MB: dms.physical.storage.ultra
    • When bandwidth is 1,200MB: dms.physical.storage.ultra

    Defaults to dms.physical.storage.ultra. Changing this creates a new instance resource.

    Tags Dictionary<string, string>
    Specifies the key/value pairs to associate with the DMS Kafka instance. Changing this will create a new resource.
    Timeouts DmsKafkaInstanceTimeouts
    AvailabilityZones []string

    The names of the AZ where the Kafka instance resides. Changing this creates a new instance resource.

    NOTE: Deploy one availability zone or at least three availability zones. Do not select two availability zones. Deploy to more availability zones, the better the reliability and SLA coverage.

    Bandwidth string
    The baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. The valid values are 100MB, 300MB, 600MB and 1200MB. Changing this creates a new instance resource.
    NetworkId string
    Specifies the ID of a VPC subnet. Changing this creates a new instance resource.
    ProductId string
    Specifies a product ID. You can get the value from id of flexibleengine.getDmsProduct data source. Changing this creates a new instance resource.
    SecurityGroupId string
    Specifies the ID of a security group.
    StorageSpace float64

    Specifies the message storage capacity, the unit is GB. Value range:

    • When bandwidth is 100MB: 600–90,000 GB
    • When bandwidth is 300MB: 1,200–90,000 GB
    • When bandwidth is 600MB: 2,400–90,000 GB
    • When bandwidth is 1,200MB: 4,800–90,000 GB

    Changing this creates a new instance resource.

    VpcId string
    Specifies the ID of a VPC. Changing this creates a new instance resource.
    AccessUser string
    Specifies a username who can accesse the instance with SASL authentication. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.
    Description string
    Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.
    DmsKafkaInstanceId string
    Specifies a resource ID in UUID format.
    EnableAutoTopic bool
    Specifies whether to enable automatic topic creation. If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist. Changing this creates a new instance resource.
    EngineVersion string
    Specifies the version of the Kafka engine. Valid values are "1.1.0" and "2.3.0". Defaults to 2.3.0. Changing this creates a new instance resource.
    MaintainBegin string
    Specifies the time at which a maintenance time window starts. Format: HH:mm:ss. The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00. The system automatically allocates the default start time 02:00:00.
    MaintainEnd string

    Specifies the time at which a maintenance time window ends. Format: HH:mm:ss. The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00. The system automatically allocates the default end time 06:00:00.

    NOTE: The start time and end time of a maintenance time window must be set in pairs.

    ManagerPassword string
    Specifies the password for logging in to the Kafka Manager. The password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_ =+\|[{}]:'",<.>/?). Changing this creates a new instance resource.
    ManagerUser string
    Specifies the username for logging in to the Kafka Manager. The username consists of 4 to 64 characters and can contain letters, digits, hyphens (-), and underscores (_). Changing this creates a new instance resource.
    Name string
    Specifies the name of the DMS Kafka instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, hyphens (-) and underscores (_).
    Password string

    Specifies the password of the access user. A password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). Changing this creates a new instance resource.

    NOTE: If access_user and password are specified, Kafka SASL_SSL will be automatically enabled.

    Region string
    Specifies the region in which to create the DMS Kafka instance resource. If omitted, the provider-level region will be used. Changing this creates a new instance resource.
    StorageSpecCode string

    Specifies the storage I/O specification. Value range:

    • When bandwidth is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 600MB: dms.physical.storage.ultra
    • When bandwidth is 1,200MB: dms.physical.storage.ultra

    Defaults to dms.physical.storage.ultra. Changing this creates a new instance resource.

    Tags map[string]string
    Specifies the key/value pairs to associate with the DMS Kafka instance. Changing this will create a new resource.
    Timeouts DmsKafkaInstanceTimeoutsArgs
    availabilityZones List<String>

    The names of the AZ where the Kafka instance resides. Changing this creates a new instance resource.

    NOTE: Deploy one availability zone or at least three availability zones. Do not select two availability zones. Deploy to more availability zones, the better the reliability and SLA coverage.

    bandwidth String
    The baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. The valid values are 100MB, 300MB, 600MB and 1200MB. Changing this creates a new instance resource.
    networkId String
    Specifies the ID of a VPC subnet. Changing this creates a new instance resource.
    productId String
    Specifies a product ID. You can get the value from id of flexibleengine.getDmsProduct data source. Changing this creates a new instance resource.
    securityGroupId String
    Specifies the ID of a security group.
    storageSpace Double

    Specifies the message storage capacity, the unit is GB. Value range:

    • When bandwidth is 100MB: 600–90,000 GB
    • When bandwidth is 300MB: 1,200–90,000 GB
    • When bandwidth is 600MB: 2,400–90,000 GB
    • When bandwidth is 1,200MB: 4,800–90,000 GB

    Changing this creates a new instance resource.

    vpcId String
    Specifies the ID of a VPC. Changing this creates a new instance resource.
    accessUser String
    Specifies a username who can accesse the instance with SASL authentication. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.
    description String
    Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.
    dmsKafkaInstanceId String
    Specifies a resource ID in UUID format.
    enableAutoTopic Boolean
    Specifies whether to enable automatic topic creation. If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist. Changing this creates a new instance resource.
    engineVersion String
    Specifies the version of the Kafka engine. Valid values are "1.1.0" and "2.3.0". Defaults to 2.3.0. Changing this creates a new instance resource.
    maintainBegin String
    Specifies the time at which a maintenance time window starts. Format: HH:mm:ss. The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00. The system automatically allocates the default start time 02:00:00.
    maintainEnd String

    Specifies the time at which a maintenance time window ends. Format: HH:mm:ss. The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00. The system automatically allocates the default end time 06:00:00.

    NOTE: The start time and end time of a maintenance time window must be set in pairs.

    managerPassword String
    Specifies the password for logging in to the Kafka Manager. The password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_ =+\|[{}]:'",<.>/?). Changing this creates a new instance resource.
    managerUser String
    Specifies the username for logging in to the Kafka Manager. The username consists of 4 to 64 characters and can contain letters, digits, hyphens (-), and underscores (_). Changing this creates a new instance resource.
    name String
    Specifies the name of the DMS Kafka instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, hyphens (-) and underscores (_).
    password String

    Specifies the password of the access user. A password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). Changing this creates a new instance resource.

    NOTE: If access_user and password are specified, Kafka SASL_SSL will be automatically enabled.

    region String
    Specifies the region in which to create the DMS Kafka instance resource. If omitted, the provider-level region will be used. Changing this creates a new instance resource.
    storageSpecCode String

    Specifies the storage I/O specification. Value range:

    • When bandwidth is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 600MB: dms.physical.storage.ultra
    • When bandwidth is 1,200MB: dms.physical.storage.ultra

    Defaults to dms.physical.storage.ultra. Changing this creates a new instance resource.

    tags Map<String,String>
    Specifies the key/value pairs to associate with the DMS Kafka instance. Changing this will create a new resource.
    timeouts DmsKafkaInstanceTimeouts
    availabilityZones string[]

    The names of the AZ where the Kafka instance resides. Changing this creates a new instance resource.

    NOTE: Deploy one availability zone or at least three availability zones. Do not select two availability zones. Deploy to more availability zones, the better the reliability and SLA coverage.

    bandwidth string
    The baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. The valid values are 100MB, 300MB, 600MB and 1200MB. Changing this creates a new instance resource.
    networkId string
    Specifies the ID of a VPC subnet. Changing this creates a new instance resource.
    productId string
    Specifies a product ID. You can get the value from id of flexibleengine.getDmsProduct data source. Changing this creates a new instance resource.
    securityGroupId string
    Specifies the ID of a security group.
    storageSpace number

    Specifies the message storage capacity, the unit is GB. Value range:

    • When bandwidth is 100MB: 600–90,000 GB
    • When bandwidth is 300MB: 1,200–90,000 GB
    • When bandwidth is 600MB: 2,400–90,000 GB
    • When bandwidth is 1,200MB: 4,800–90,000 GB

    Changing this creates a new instance resource.

    vpcId string
    Specifies the ID of a VPC. Changing this creates a new instance resource.
    accessUser string
    Specifies a username who can accesse the instance with SASL authentication. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.
    description string
    Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.
    dmsKafkaInstanceId string
    Specifies a resource ID in UUID format.
    enableAutoTopic boolean
    Specifies whether to enable automatic topic creation. If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist. Changing this creates a new instance resource.
    engineVersion string
    Specifies the version of the Kafka engine. Valid values are "1.1.0" and "2.3.0". Defaults to 2.3.0. Changing this creates a new instance resource.
    maintainBegin string
    Specifies the time at which a maintenance time window starts. Format: HH:mm:ss. The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00. The system automatically allocates the default start time 02:00:00.
    maintainEnd string

    Specifies the time at which a maintenance time window ends. Format: HH:mm:ss. The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00. The system automatically allocates the default end time 06:00:00.

    NOTE: The start time and end time of a maintenance time window must be set in pairs.

    managerPassword string
    Specifies the password for logging in to the Kafka Manager. The password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_ =+\|[{}]:'",<.>/?). Changing this creates a new instance resource.
    managerUser string
    Specifies the username for logging in to the Kafka Manager. The username consists of 4 to 64 characters and can contain letters, digits, hyphens (-), and underscores (_). Changing this creates a new instance resource.
    name string
    Specifies the name of the DMS Kafka instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, hyphens (-) and underscores (_).
    password string

    Specifies the password of the access user. A password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). Changing this creates a new instance resource.

    NOTE: If access_user and password are specified, Kafka SASL_SSL will be automatically enabled.

    region string
    Specifies the region in which to create the DMS Kafka instance resource. If omitted, the provider-level region will be used. Changing this creates a new instance resource.
    storageSpecCode string

    Specifies the storage I/O specification. Value range:

    • When bandwidth is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 600MB: dms.physical.storage.ultra
    • When bandwidth is 1,200MB: dms.physical.storage.ultra

    Defaults to dms.physical.storage.ultra. Changing this creates a new instance resource.

    tags {[key: string]: string}
    Specifies the key/value pairs to associate with the DMS Kafka instance. Changing this will create a new resource.
    timeouts DmsKafkaInstanceTimeouts
    availability_zones Sequence[str]

    The names of the AZ where the Kafka instance resides. Changing this creates a new instance resource.

    NOTE: Deploy one availability zone or at least three availability zones. Do not select two availability zones. Deploy to more availability zones, the better the reliability and SLA coverage.

    bandwidth str
    The baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. The valid values are 100MB, 300MB, 600MB and 1200MB. Changing this creates a new instance resource.
    network_id str
    Specifies the ID of a VPC subnet. Changing this creates a new instance resource.
    product_id str
    Specifies a product ID. You can get the value from id of flexibleengine.getDmsProduct data source. Changing this creates a new instance resource.
    security_group_id str
    Specifies the ID of a security group.
    storage_space float

    Specifies the message storage capacity, the unit is GB. Value range:

    • When bandwidth is 100MB: 600–90,000 GB
    • When bandwidth is 300MB: 1,200–90,000 GB
    • When bandwidth is 600MB: 2,400–90,000 GB
    • When bandwidth is 1,200MB: 4,800–90,000 GB

    Changing this creates a new instance resource.

    vpc_id str
    Specifies the ID of a VPC. Changing this creates a new instance resource.
    access_user str
    Specifies a username who can accesse the instance with SASL authentication. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.
    description str
    Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.
    dms_kafka_instance_id str
    Specifies a resource ID in UUID format.
    enable_auto_topic bool
    Specifies whether to enable automatic topic creation. If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist. Changing this creates a new instance resource.
    engine_version str
    Specifies the version of the Kafka engine. Valid values are "1.1.0" and "2.3.0". Defaults to 2.3.0. Changing this creates a new instance resource.
    maintain_begin str
    Specifies the time at which a maintenance time window starts. Format: HH:mm:ss. The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00. The system automatically allocates the default start time 02:00:00.
    maintain_end str

    Specifies the time at which a maintenance time window ends. Format: HH:mm:ss. The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00. The system automatically allocates the default end time 06:00:00.

    NOTE: The start time and end time of a maintenance time window must be set in pairs.

    manager_password str
    Specifies the password for logging in to the Kafka Manager. The password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_ =+\|[{}]:'",<.>/?). Changing this creates a new instance resource.
    manager_user str
    Specifies the username for logging in to the Kafka Manager. The username consists of 4 to 64 characters and can contain letters, digits, hyphens (-), and underscores (_). Changing this creates a new instance resource.
    name str
    Specifies the name of the DMS Kafka instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, hyphens (-) and underscores (_).
    password str

    Specifies the password of the access user. A password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). Changing this creates a new instance resource.

    NOTE: If access_user and password are specified, Kafka SASL_SSL will be automatically enabled.

    region str
    Specifies the region in which to create the DMS Kafka instance resource. If omitted, the provider-level region will be used. Changing this creates a new instance resource.
    storage_spec_code str

    Specifies the storage I/O specification. Value range:

    • When bandwidth is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 600MB: dms.physical.storage.ultra
    • When bandwidth is 1,200MB: dms.physical.storage.ultra

    Defaults to dms.physical.storage.ultra. Changing this creates a new instance resource.

    tags Mapping[str, str]
    Specifies the key/value pairs to associate with the DMS Kafka instance. Changing this will create a new resource.
    timeouts DmsKafkaInstanceTimeoutsArgs
    availabilityZones List<String>

    The names of the AZ where the Kafka instance resides. Changing this creates a new instance resource.

    NOTE: Deploy one availability zone or at least three availability zones. Do not select two availability zones. Deploy to more availability zones, the better the reliability and SLA coverage.

    bandwidth String
    The baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. The valid values are 100MB, 300MB, 600MB and 1200MB. Changing this creates a new instance resource.
    networkId String
    Specifies the ID of a VPC subnet. Changing this creates a new instance resource.
    productId String
    Specifies a product ID. You can get the value from id of flexibleengine.getDmsProduct data source. Changing this creates a new instance resource.
    securityGroupId String
    Specifies the ID of a security group.
    storageSpace Number

    Specifies the message storage capacity, the unit is GB. Value range:

    • When bandwidth is 100MB: 600–90,000 GB
    • When bandwidth is 300MB: 1,200–90,000 GB
    • When bandwidth is 600MB: 2,400–90,000 GB
    • When bandwidth is 1,200MB: 4,800–90,000 GB

    Changing this creates a new instance resource.

    vpcId String
    Specifies the ID of a VPC. Changing this creates a new instance resource.
    accessUser String
    Specifies a username who can accesse the instance with SASL authentication. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.
    description String
    Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.
    dmsKafkaInstanceId String
    Specifies a resource ID in UUID format.
    enableAutoTopic Boolean
    Specifies whether to enable automatic topic creation. If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist. Changing this creates a new instance resource.
    engineVersion String
    Specifies the version of the Kafka engine. Valid values are "1.1.0" and "2.3.0". Defaults to 2.3.0. Changing this creates a new instance resource.
    maintainBegin String
    Specifies the time at which a maintenance time window starts. Format: HH:mm:ss. The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00. The system automatically allocates the default start time 02:00:00.
    maintainEnd String

    Specifies the time at which a maintenance time window ends. Format: HH:mm:ss. The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00. The system automatically allocates the default end time 06:00:00.

    NOTE: The start time and end time of a maintenance time window must be set in pairs.

    managerPassword String
    Specifies the password for logging in to the Kafka Manager. The password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_ =+\|[{}]:'",<.>/?). Changing this creates a new instance resource.
    managerUser String
    Specifies the username for logging in to the Kafka Manager. The username consists of 4 to 64 characters and can contain letters, digits, hyphens (-), and underscores (_). Changing this creates a new instance resource.
    name String
    Specifies the name of the DMS Kafka instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, hyphens (-) and underscores (_).
    password String

    Specifies the password of the access user. A password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). Changing this creates a new instance resource.

    NOTE: If access_user and password are specified, Kafka SASL_SSL will be automatically enabled.

    region String
    Specifies the region in which to create the DMS Kafka instance resource. If omitted, the provider-level region will be used. Changing this creates a new instance resource.
    storageSpecCode String

    Specifies the storage I/O specification. Value range:

    • When bandwidth is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 600MB: dms.physical.storage.ultra
    • When bandwidth is 1,200MB: dms.physical.storage.ultra

    Defaults to dms.physical.storage.ultra. Changing this creates a new instance resource.

    tags Map<String>
    Specifies the key/value pairs to associate with the DMS Kafka instance. Changing this will create a new resource.
    timeouts Property Map

    Outputs

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

    ConnectAddress string
    Indicates the IP addresses of the DMS Kafka instance.
    CreatedAt string
    Indicates the creation time of the DMS Kafka instance.
    Engine string
    Indicates the message engine, the value is "kafka".
    EngineType string
    Indicates the DMS Kafka instance type, the value is "cluster".
    Id string
    The provider-assigned unique ID for this managed resource.
    ManegementConnectAddress string
    Indicates the connection address of the Kafka Manager of a Kafka instance.
    NodeNum double
    Indicates the count of ECS instances.
    PartitionNum double
    Indicates the maximum number of topics in the DMS Kafka instance.
    Port double
    Indicates the port number of the DMS Kafka instance.
    ProductSpecCode string
    Indicates the DMS Kafka instance specification.
    SecurityGroupName string
    Indicates the name of a security group.
    SslEnable bool
    Indicates whether the Kafka SASL_SSL is enabled.
    Status string
    Indicates the status of the DMS Kafka instance.
    SubnetName string
    Indicates the name of a subnet.
    UsedStorageSpace double
    Indicates the used message storage space. Unit: GB
    VpcName string
    Indicates the name of a vpc.
    ConnectAddress string
    Indicates the IP addresses of the DMS Kafka instance.
    CreatedAt string
    Indicates the creation time of the DMS Kafka instance.
    Engine string
    Indicates the message engine, the value is "kafka".
    EngineType string
    Indicates the DMS Kafka instance type, the value is "cluster".
    Id string
    The provider-assigned unique ID for this managed resource.
    ManegementConnectAddress string
    Indicates the connection address of the Kafka Manager of a Kafka instance.
    NodeNum float64
    Indicates the count of ECS instances.
    PartitionNum float64
    Indicates the maximum number of topics in the DMS Kafka instance.
    Port float64
    Indicates the port number of the DMS Kafka instance.
    ProductSpecCode string
    Indicates the DMS Kafka instance specification.
    SecurityGroupName string
    Indicates the name of a security group.
    SslEnable bool
    Indicates whether the Kafka SASL_SSL is enabled.
    Status string
    Indicates the status of the DMS Kafka instance.
    SubnetName string
    Indicates the name of a subnet.
    UsedStorageSpace float64
    Indicates the used message storage space. Unit: GB
    VpcName string
    Indicates the name of a vpc.
    connectAddress String
    Indicates the IP addresses of the DMS Kafka instance.
    createdAt String
    Indicates the creation time of the DMS Kafka instance.
    engine String
    Indicates the message engine, the value is "kafka".
    engineType String
    Indicates the DMS Kafka instance type, the value is "cluster".
    id String
    The provider-assigned unique ID for this managed resource.
    manegementConnectAddress String
    Indicates the connection address of the Kafka Manager of a Kafka instance.
    nodeNum Double
    Indicates the count of ECS instances.
    partitionNum Double
    Indicates the maximum number of topics in the DMS Kafka instance.
    port Double
    Indicates the port number of the DMS Kafka instance.
    productSpecCode String
    Indicates the DMS Kafka instance specification.
    securityGroupName String
    Indicates the name of a security group.
    sslEnable Boolean
    Indicates whether the Kafka SASL_SSL is enabled.
    status String
    Indicates the status of the DMS Kafka instance.
    subnetName String
    Indicates the name of a subnet.
    usedStorageSpace Double
    Indicates the used message storage space. Unit: GB
    vpcName String
    Indicates the name of a vpc.
    connectAddress string
    Indicates the IP addresses of the DMS Kafka instance.
    createdAt string
    Indicates the creation time of the DMS Kafka instance.
    engine string
    Indicates the message engine, the value is "kafka".
    engineType string
    Indicates the DMS Kafka instance type, the value is "cluster".
    id string
    The provider-assigned unique ID for this managed resource.
    manegementConnectAddress string
    Indicates the connection address of the Kafka Manager of a Kafka instance.
    nodeNum number
    Indicates the count of ECS instances.
    partitionNum number
    Indicates the maximum number of topics in the DMS Kafka instance.
    port number
    Indicates the port number of the DMS Kafka instance.
    productSpecCode string
    Indicates the DMS Kafka instance specification.
    securityGroupName string
    Indicates the name of a security group.
    sslEnable boolean
    Indicates whether the Kafka SASL_SSL is enabled.
    status string
    Indicates the status of the DMS Kafka instance.
    subnetName string
    Indicates the name of a subnet.
    usedStorageSpace number
    Indicates the used message storage space. Unit: GB
    vpcName string
    Indicates the name of a vpc.
    connect_address str
    Indicates the IP addresses of the DMS Kafka instance.
    created_at str
    Indicates the creation time of the DMS Kafka instance.
    engine str
    Indicates the message engine, the value is "kafka".
    engine_type str
    Indicates the DMS Kafka instance type, the value is "cluster".
    id str
    The provider-assigned unique ID for this managed resource.
    manegement_connect_address str
    Indicates the connection address of the Kafka Manager of a Kafka instance.
    node_num float
    Indicates the count of ECS instances.
    partition_num float
    Indicates the maximum number of topics in the DMS Kafka instance.
    port float
    Indicates the port number of the DMS Kafka instance.
    product_spec_code str
    Indicates the DMS Kafka instance specification.
    security_group_name str
    Indicates the name of a security group.
    ssl_enable bool
    Indicates whether the Kafka SASL_SSL is enabled.
    status str
    Indicates the status of the DMS Kafka instance.
    subnet_name str
    Indicates the name of a subnet.
    used_storage_space float
    Indicates the used message storage space. Unit: GB
    vpc_name str
    Indicates the name of a vpc.
    connectAddress String
    Indicates the IP addresses of the DMS Kafka instance.
    createdAt String
    Indicates the creation time of the DMS Kafka instance.
    engine String
    Indicates the message engine, the value is "kafka".
    engineType String
    Indicates the DMS Kafka instance type, the value is "cluster".
    id String
    The provider-assigned unique ID for this managed resource.
    manegementConnectAddress String
    Indicates the connection address of the Kafka Manager of a Kafka instance.
    nodeNum Number
    Indicates the count of ECS instances.
    partitionNum Number
    Indicates the maximum number of topics in the DMS Kafka instance.
    port Number
    Indicates the port number of the DMS Kafka instance.
    productSpecCode String
    Indicates the DMS Kafka instance specification.
    securityGroupName String
    Indicates the name of a security group.
    sslEnable Boolean
    Indicates whether the Kafka SASL_SSL is enabled.
    status String
    Indicates the status of the DMS Kafka instance.
    subnetName String
    Indicates the name of a subnet.
    usedStorageSpace Number
    Indicates the used message storage space. Unit: GB
    vpcName String
    Indicates the name of a vpc.

    Look up Existing DmsKafkaInstance Resource

    Get an existing DmsKafkaInstance 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?: DmsKafkaInstanceState, opts?: CustomResourceOptions): DmsKafkaInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_user: Optional[str] = None,
        availability_zones: Optional[Sequence[str]] = None,
        bandwidth: Optional[str] = None,
        connect_address: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        dms_kafka_instance_id: Optional[str] = None,
        enable_auto_topic: Optional[bool] = None,
        engine: Optional[str] = None,
        engine_type: Optional[str] = None,
        engine_version: Optional[str] = None,
        maintain_begin: Optional[str] = None,
        maintain_end: Optional[str] = None,
        manager_password: Optional[str] = None,
        manager_user: Optional[str] = None,
        manegement_connect_address: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        node_num: Optional[float] = None,
        partition_num: Optional[float] = None,
        password: Optional[str] = None,
        port: Optional[float] = None,
        product_id: Optional[str] = None,
        product_spec_code: Optional[str] = None,
        region: Optional[str] = None,
        security_group_id: Optional[str] = None,
        security_group_name: Optional[str] = None,
        ssl_enable: Optional[bool] = None,
        status: Optional[str] = None,
        storage_space: Optional[float] = None,
        storage_spec_code: Optional[str] = None,
        subnet_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        timeouts: Optional[DmsKafkaInstanceTimeoutsArgs] = None,
        used_storage_space: Optional[float] = None,
        vpc_id: Optional[str] = None,
        vpc_name: Optional[str] = None) -> DmsKafkaInstance
    func GetDmsKafkaInstance(ctx *Context, name string, id IDInput, state *DmsKafkaInstanceState, opts ...ResourceOption) (*DmsKafkaInstance, error)
    public static DmsKafkaInstance Get(string name, Input<string> id, DmsKafkaInstanceState? state, CustomResourceOptions? opts = null)
    public static DmsKafkaInstance get(String name, Output<String> id, DmsKafkaInstanceState state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:DmsKafkaInstance    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:
    AccessUser string
    Specifies a username who can accesse the instance with SASL authentication. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.
    AvailabilityZones List<string>

    The names of the AZ where the Kafka instance resides. Changing this creates a new instance resource.

    NOTE: Deploy one availability zone or at least three availability zones. Do not select two availability zones. Deploy to more availability zones, the better the reliability and SLA coverage.

    Bandwidth string
    The baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. The valid values are 100MB, 300MB, 600MB and 1200MB. Changing this creates a new instance resource.
    ConnectAddress string
    Indicates the IP addresses of the DMS Kafka instance.
    CreatedAt string
    Indicates the creation time of the DMS Kafka instance.
    Description string
    Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.
    DmsKafkaInstanceId string
    Specifies a resource ID in UUID format.
    EnableAutoTopic bool
    Specifies whether to enable automatic topic creation. If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist. Changing this creates a new instance resource.
    Engine string
    Indicates the message engine, the value is "kafka".
    EngineType string
    Indicates the DMS Kafka instance type, the value is "cluster".
    EngineVersion string
    Specifies the version of the Kafka engine. Valid values are "1.1.0" and "2.3.0". Defaults to 2.3.0. Changing this creates a new instance resource.
    MaintainBegin string
    Specifies the time at which a maintenance time window starts. Format: HH:mm:ss. The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00. The system automatically allocates the default start time 02:00:00.
    MaintainEnd string

    Specifies the time at which a maintenance time window ends. Format: HH:mm:ss. The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00. The system automatically allocates the default end time 06:00:00.

    NOTE: The start time and end time of a maintenance time window must be set in pairs.

    ManagerPassword string
    Specifies the password for logging in to the Kafka Manager. The password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_ =+\|[{}]:'",<.>/?). Changing this creates a new instance resource.
    ManagerUser string
    Specifies the username for logging in to the Kafka Manager. The username consists of 4 to 64 characters and can contain letters, digits, hyphens (-), and underscores (_). Changing this creates a new instance resource.
    ManegementConnectAddress string
    Indicates the connection address of the Kafka Manager of a Kafka instance.
    Name string
    Specifies the name of the DMS Kafka instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, hyphens (-) and underscores (_).
    NetworkId string
    Specifies the ID of a VPC subnet. Changing this creates a new instance resource.
    NodeNum double
    Indicates the count of ECS instances.
    PartitionNum double
    Indicates the maximum number of topics in the DMS Kafka instance.
    Password string

    Specifies the password of the access user. A password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). Changing this creates a new instance resource.

    NOTE: If access_user and password are specified, Kafka SASL_SSL will be automatically enabled.

    Port double
    Indicates the port number of the DMS Kafka instance.
    ProductId string
    Specifies a product ID. You can get the value from id of flexibleengine.getDmsProduct data source. Changing this creates a new instance resource.
    ProductSpecCode string
    Indicates the DMS Kafka instance specification.
    Region string
    Specifies the region in which to create the DMS Kafka instance resource. If omitted, the provider-level region will be used. Changing this creates a new instance resource.
    SecurityGroupId string
    Specifies the ID of a security group.
    SecurityGroupName string
    Indicates the name of a security group.
    SslEnable bool
    Indicates whether the Kafka SASL_SSL is enabled.
    Status string
    Indicates the status of the DMS Kafka instance.
    StorageSpace double

    Specifies the message storage capacity, the unit is GB. Value range:

    • When bandwidth is 100MB: 600–90,000 GB
    • When bandwidth is 300MB: 1,200–90,000 GB
    • When bandwidth is 600MB: 2,400–90,000 GB
    • When bandwidth is 1,200MB: 4,800–90,000 GB

    Changing this creates a new instance resource.

    StorageSpecCode string

    Specifies the storage I/O specification. Value range:

    • When bandwidth is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 600MB: dms.physical.storage.ultra
    • When bandwidth is 1,200MB: dms.physical.storage.ultra

    Defaults to dms.physical.storage.ultra. Changing this creates a new instance resource.

    SubnetName string
    Indicates the name of a subnet.
    Tags Dictionary<string, string>
    Specifies the key/value pairs to associate with the DMS Kafka instance. Changing this will create a new resource.
    Timeouts DmsKafkaInstanceTimeouts
    UsedStorageSpace double
    Indicates the used message storage space. Unit: GB
    VpcId string
    Specifies the ID of a VPC. Changing this creates a new instance resource.
    VpcName string
    Indicates the name of a vpc.
    AccessUser string
    Specifies a username who can accesse the instance with SASL authentication. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.
    AvailabilityZones []string

    The names of the AZ where the Kafka instance resides. Changing this creates a new instance resource.

    NOTE: Deploy one availability zone or at least three availability zones. Do not select two availability zones. Deploy to more availability zones, the better the reliability and SLA coverage.

    Bandwidth string
    The baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. The valid values are 100MB, 300MB, 600MB and 1200MB. Changing this creates a new instance resource.
    ConnectAddress string
    Indicates the IP addresses of the DMS Kafka instance.
    CreatedAt string
    Indicates the creation time of the DMS Kafka instance.
    Description string
    Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.
    DmsKafkaInstanceId string
    Specifies a resource ID in UUID format.
    EnableAutoTopic bool
    Specifies whether to enable automatic topic creation. If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist. Changing this creates a new instance resource.
    Engine string
    Indicates the message engine, the value is "kafka".
    EngineType string
    Indicates the DMS Kafka instance type, the value is "cluster".
    EngineVersion string
    Specifies the version of the Kafka engine. Valid values are "1.1.0" and "2.3.0". Defaults to 2.3.0. Changing this creates a new instance resource.
    MaintainBegin string
    Specifies the time at which a maintenance time window starts. Format: HH:mm:ss. The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00. The system automatically allocates the default start time 02:00:00.
    MaintainEnd string

    Specifies the time at which a maintenance time window ends. Format: HH:mm:ss. The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00. The system automatically allocates the default end time 06:00:00.

    NOTE: The start time and end time of a maintenance time window must be set in pairs.

    ManagerPassword string
    Specifies the password for logging in to the Kafka Manager. The password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_ =+\|[{}]:'",<.>/?). Changing this creates a new instance resource.
    ManagerUser string
    Specifies the username for logging in to the Kafka Manager. The username consists of 4 to 64 characters and can contain letters, digits, hyphens (-), and underscores (_). Changing this creates a new instance resource.
    ManegementConnectAddress string
    Indicates the connection address of the Kafka Manager of a Kafka instance.
    Name string
    Specifies the name of the DMS Kafka instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, hyphens (-) and underscores (_).
    NetworkId string
    Specifies the ID of a VPC subnet. Changing this creates a new instance resource.
    NodeNum float64
    Indicates the count of ECS instances.
    PartitionNum float64
    Indicates the maximum number of topics in the DMS Kafka instance.
    Password string

    Specifies the password of the access user. A password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). Changing this creates a new instance resource.

    NOTE: If access_user and password are specified, Kafka SASL_SSL will be automatically enabled.

    Port float64
    Indicates the port number of the DMS Kafka instance.
    ProductId string
    Specifies a product ID. You can get the value from id of flexibleengine.getDmsProduct data source. Changing this creates a new instance resource.
    ProductSpecCode string
    Indicates the DMS Kafka instance specification.
    Region string
    Specifies the region in which to create the DMS Kafka instance resource. If omitted, the provider-level region will be used. Changing this creates a new instance resource.
    SecurityGroupId string
    Specifies the ID of a security group.
    SecurityGroupName string
    Indicates the name of a security group.
    SslEnable bool
    Indicates whether the Kafka SASL_SSL is enabled.
    Status string
    Indicates the status of the DMS Kafka instance.
    StorageSpace float64

    Specifies the message storage capacity, the unit is GB. Value range:

    • When bandwidth is 100MB: 600–90,000 GB
    • When bandwidth is 300MB: 1,200–90,000 GB
    • When bandwidth is 600MB: 2,400–90,000 GB
    • When bandwidth is 1,200MB: 4,800–90,000 GB

    Changing this creates a new instance resource.

    StorageSpecCode string

    Specifies the storage I/O specification. Value range:

    • When bandwidth is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 600MB: dms.physical.storage.ultra
    • When bandwidth is 1,200MB: dms.physical.storage.ultra

    Defaults to dms.physical.storage.ultra. Changing this creates a new instance resource.

    SubnetName string
    Indicates the name of a subnet.
    Tags map[string]string
    Specifies the key/value pairs to associate with the DMS Kafka instance. Changing this will create a new resource.
    Timeouts DmsKafkaInstanceTimeoutsArgs
    UsedStorageSpace float64
    Indicates the used message storage space. Unit: GB
    VpcId string
    Specifies the ID of a VPC. Changing this creates a new instance resource.
    VpcName string
    Indicates the name of a vpc.
    accessUser String
    Specifies a username who can accesse the instance with SASL authentication. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.
    availabilityZones List<String>

    The names of the AZ where the Kafka instance resides. Changing this creates a new instance resource.

    NOTE: Deploy one availability zone or at least three availability zones. Do not select two availability zones. Deploy to more availability zones, the better the reliability and SLA coverage.

    bandwidth String
    The baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. The valid values are 100MB, 300MB, 600MB and 1200MB. Changing this creates a new instance resource.
    connectAddress String
    Indicates the IP addresses of the DMS Kafka instance.
    createdAt String
    Indicates the creation time of the DMS Kafka instance.
    description String
    Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.
    dmsKafkaInstanceId String
    Specifies a resource ID in UUID format.
    enableAutoTopic Boolean
    Specifies whether to enable automatic topic creation. If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist. Changing this creates a new instance resource.
    engine String
    Indicates the message engine, the value is "kafka".
    engineType String
    Indicates the DMS Kafka instance type, the value is "cluster".
    engineVersion String
    Specifies the version of the Kafka engine. Valid values are "1.1.0" and "2.3.0". Defaults to 2.3.0. Changing this creates a new instance resource.
    maintainBegin String
    Specifies the time at which a maintenance time window starts. Format: HH:mm:ss. The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00. The system automatically allocates the default start time 02:00:00.
    maintainEnd String

    Specifies the time at which a maintenance time window ends. Format: HH:mm:ss. The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00. The system automatically allocates the default end time 06:00:00.

    NOTE: The start time and end time of a maintenance time window must be set in pairs.

    managerPassword String
    Specifies the password for logging in to the Kafka Manager. The password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_ =+\|[{}]:'",<.>/?). Changing this creates a new instance resource.
    managerUser String
    Specifies the username for logging in to the Kafka Manager. The username consists of 4 to 64 characters and can contain letters, digits, hyphens (-), and underscores (_). Changing this creates a new instance resource.
    manegementConnectAddress String
    Indicates the connection address of the Kafka Manager of a Kafka instance.
    name String
    Specifies the name of the DMS Kafka instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, hyphens (-) and underscores (_).
    networkId String
    Specifies the ID of a VPC subnet. Changing this creates a new instance resource.
    nodeNum Double
    Indicates the count of ECS instances.
    partitionNum Double
    Indicates the maximum number of topics in the DMS Kafka instance.
    password String

    Specifies the password of the access user. A password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). Changing this creates a new instance resource.

    NOTE: If access_user and password are specified, Kafka SASL_SSL will be automatically enabled.

    port Double
    Indicates the port number of the DMS Kafka instance.
    productId String
    Specifies a product ID. You can get the value from id of flexibleengine.getDmsProduct data source. Changing this creates a new instance resource.
    productSpecCode String
    Indicates the DMS Kafka instance specification.
    region String
    Specifies the region in which to create the DMS Kafka instance resource. If omitted, the provider-level region will be used. Changing this creates a new instance resource.
    securityGroupId String
    Specifies the ID of a security group.
    securityGroupName String
    Indicates the name of a security group.
    sslEnable Boolean
    Indicates whether the Kafka SASL_SSL is enabled.
    status String
    Indicates the status of the DMS Kafka instance.
    storageSpace Double

    Specifies the message storage capacity, the unit is GB. Value range:

    • When bandwidth is 100MB: 600–90,000 GB
    • When bandwidth is 300MB: 1,200–90,000 GB
    • When bandwidth is 600MB: 2,400–90,000 GB
    • When bandwidth is 1,200MB: 4,800–90,000 GB

    Changing this creates a new instance resource.

    storageSpecCode String

    Specifies the storage I/O specification. Value range:

    • When bandwidth is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 600MB: dms.physical.storage.ultra
    • When bandwidth is 1,200MB: dms.physical.storage.ultra

    Defaults to dms.physical.storage.ultra. Changing this creates a new instance resource.

    subnetName String
    Indicates the name of a subnet.
    tags Map<String,String>
    Specifies the key/value pairs to associate with the DMS Kafka instance. Changing this will create a new resource.
    timeouts DmsKafkaInstanceTimeouts
    usedStorageSpace Double
    Indicates the used message storage space. Unit: GB
    vpcId String
    Specifies the ID of a VPC. Changing this creates a new instance resource.
    vpcName String
    Indicates the name of a vpc.
    accessUser string
    Specifies a username who can accesse the instance with SASL authentication. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.
    availabilityZones string[]

    The names of the AZ where the Kafka instance resides. Changing this creates a new instance resource.

    NOTE: Deploy one availability zone or at least three availability zones. Do not select two availability zones. Deploy to more availability zones, the better the reliability and SLA coverage.

    bandwidth string
    The baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. The valid values are 100MB, 300MB, 600MB and 1200MB. Changing this creates a new instance resource.
    connectAddress string
    Indicates the IP addresses of the DMS Kafka instance.
    createdAt string
    Indicates the creation time of the DMS Kafka instance.
    description string
    Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.
    dmsKafkaInstanceId string
    Specifies a resource ID in UUID format.
    enableAutoTopic boolean
    Specifies whether to enable automatic topic creation. If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist. Changing this creates a new instance resource.
    engine string
    Indicates the message engine, the value is "kafka".
    engineType string
    Indicates the DMS Kafka instance type, the value is "cluster".
    engineVersion string
    Specifies the version of the Kafka engine. Valid values are "1.1.0" and "2.3.0". Defaults to 2.3.0. Changing this creates a new instance resource.
    maintainBegin string
    Specifies the time at which a maintenance time window starts. Format: HH:mm:ss. The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00. The system automatically allocates the default start time 02:00:00.
    maintainEnd string

    Specifies the time at which a maintenance time window ends. Format: HH:mm:ss. The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00. The system automatically allocates the default end time 06:00:00.

    NOTE: The start time and end time of a maintenance time window must be set in pairs.

    managerPassword string
    Specifies the password for logging in to the Kafka Manager. The password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_ =+\|[{}]:'",<.>/?). Changing this creates a new instance resource.
    managerUser string
    Specifies the username for logging in to the Kafka Manager. The username consists of 4 to 64 characters and can contain letters, digits, hyphens (-), and underscores (_). Changing this creates a new instance resource.
    manegementConnectAddress string
    Indicates the connection address of the Kafka Manager of a Kafka instance.
    name string
    Specifies the name of the DMS Kafka instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, hyphens (-) and underscores (_).
    networkId string
    Specifies the ID of a VPC subnet. Changing this creates a new instance resource.
    nodeNum number
    Indicates the count of ECS instances.
    partitionNum number
    Indicates the maximum number of topics in the DMS Kafka instance.
    password string

    Specifies the password of the access user. A password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). Changing this creates a new instance resource.

    NOTE: If access_user and password are specified, Kafka SASL_SSL will be automatically enabled.

    port number
    Indicates the port number of the DMS Kafka instance.
    productId string
    Specifies a product ID. You can get the value from id of flexibleengine.getDmsProduct data source. Changing this creates a new instance resource.
    productSpecCode string
    Indicates the DMS Kafka instance specification.
    region string
    Specifies the region in which to create the DMS Kafka instance resource. If omitted, the provider-level region will be used. Changing this creates a new instance resource.
    securityGroupId string
    Specifies the ID of a security group.
    securityGroupName string
    Indicates the name of a security group.
    sslEnable boolean
    Indicates whether the Kafka SASL_SSL is enabled.
    status string
    Indicates the status of the DMS Kafka instance.
    storageSpace number

    Specifies the message storage capacity, the unit is GB. Value range:

    • When bandwidth is 100MB: 600–90,000 GB
    • When bandwidth is 300MB: 1,200–90,000 GB
    • When bandwidth is 600MB: 2,400–90,000 GB
    • When bandwidth is 1,200MB: 4,800–90,000 GB

    Changing this creates a new instance resource.

    storageSpecCode string

    Specifies the storage I/O specification. Value range:

    • When bandwidth is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 600MB: dms.physical.storage.ultra
    • When bandwidth is 1,200MB: dms.physical.storage.ultra

    Defaults to dms.physical.storage.ultra. Changing this creates a new instance resource.

    subnetName string
    Indicates the name of a subnet.
    tags {[key: string]: string}
    Specifies the key/value pairs to associate with the DMS Kafka instance. Changing this will create a new resource.
    timeouts DmsKafkaInstanceTimeouts
    usedStorageSpace number
    Indicates the used message storage space. Unit: GB
    vpcId string
    Specifies the ID of a VPC. Changing this creates a new instance resource.
    vpcName string
    Indicates the name of a vpc.
    access_user str
    Specifies a username who can accesse the instance with SASL authentication. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.
    availability_zones Sequence[str]

    The names of the AZ where the Kafka instance resides. Changing this creates a new instance resource.

    NOTE: Deploy one availability zone or at least three availability zones. Do not select two availability zones. Deploy to more availability zones, the better the reliability and SLA coverage.

    bandwidth str
    The baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. The valid values are 100MB, 300MB, 600MB and 1200MB. Changing this creates a new instance resource.
    connect_address str
    Indicates the IP addresses of the DMS Kafka instance.
    created_at str
    Indicates the creation time of the DMS Kafka instance.
    description str
    Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.
    dms_kafka_instance_id str
    Specifies a resource ID in UUID format.
    enable_auto_topic bool
    Specifies whether to enable automatic topic creation. If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist. Changing this creates a new instance resource.
    engine str
    Indicates the message engine, the value is "kafka".
    engine_type str
    Indicates the DMS Kafka instance type, the value is "cluster".
    engine_version str
    Specifies the version of the Kafka engine. Valid values are "1.1.0" and "2.3.0". Defaults to 2.3.0. Changing this creates a new instance resource.
    maintain_begin str
    Specifies the time at which a maintenance time window starts. Format: HH:mm:ss. The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00. The system automatically allocates the default start time 02:00:00.
    maintain_end str

    Specifies the time at which a maintenance time window ends. Format: HH:mm:ss. The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00. The system automatically allocates the default end time 06:00:00.

    NOTE: The start time and end time of a maintenance time window must be set in pairs.

    manager_password str
    Specifies the password for logging in to the Kafka Manager. The password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_ =+\|[{}]:'",<.>/?). Changing this creates a new instance resource.
    manager_user str
    Specifies the username for logging in to the Kafka Manager. The username consists of 4 to 64 characters and can contain letters, digits, hyphens (-), and underscores (_). Changing this creates a new instance resource.
    manegement_connect_address str
    Indicates the connection address of the Kafka Manager of a Kafka instance.
    name str
    Specifies the name of the DMS Kafka instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, hyphens (-) and underscores (_).
    network_id str
    Specifies the ID of a VPC subnet. Changing this creates a new instance resource.
    node_num float
    Indicates the count of ECS instances.
    partition_num float
    Indicates the maximum number of topics in the DMS Kafka instance.
    password str

    Specifies the password of the access user. A password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). Changing this creates a new instance resource.

    NOTE: If access_user and password are specified, Kafka SASL_SSL will be automatically enabled.

    port float
    Indicates the port number of the DMS Kafka instance.
    product_id str
    Specifies a product ID. You can get the value from id of flexibleengine.getDmsProduct data source. Changing this creates a new instance resource.
    product_spec_code str
    Indicates the DMS Kafka instance specification.
    region str
    Specifies the region in which to create the DMS Kafka instance resource. If omitted, the provider-level region will be used. Changing this creates a new instance resource.
    security_group_id str
    Specifies the ID of a security group.
    security_group_name str
    Indicates the name of a security group.
    ssl_enable bool
    Indicates whether the Kafka SASL_SSL is enabled.
    status str
    Indicates the status of the DMS Kafka instance.
    storage_space float

    Specifies the message storage capacity, the unit is GB. Value range:

    • When bandwidth is 100MB: 600–90,000 GB
    • When bandwidth is 300MB: 1,200–90,000 GB
    • When bandwidth is 600MB: 2,400–90,000 GB
    • When bandwidth is 1,200MB: 4,800–90,000 GB

    Changing this creates a new instance resource.

    storage_spec_code str

    Specifies the storage I/O specification. Value range:

    • When bandwidth is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 600MB: dms.physical.storage.ultra
    • When bandwidth is 1,200MB: dms.physical.storage.ultra

    Defaults to dms.physical.storage.ultra. Changing this creates a new instance resource.

    subnet_name str
    Indicates the name of a subnet.
    tags Mapping[str, str]
    Specifies the key/value pairs to associate with the DMS Kafka instance. Changing this will create a new resource.
    timeouts DmsKafkaInstanceTimeoutsArgs
    used_storage_space float
    Indicates the used message storage space. Unit: GB
    vpc_id str
    Specifies the ID of a VPC. Changing this creates a new instance resource.
    vpc_name str
    Indicates the name of a vpc.
    accessUser String
    Specifies a username who can accesse the instance with SASL authentication. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.
    availabilityZones List<String>

    The names of the AZ where the Kafka instance resides. Changing this creates a new instance resource.

    NOTE: Deploy one availability zone or at least three availability zones. Do not select two availability zones. Deploy to more availability zones, the better the reliability and SLA coverage.

    bandwidth String
    The baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. The valid values are 100MB, 300MB, 600MB and 1200MB. Changing this creates a new instance resource.
    connectAddress String
    Indicates the IP addresses of the DMS Kafka instance.
    createdAt String
    Indicates the creation time of the DMS Kafka instance.
    description String
    Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.
    dmsKafkaInstanceId String
    Specifies a resource ID in UUID format.
    enableAutoTopic Boolean
    Specifies whether to enable automatic topic creation. If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist. Changing this creates a new instance resource.
    engine String
    Indicates the message engine, the value is "kafka".
    engineType String
    Indicates the DMS Kafka instance type, the value is "cluster".
    engineVersion String
    Specifies the version of the Kafka engine. Valid values are "1.1.0" and "2.3.0". Defaults to 2.3.0. Changing this creates a new instance resource.
    maintainBegin String
    Specifies the time at which a maintenance time window starts. Format: HH:mm:ss. The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00. The system automatically allocates the default start time 02:00:00.
    maintainEnd String

    Specifies the time at which a maintenance time window ends. Format: HH:mm:ss. The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00. The system automatically allocates the default end time 06:00:00.

    NOTE: The start time and end time of a maintenance time window must be set in pairs.

    managerPassword String
    Specifies the password for logging in to the Kafka Manager. The password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_ =+\|[{}]:'",<.>/?). Changing this creates a new instance resource.
    managerUser String
    Specifies the username for logging in to the Kafka Manager. The username consists of 4 to 64 characters and can contain letters, digits, hyphens (-), and underscores (_). Changing this creates a new instance resource.
    manegementConnectAddress String
    Indicates the connection address of the Kafka Manager of a Kafka instance.
    name String
    Specifies the name of the DMS Kafka instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, hyphens (-) and underscores (_).
    networkId String
    Specifies the ID of a VPC subnet. Changing this creates a new instance resource.
    nodeNum Number
    Indicates the count of ECS instances.
    partitionNum Number
    Indicates the maximum number of topics in the DMS Kafka instance.
    password String

    Specifies the password of the access user. A password must meet the following complexity requirements: Must be 8 to 32 characters long. Must contain at least 2 of the following character types: lowercase letters, uppercase letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). Changing this creates a new instance resource.

    NOTE: If access_user and password are specified, Kafka SASL_SSL will be automatically enabled.

    port Number
    Indicates the port number of the DMS Kafka instance.
    productId String
    Specifies a product ID. You can get the value from id of flexibleengine.getDmsProduct data source. Changing this creates a new instance resource.
    productSpecCode String
    Indicates the DMS Kafka instance specification.
    region String
    Specifies the region in which to create the DMS Kafka instance resource. If omitted, the provider-level region will be used. Changing this creates a new instance resource.
    securityGroupId String
    Specifies the ID of a security group.
    securityGroupName String
    Indicates the name of a security group.
    sslEnable Boolean
    Indicates whether the Kafka SASL_SSL is enabled.
    status String
    Indicates the status of the DMS Kafka instance.
    storageSpace Number

    Specifies the message storage capacity, the unit is GB. Value range:

    • When bandwidth is 100MB: 600–90,000 GB
    • When bandwidth is 300MB: 1,200–90,000 GB
    • When bandwidth is 600MB: 2,400–90,000 GB
    • When bandwidth is 1,200MB: 4,800–90,000 GB

    Changing this creates a new instance resource.

    storageSpecCode String

    Specifies the storage I/O specification. Value range:

    • When bandwidth is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
    • When bandwidth is 600MB: dms.physical.storage.ultra
    • When bandwidth is 1,200MB: dms.physical.storage.ultra

    Defaults to dms.physical.storage.ultra. Changing this creates a new instance resource.

    subnetName String
    Indicates the name of a subnet.
    tags Map<String>
    Specifies the key/value pairs to associate with the DMS Kafka instance. Changing this will create a new resource.
    timeouts Property Map
    usedStorageSpace Number
    Indicates the used message storage space. Unit: GB
    vpcId String
    Specifies the ID of a VPC. Changing this creates a new instance resource.
    vpcName String
    Indicates the name of a vpc.

    Supporting Types

    DmsKafkaInstanceTimeouts, DmsKafkaInstanceTimeoutsArgs

    Create string
    Delete string
    Create string
    Delete string
    create String
    delete String
    create string
    delete string
    create str
    delete str
    create String
    delete String

    Import

    DMS Kafka instance can be imported using the instance id, e.g.

    $ pulumi import flexibleengine:index/dmsKafkaInstance:DmsKafkaInstance instance_1 8d3c7938-dc47-4937-a30f-c80de381c5e3

    Note that the imported state may not be identical to your resource definition, because of access_user, password,

    manager_user and manager_password are missing from the API response due to security reason.

    It is generally recommended running pulumi preview after importing a DMS Kafka instance.

    You can then decide if changes should be applied to the instance, or the resource

    definition should be updated to align with the instance. Also you can ignore changes as below.

    hcl

    resource “flexibleengine_dms_kafka_instance” “instance_1” {

    ...

    lifecycle {

    ignore_changes = [

  access_user, password, manager_user, manager_password,

]

    }

    }

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

    Package Details

    Repository
    flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
    License
    Notes
    This Pulumi package is based on the flexibleengine Terraform Provider.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
    flexibleenginecloud/terraform-provider-flexibleengine