opentelekomcloud 1.36.37, Apr 24 25

opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.DmsDedicatedInstanceV2

Explore with Pulumi AI

opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

Example Usage

Create DmsDedicatedInstanceV2 Resource

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

Constructor syntax

new DmsDedicatedInstanceV2(name: string, args: DmsDedicatedInstanceV2Args, opts?: CustomResourceOptions);

@overload
def DmsDedicatedInstanceV2(resource_name: str,
                           args: DmsDedicatedInstanceV2Args,
                           opts: Optional[ResourceOptions] = None)

@overload
def DmsDedicatedInstanceV2(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           engine_version: Optional[str] = None,
                           vpc_id: Optional[str] = None,
                           storage_spec_code: Optional[str] = None,
                           broker_num: Optional[float] = None,
                           storage_space: Optional[float] = None,
                           security_group_id: Optional[str] = None,
                           network_id: Optional[str] = None,
                           flavor_id: Optional[str] = None,
                           maintain_begin: Optional[str] = None,
                           password: Optional[str] = None,
                           enabled_mechanisms: Optional[Sequence[str]] = None,
                           dms_dedicated_instance_v2_id: Optional[str] = None,
                           disk_encrypted_key: Optional[str] = None,
                           ipv6_enable: Optional[bool] = None,
                           access_user: Optional[str] = None,
                           maintain_end: Optional[str] = None,
                           name: Optional[str] = None,
                           disk_encrypted_enable: Optional[bool] = None,
                           new_tenant_ips: Optional[Sequence[str]] = None,
                           enable_publicip: Optional[bool] = None,
                           publicip_ids: Optional[Sequence[str]] = None,
                           retention_policy: Optional[str] = None,
                           description: Optional[str] = None,
                           security_protocol: Optional[str] = None,
                           ssl_enable: Optional[bool] = None,
                           cross_vpc_accesses: Optional[Sequence[DmsDedicatedInstanceV2CrossVpcAccessArgs]] = None,
                           available_zones: Optional[Sequence[str]] = None,
                           tags: Optional[Mapping[str, str]] = None,
                           timeouts: Optional[DmsDedicatedInstanceV2TimeoutsArgs] = None,
                           arch_type: Optional[str] = None)

func NewDmsDedicatedInstanceV2(ctx *Context, name string, args DmsDedicatedInstanceV2Args, opts ...ResourceOption) (*DmsDedicatedInstanceV2, error)

public DmsDedicatedInstanceV2(string name, DmsDedicatedInstanceV2Args args, CustomResourceOptions? opts = null)

public DmsDedicatedInstanceV2(String name, DmsDedicatedInstanceV2Args args)
public DmsDedicatedInstanceV2(String name, DmsDedicatedInstanceV2Args args, CustomResourceOptions options)

type: opentelekomcloud:DmsDedicatedInstanceV2
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 DmsDedicatedInstanceV2Args: 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 DmsDedicatedInstanceV2Args: 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 DmsDedicatedInstanceV2Args: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DmsDedicatedInstanceV2Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DmsDedicatedInstanceV2Args: 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 dmsDedicatedInstanceV2Resource = new Opentelekomcloud.DmsDedicatedInstanceV2("dmsDedicatedInstanceV2Resource", new()
{
    EngineVersion = "string",
    VpcId = "string",
    StorageSpecCode = "string",
    BrokerNum = 0,
    StorageSpace = 0,
    SecurityGroupId = "string",
    NetworkId = "string",
    FlavorId = "string",
    MaintainBegin = "string",
    Password = "string",
    EnabledMechanisms = new[]
    {
        "string",
    },
    DmsDedicatedInstanceV2Id = "string",
    DiskEncryptedKey = "string",
    Ipv6Enable = false,
    AccessUser = "string",
    MaintainEnd = "string",
    Name = "string",
    DiskEncryptedEnable = false,
    NewTenantIps = new[]
    {
        "string",
    },
    EnablePublicip = false,
    PublicipIds = new[]
    {
        "string",
    },
    RetentionPolicy = "string",
    Description = "string",
    SecurityProtocol = "string",
    SslEnable = false,
    CrossVpcAccesses = new[]
    {
        new Opentelekomcloud.Inputs.DmsDedicatedInstanceV2CrossVpcAccessArgs
        {
            AdvertisedIp = "string",
            ListenerIp = "string",
            Port = 0,
            PortId = "string",
        },
    },
    AvailableZones = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Opentelekomcloud.Inputs.DmsDedicatedInstanceV2TimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    ArchType = "string",
});

example, err := opentelekomcloud.NewDmsDedicatedInstanceV2(ctx, "dmsDedicatedInstanceV2Resource", &opentelekomcloud.DmsDedicatedInstanceV2Args{
	EngineVersion:   pulumi.String("string"),
	VpcId:           pulumi.String("string"),
	StorageSpecCode: pulumi.String("string"),
	BrokerNum:       pulumi.Float64(0),
	StorageSpace:    pulumi.Float64(0),
	SecurityGroupId: pulumi.String("string"),
	NetworkId:       pulumi.String("string"),
	FlavorId:        pulumi.String("string"),
	MaintainBegin:   pulumi.String("string"),
	Password:        pulumi.String("string"),
	EnabledMechanisms: pulumi.StringArray{
		pulumi.String("string"),
	},
	DmsDedicatedInstanceV2Id: pulumi.String("string"),
	DiskEncryptedKey:         pulumi.String("string"),
	Ipv6Enable:               pulumi.Bool(false),
	AccessUser:               pulumi.String("string"),
	MaintainEnd:              pulumi.String("string"),
	Name:                     pulumi.String("string"),
	DiskEncryptedEnable:      pulumi.Bool(false),
	NewTenantIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	EnablePublicip: pulumi.Bool(false),
	PublicipIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	RetentionPolicy:  pulumi.String("string"),
	Description:      pulumi.String("string"),
	SecurityProtocol: pulumi.String("string"),
	SslEnable:        pulumi.Bool(false),
	CrossVpcAccesses: opentelekomcloud.DmsDedicatedInstanceV2CrossVpcAccessArray{
		&opentelekomcloud.DmsDedicatedInstanceV2CrossVpcAccessArgs{
			AdvertisedIp: pulumi.String("string"),
			ListenerIp:   pulumi.String("string"),
			Port:         pulumi.Float64(0),
			PortId:       pulumi.String("string"),
		},
	},
	AvailableZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &opentelekomcloud.DmsDedicatedInstanceV2TimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	ArchType: pulumi.String("string"),
})

var dmsDedicatedInstanceV2Resource = new DmsDedicatedInstanceV2("dmsDedicatedInstanceV2Resource", DmsDedicatedInstanceV2Args.builder()
    .engineVersion("string")
    .vpcId("string")
    .storageSpecCode("string")
    .brokerNum(0)
    .storageSpace(0)
    .securityGroupId("string")
    .networkId("string")
    .flavorId("string")
    .maintainBegin("string")
    .password("string")
    .enabledMechanisms("string")
    .dmsDedicatedInstanceV2Id("string")
    .diskEncryptedKey("string")
    .ipv6Enable(false)
    .accessUser("string")
    .maintainEnd("string")
    .name("string")
    .diskEncryptedEnable(false)
    .newTenantIps("string")
    .enablePublicip(false)
    .publicipIds("string")
    .retentionPolicy("string")
    .description("string")
    .securityProtocol("string")
    .sslEnable(false)
    .crossVpcAccesses(DmsDedicatedInstanceV2CrossVpcAccessArgs.builder()
        .advertisedIp("string")
        .listenerIp("string")
        .port(0)
        .portId("string")
        .build())
    .availableZones("string")
    .tags(Map.of("string", "string"))
    .timeouts(DmsDedicatedInstanceV2TimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .archType("string")
    .build());

dms_dedicated_instance_v2_resource = opentelekomcloud.DmsDedicatedInstanceV2("dmsDedicatedInstanceV2Resource",
    engine_version="string",
    vpc_id="string",
    storage_spec_code="string",
    broker_num=0,
    storage_space=0,
    security_group_id="string",
    network_id="string",
    flavor_id="string",
    maintain_begin="string",
    password="string",
    enabled_mechanisms=["string"],
    dms_dedicated_instance_v2_id="string",
    disk_encrypted_key="string",
    ipv6_enable=False,
    access_user="string",
    maintain_end="string",
    name="string",
    disk_encrypted_enable=False,
    new_tenant_ips=["string"],
    enable_publicip=False,
    publicip_ids=["string"],
    retention_policy="string",
    description="string",
    security_protocol="string",
    ssl_enable=False,
    cross_vpc_accesses=[{
        "advertised_ip": "string",
        "listener_ip": "string",
        "port": 0,
        "port_id": "string",
    }],
    available_zones=["string"],
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    arch_type="string")

const dmsDedicatedInstanceV2Resource = new opentelekomcloud.DmsDedicatedInstanceV2("dmsDedicatedInstanceV2Resource", {
    engineVersion: "string",
    vpcId: "string",
    storageSpecCode: "string",
    brokerNum: 0,
    storageSpace: 0,
    securityGroupId: "string",
    networkId: "string",
    flavorId: "string",
    maintainBegin: "string",
    password: "string",
    enabledMechanisms: ["string"],
    dmsDedicatedInstanceV2Id: "string",
    diskEncryptedKey: "string",
    ipv6Enable: false,
    accessUser: "string",
    maintainEnd: "string",
    name: "string",
    diskEncryptedEnable: false,
    newTenantIps: ["string"],
    enablePublicip: false,
    publicipIds: ["string"],
    retentionPolicy: "string",
    description: "string",
    securityProtocol: "string",
    sslEnable: false,
    crossVpcAccesses: [{
        advertisedIp: "string",
        listenerIp: "string",
        port: 0,
        portId: "string",
    }],
    availableZones: ["string"],
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    archType: "string",
});

type: opentelekomcloud:DmsDedicatedInstanceV2
properties:
    accessUser: string
    archType: string
    availableZones:
        - string
    brokerNum: 0
    crossVpcAccesses:
        - advertisedIp: string
          listenerIp: string
          port: 0
          portId: string
    description: string
    diskEncryptedEnable: false
    diskEncryptedKey: string
    dmsDedicatedInstanceV2Id: string
    enablePublicip: false
    enabledMechanisms:
        - string
    engineVersion: string
    flavorId: string
    ipv6Enable: false
    maintainBegin: string
    maintainEnd: string
    name: string
    networkId: string
    newTenantIps:
        - string
    password: string
    publicipIds:
        - string
    retentionPolicy: string
    securityGroupId: string
    securityProtocol: string
    sslEnable: false
    storageSpace: 0
    storageSpecCode: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string
    vpcId: string

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

BrokerNum double

Specifies the broker numbers.

EngineVersion string

Specifies the version of the Kafka engine, such as 1.1.0, 2.3.0, 2.7 or other supported versions. Changing this creates a new instance resource.

FlavorId string

Specifies the Kafka [flavor ID](https://docs.otc.t-systems.com/distributed-message-service/api-ref/apis_v2_recommended/other_apis/querying_product_specifications_list.html#listengineproducts, e.g. c6.2u4g.cluster.

NetworkId string

Specifies the ID of a subnet. 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. The storage spaces corresponding to the product IDs are as follows:

c6.2u4g.cluster (100MB bandwidth): 300 to 300,000 GB
c6.4u8g.cluster (300MB bandwidth): 300 to 600,000 GB
c6.8u16g.cluster (600MB bandwidth): 300 to 900,000 GB
c6.12u12g.cluster: 300 to 900,000 GB
c6.16u32g.cluster (1,200MB bandwidth): 300 to 900,000 GB

StorageSpecCode string

Specifies the storage I/O specification. The valid values are as follows:

dms.physical.storage.high.v2: Type of the disk that uses high I/O.
dms.physical.storage.ultra.v2: Type of the disk that uses ultra-high I/O.

VpcId string

Specifies the ID of a VPC. Changing this creates a new instance resource.

AccessUser string

Specifies the username of SASL_SSL user. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.

ArchType string

Specifies the CPU architecture. Valid value is X86. Changing this creates a new instance resource.

AvailableZones List<string>

Indicates the ID of an AZ. The parameter value can not be left blank or an empty array. For details, see section Querying AZ Information.

CrossVpcAccesses List<DmsDedicatedInstanceV2CrossVpcAccess>

Specifies the cross-VPC access information. The object structure is documented below.

The cross_vpc_accesses block supports:

Description string

Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.

DiskEncryptedEnable bool

Indicates whether to enable disk encryption.

DiskEncryptedKey string

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

DmsDedicatedInstanceV2Id string

Specifies a resource ID in UUID format.

EnablePublicip bool

A list of IDs of the EIP bound to the instance. This parameter is mandatory if enable_publicip is set to true.

EnabledMechanisms List<string>

Specifies the authentication mechanisms to use after SASL is enabled. Value options:

PLAIN: Simple username and password verification.
SCRAM-SHA-512: User credential verification, which is more secure than PLAIN.

Defaults to [PLAIN]. Changing this creates a new instance resource.

Ipv6Enable bool

Specifies whether to enable IPv6. Defaults to false. Changing this creates a new instance resource.

MaintainBegin string

Specifies the time at which a maintenance time window starts. Format: HH:mm. The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window. The start time must be set to 22:00, 02:00, 06:00, 10:00, 14:00, or 18:00. Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_begin is left blank, parameter maintain_end is also blank. In this case, the system automatically allocates the default start time 02:00.

MaintainEnd string

Specifies the time at which a maintenance time window ends. Format: HH:mm. The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window. The end time is four hours later than the start time. For example, if the start time is 22:00, the end time is 02:00. Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_end is left blank, parameter maintain_begin is also blank. In this case, the system automatically allocates the default end time 06:00.

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 (_).

NewTenantIps List<string>

Specifies the IPv4 private IP addresses for the new brokers.

The number of specified IP addresses must be less than or equal to the number of new brokers.

Password string

Specifies the password of SASL_SSL 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 (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?).

NOTE: access_user and password is mandatory and available when ssl_enable is true.

PublicipIds List<string>

RetentionPolicy string

Specifies the action to be taken when the memory usage reaches the disk capacity threshold. The valid values are as follows:

time_base: Automatically delete the earliest messages.
produce_reject: Stop producing new messages.

SecurityProtocol string

Specifies the protocol to use after SASL is enabled. Value options:

SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol only uses the SCRAM-SHA-512 mechanism and delivers high performance.

Defaults to SASL_SSL. Changing this creates a new instance resource.

SslEnable bool

Specifies whether the Kafka SASL_SSL is enabled. Changing this creates a new resource.

Tags Dictionary<string, string>

The key/value pairs to associate with the DMS Kafka instance.

Timeouts DmsDedicatedInstanceV2Timeouts

BrokerNum float64

Specifies the broker numbers.

EngineVersion string

Specifies the version of the Kafka engine, such as 1.1.0, 2.3.0, 2.7 or other supported versions. Changing this creates a new instance resource.

FlavorId string

NetworkId string

Specifies the ID of a subnet. 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. The storage spaces corresponding to the product IDs are as follows:

c6.2u4g.cluster (100MB bandwidth): 300 to 300,000 GB
c6.4u8g.cluster (300MB bandwidth): 300 to 600,000 GB
c6.8u16g.cluster (600MB bandwidth): 300 to 900,000 GB
c6.12u12g.cluster: 300 to 900,000 GB
c6.16u32g.cluster (1,200MB bandwidth): 300 to 900,000 GB

StorageSpecCode string

Specifies the storage I/O specification. The valid values are as follows:

dms.physical.storage.high.v2: Type of the disk that uses high I/O.
dms.physical.storage.ultra.v2: Type of the disk that uses ultra-high I/O.

VpcId string

Specifies the ID of a VPC. Changing this creates a new instance resource.

AccessUser string

Specifies the username of SASL_SSL user. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.

ArchType string

Specifies the CPU architecture. Valid value is X86. Changing this creates a new instance resource.

AvailableZones []string

Indicates the ID of an AZ. The parameter value can not be left blank or an empty array. For details, see section Querying AZ Information.

CrossVpcAccesses []DmsDedicatedInstanceV2CrossVpcAccessArgs

Specifies the cross-VPC access information. The object structure is documented below.

The cross_vpc_accesses block supports:

Description string

Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.

DiskEncryptedEnable bool

Indicates whether to enable disk encryption.

DiskEncryptedKey string

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

DmsDedicatedInstanceV2Id string

Specifies a resource ID in UUID format.

EnablePublicip bool

A list of IDs of the EIP bound to the instance. This parameter is mandatory if enable_publicip is set to true.

EnabledMechanisms []string

Specifies the authentication mechanisms to use after SASL is enabled. Value options:

PLAIN: Simple username and password verification.
SCRAM-SHA-512: User credential verification, which is more secure than PLAIN.

Defaults to [PLAIN]. Changing this creates a new instance resource.

Ipv6Enable bool

Specifies whether to enable IPv6. Defaults to false. Changing this creates a new instance resource.

MaintainBegin string

MaintainEnd string

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 (_).

NewTenantIps []string

Specifies the IPv4 private IP addresses for the new brokers.

The number of specified IP addresses must be less than or equal to the number of new brokers.

Password string

NOTE: access_user and password is mandatory and available when ssl_enable is true.

PublicipIds []string

RetentionPolicy string

Specifies the action to be taken when the memory usage reaches the disk capacity threshold. The valid values are as follows:

time_base: Automatically delete the earliest messages.
produce_reject: Stop producing new messages.

SecurityProtocol string

Specifies the protocol to use after SASL is enabled. Value options:

SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol only uses the SCRAM-SHA-512 mechanism and delivers high performance.

Defaults to SASL_SSL. Changing this creates a new instance resource.

SslEnable bool

Specifies whether the Kafka SASL_SSL is enabled. Changing this creates a new resource.

Tags map[string]string

The key/value pairs to associate with the DMS Kafka instance.

Timeouts DmsDedicatedInstanceV2TimeoutsArgs

brokerNum Double

Specifies the broker numbers.

engineVersion String

Specifies the version of the Kafka engine, such as 1.1.0, 2.3.0, 2.7 or other supported versions. Changing this creates a new instance resource.

flavorId String

networkId String

Specifies the ID of a subnet. 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. The storage spaces corresponding to the product IDs are as follows:

c6.2u4g.cluster (100MB bandwidth): 300 to 300,000 GB
c6.4u8g.cluster (300MB bandwidth): 300 to 600,000 GB
c6.8u16g.cluster (600MB bandwidth): 300 to 900,000 GB
c6.12u12g.cluster: 300 to 900,000 GB
c6.16u32g.cluster (1,200MB bandwidth): 300 to 900,000 GB

storageSpecCode String

Specifies the storage I/O specification. The valid values are as follows:

dms.physical.storage.high.v2: Type of the disk that uses high I/O.
dms.physical.storage.ultra.v2: Type of the disk that uses ultra-high I/O.

vpcId String

Specifies the ID of a VPC. Changing this creates a new instance resource.

accessUser String

Specifies the username of SASL_SSL user. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.

archType String

Specifies the CPU architecture. Valid value is X86. Changing this creates a new instance resource.

availableZones List<String>

Indicates the ID of an AZ. The parameter value can not be left blank or an empty array. For details, see section Querying AZ Information.

crossVpcAccesses List<DmsDedicatedInstanceV2CrossVpcAccess>

Specifies the cross-VPC access information. The object structure is documented below.

The cross_vpc_accesses block supports:

description String

Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.

diskEncryptedEnable Boolean

Indicates whether to enable disk encryption.

diskEncryptedKey String

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

dmsDedicatedInstanceV2Id String

Specifies a resource ID in UUID format.

enablePublicip Boolean

A list of IDs of the EIP bound to the instance. This parameter is mandatory if enable_publicip is set to true.

enabledMechanisms List<String>

Specifies the authentication mechanisms to use after SASL is enabled. Value options:

PLAIN: Simple username and password verification.
SCRAM-SHA-512: User credential verification, which is more secure than PLAIN.

Defaults to [PLAIN]. Changing this creates a new instance resource.

ipv6Enable Boolean

Specifies whether to enable IPv6. Defaults to false. Changing this creates a new instance resource.

maintainBegin String

maintainEnd String

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 (_).

newTenantIps List<String>

Specifies the IPv4 private IP addresses for the new brokers.

The number of specified IP addresses must be less than or equal to the number of new brokers.

password String

NOTE: access_user and password is mandatory and available when ssl_enable is true.

publicipIds List<String>

retentionPolicy String

Specifies the action to be taken when the memory usage reaches the disk capacity threshold. The valid values are as follows:

time_base: Automatically delete the earliest messages.
produce_reject: Stop producing new messages.

securityProtocol String

Specifies the protocol to use after SASL is enabled. Value options:

SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol only uses the SCRAM-SHA-512 mechanism and delivers high performance.

Defaults to SASL_SSL. Changing this creates a new instance resource.

sslEnable Boolean

Specifies whether the Kafka SASL_SSL is enabled. Changing this creates a new resource.

tags Map<String,String>

The key/value pairs to associate with the DMS Kafka instance.

timeouts DmsDedicatedInstanceV2Timeouts

brokerNum number

Specifies the broker numbers.

engineVersion string

Specifies the version of the Kafka engine, such as 1.1.0, 2.3.0, 2.7 or other supported versions. Changing this creates a new instance resource.

flavorId string

networkId string

Specifies the ID of a subnet. 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. The storage spaces corresponding to the product IDs are as follows:

c6.2u4g.cluster (100MB bandwidth): 300 to 300,000 GB
c6.4u8g.cluster (300MB bandwidth): 300 to 600,000 GB
c6.8u16g.cluster (600MB bandwidth): 300 to 900,000 GB
c6.12u12g.cluster: 300 to 900,000 GB
c6.16u32g.cluster (1,200MB bandwidth): 300 to 900,000 GB

storageSpecCode string

Specifies the storage I/O specification. The valid values are as follows:

dms.physical.storage.high.v2: Type of the disk that uses high I/O.
dms.physical.storage.ultra.v2: Type of the disk that uses ultra-high I/O.

vpcId string

Specifies the ID of a VPC. Changing this creates a new instance resource.

accessUser string

Specifies the username of SASL_SSL user. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.

archType string

Specifies the CPU architecture. Valid value is X86. Changing this creates a new instance resource.

availableZones string[]

Indicates the ID of an AZ. The parameter value can not be left blank or an empty array. For details, see section Querying AZ Information.

crossVpcAccesses DmsDedicatedInstanceV2CrossVpcAccess[]

Specifies the cross-VPC access information. The object structure is documented below.

The cross_vpc_accesses block supports:

description string

Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.

diskEncryptedEnable boolean

Indicates whether to enable disk encryption.

diskEncryptedKey string

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

dmsDedicatedInstanceV2Id string

Specifies a resource ID in UUID format.

enablePublicip boolean

A list of IDs of the EIP bound to the instance. This parameter is mandatory if enable_publicip is set to true.

enabledMechanisms string[]

Specifies the authentication mechanisms to use after SASL is enabled. Value options:

PLAIN: Simple username and password verification.
SCRAM-SHA-512: User credential verification, which is more secure than PLAIN.

Defaults to [PLAIN]. Changing this creates a new instance resource.

ipv6Enable boolean

Specifies whether to enable IPv6. Defaults to false. Changing this creates a new instance resource.

maintainBegin string

maintainEnd string

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 (_).

newTenantIps string[]

Specifies the IPv4 private IP addresses for the new brokers.

The number of specified IP addresses must be less than or equal to the number of new brokers.

password string

NOTE: access_user and password is mandatory and available when ssl_enable is true.

publicipIds string[]

retentionPolicy string

Specifies the action to be taken when the memory usage reaches the disk capacity threshold. The valid values are as follows:

time_base: Automatically delete the earliest messages.
produce_reject: Stop producing new messages.

securityProtocol string

Specifies the protocol to use after SASL is enabled. Value options:

SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol only uses the SCRAM-SHA-512 mechanism and delivers high performance.

Defaults to SASL_SSL. Changing this creates a new instance resource.

sslEnable boolean

Specifies whether the Kafka SASL_SSL is enabled. Changing this creates a new resource.

tags {[key: string]: string}

The key/value pairs to associate with the DMS Kafka instance.

timeouts DmsDedicatedInstanceV2Timeouts

broker_num float

Specifies the broker numbers.

engine_version str

Specifies the version of the Kafka engine, such as 1.1.0, 2.3.0, 2.7 or other supported versions. Changing this creates a new instance resource.

flavor_id str

network_id str

Specifies the ID of a subnet. 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. The storage spaces corresponding to the product IDs are as follows:

c6.2u4g.cluster (100MB bandwidth): 300 to 300,000 GB
c6.4u8g.cluster (300MB bandwidth): 300 to 600,000 GB
c6.8u16g.cluster (600MB bandwidth): 300 to 900,000 GB
c6.12u12g.cluster: 300 to 900,000 GB
c6.16u32g.cluster (1,200MB bandwidth): 300 to 900,000 GB

storage_spec_code str

Specifies the storage I/O specification. The valid values are as follows:

dms.physical.storage.high.v2: Type of the disk that uses high I/O.
dms.physical.storage.ultra.v2: Type of the disk that uses ultra-high I/O.

vpc_id str

Specifies the ID of a VPC. Changing this creates a new instance resource.

access_user str

Specifies the username of SASL_SSL user. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.

arch_type str

Specifies the CPU architecture. Valid value is X86. Changing this creates a new instance resource.

available_zones Sequence[str]

Indicates the ID of an AZ. The parameter value can not be left blank or an empty array. For details, see section Querying AZ Information.

cross_vpc_accesses Sequence[DmsDedicatedInstanceV2CrossVpcAccessArgs]

Specifies the cross-VPC access information. The object structure is documented below.

The cross_vpc_accesses block supports:

description str

Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.

disk_encrypted_enable bool

Indicates whether to enable disk encryption.

disk_encrypted_key str

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

dms_dedicated_instance_v2_id str

Specifies a resource ID in UUID format.

enable_publicip bool

A list of IDs of the EIP bound to the instance. This parameter is mandatory if enable_publicip is set to true.

enabled_mechanisms Sequence[str]

Specifies the authentication mechanisms to use after SASL is enabled. Value options:

PLAIN: Simple username and password verification.
SCRAM-SHA-512: User credential verification, which is more secure than PLAIN.

Defaults to [PLAIN]. Changing this creates a new instance resource.

ipv6_enable bool

Specifies whether to enable IPv6. Defaults to false. Changing this creates a new instance resource.

maintain_begin str

maintain_end str

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 (_).

new_tenant_ips Sequence[str]

Specifies the IPv4 private IP addresses for the new brokers.

The number of specified IP addresses must be less than or equal to the number of new brokers.

password str

NOTE: access_user and password is mandatory and available when ssl_enable is true.

publicip_ids Sequence[str]

retention_policy str

Specifies the action to be taken when the memory usage reaches the disk capacity threshold. The valid values are as follows:

time_base: Automatically delete the earliest messages.
produce_reject: Stop producing new messages.

security_protocol str

Specifies the protocol to use after SASL is enabled. Value options:

SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol only uses the SCRAM-SHA-512 mechanism and delivers high performance.

Defaults to SASL_SSL. Changing this creates a new instance resource.

ssl_enable bool

Specifies whether the Kafka SASL_SSL is enabled. Changing this creates a new resource.

tags Mapping[str, str]

The key/value pairs to associate with the DMS Kafka instance.

timeouts DmsDedicatedInstanceV2TimeoutsArgs

brokerNum Number

Specifies the broker numbers.

engineVersion String

Specifies the version of the Kafka engine, such as 1.1.0, 2.3.0, 2.7 or other supported versions. Changing this creates a new instance resource.

flavorId String

networkId String

Specifies the ID of a subnet. 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. The storage spaces corresponding to the product IDs are as follows:

c6.2u4g.cluster (100MB bandwidth): 300 to 300,000 GB
c6.4u8g.cluster (300MB bandwidth): 300 to 600,000 GB
c6.8u16g.cluster (600MB bandwidth): 300 to 900,000 GB
c6.12u12g.cluster: 300 to 900,000 GB
c6.16u32g.cluster (1,200MB bandwidth): 300 to 900,000 GB

storageSpecCode String

Specifies the storage I/O specification. The valid values are as follows:

dms.physical.storage.high.v2: Type of the disk that uses high I/O.
dms.physical.storage.ultra.v2: Type of the disk that uses ultra-high I/O.

vpcId String

Specifies the ID of a VPC. Changing this creates a new instance resource.

accessUser String

Specifies the username of SASL_SSL user. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.

archType String

Specifies the CPU architecture. Valid value is X86. Changing this creates a new instance resource.

availableZones List<String>

Indicates the ID of an AZ. The parameter value can not be left blank or an empty array. For details, see section Querying AZ Information.

crossVpcAccesses List<Property Map>

Specifies the cross-VPC access information. The object structure is documented below.

The cross_vpc_accesses block supports:

description String

Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.

diskEncryptedEnable Boolean

Indicates whether to enable disk encryption.

diskEncryptedKey String

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

dmsDedicatedInstanceV2Id String

Specifies a resource ID in UUID format.

enablePublicip Boolean

A list of IDs of the EIP bound to the instance. This parameter is mandatory if enable_publicip is set to true.

enabledMechanisms List<String>

Specifies the authentication mechanisms to use after SASL is enabled. Value options:

PLAIN: Simple username and password verification.
SCRAM-SHA-512: User credential verification, which is more secure than PLAIN.

Defaults to [PLAIN]. Changing this creates a new instance resource.

ipv6Enable Boolean

Specifies whether to enable IPv6. Defaults to false. Changing this creates a new instance resource.

maintainBegin String

maintainEnd String

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 (_).

newTenantIps List<String>

Specifies the IPv4 private IP addresses for the new brokers.

The number of specified IP addresses must be less than or equal to the number of new brokers.

password String

NOTE: access_user and password is mandatory and available when ssl_enable is true.

publicipIds List<String>

retentionPolicy String

Specifies the action to be taken when the memory usage reaches the disk capacity threshold. The valid values are as follows:

time_base: Automatically delete the earliest messages.
produce_reject: Stop producing new messages.

securityProtocol String

Specifies the protocol to use after SASL is enabled. Value options:

SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol only uses the SCRAM-SHA-512 mechanism and delivers high performance.

Defaults to SASL_SSL. Changing this creates a new instance resource.

sslEnable Boolean

Specifies whether the Kafka SASL_SSL is enabled. Changing this creates a new resource.

tags Map<String>

The key/value pairs to associate with the DMS Kafka instance.

timeouts Property Map

Outputs

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

Bandwidth string
CertReplaced bool: Indicates whether the certificate can be replaced.
ConnectAddress string: Indicates the IP address of the DMS Kafka instance.
ConnectorNodeNum double: Indicates the number of connector node.
CreatedAt string: Indicates the create time.
Dumping bool: Whether message dumping(smart connect) is enabled.
Engine string: Indicates the message engine.
Id string: The provider-assigned unique ID for this managed resource.
NodeNum double: Indicates the node quantity.
PartitionNum double: Indicates the number of partitions in Kafka instance.
PodConnectAddress string: Indicates the connection address on the tenant side.
Port double: The port number.
PublicBandwidth double: Indicates the public network access bandwidth.
PublicIpAddress string: Indicates the public IP addresses list of the instance.
Region string: The region in which DMS Kafka instance is created.
ResourceSpecCode string: Indicates a resource specifications identifier.
SslTwoWayEnable bool: Indicates whether to enable two-way authentication.
Status string: Indicates the status of the DMS Kafka instance.
StorageResourceId string: Indicates the storage resource ID.
StorageType string: Indicates the storage type.
Type string: Indicates the DMS Kafka instance type.
UsedStorageSpace double: Indicates the used message storage space. Unit: GB
UserId string: Indicates the ID of the user who created the DMS Kafka instance
UserName string: Indicates the name of the user who created the DMS Kafka instance

Bandwidth string
CertReplaced bool: Indicates whether the certificate can be replaced.
ConnectAddress string: Indicates the IP address of the DMS Kafka instance.
ConnectorNodeNum float64: Indicates the number of connector node.
CreatedAt string: Indicates the create time.
Dumping bool: Whether message dumping(smart connect) is enabled.
Engine string: Indicates the message engine.
Id string: The provider-assigned unique ID for this managed resource.
NodeNum float64: Indicates the node quantity.
PartitionNum float64: Indicates the number of partitions in Kafka instance.
PodConnectAddress string: Indicates the connection address on the tenant side.
Port float64: The port number.
PublicBandwidth float64: Indicates the public network access bandwidth.
PublicIpAddress string: Indicates the public IP addresses list of the instance.
Region string: The region in which DMS Kafka instance is created.
ResourceSpecCode string: Indicates a resource specifications identifier.
SslTwoWayEnable bool: Indicates whether to enable two-way authentication.
Status string: Indicates the status of the DMS Kafka instance.
StorageResourceId string: Indicates the storage resource ID.
StorageType string: Indicates the storage type.
Type string: Indicates the DMS Kafka instance type.
UsedStorageSpace float64: Indicates the used message storage space. Unit: GB
UserId string: Indicates the ID of the user who created the DMS Kafka instance
UserName string: Indicates the name of the user who created the DMS Kafka instance

bandwidth String
certReplaced Boolean: Indicates whether the certificate can be replaced.
connectAddress String: Indicates the IP address of the DMS Kafka instance.
connectorNodeNum Double: Indicates the number of connector node.
createdAt String: Indicates the create time.
dumping Boolean: Whether message dumping(smart connect) is enabled.
engine String: Indicates the message engine.
id String: The provider-assigned unique ID for this managed resource.
nodeNum Double: Indicates the node quantity.
partitionNum Double: Indicates the number of partitions in Kafka instance.
podConnectAddress String: Indicates the connection address on the tenant side.
port Double: The port number.
publicBandwidth Double: Indicates the public network access bandwidth.
publicIpAddress String: Indicates the public IP addresses list of the instance.
region String: The region in which DMS Kafka instance is created.
resourceSpecCode String: Indicates a resource specifications identifier.
sslTwoWayEnable Boolean: Indicates whether to enable two-way authentication.
status String: Indicates the status of the DMS Kafka instance.
storageResourceId String: Indicates the storage resource ID.
storageType String: Indicates the storage type.
type String: Indicates the DMS Kafka instance type.
usedStorageSpace Double: Indicates the used message storage space. Unit: GB
userId String: Indicates the ID of the user who created the DMS Kafka instance
userName String: Indicates the name of the user who created the DMS Kafka instance

bandwidth string
certReplaced boolean: Indicates whether the certificate can be replaced.
connectAddress string: Indicates the IP address of the DMS Kafka instance.
connectorNodeNum number: Indicates the number of connector node.
createdAt string: Indicates the create time.
dumping boolean: Whether message dumping(smart connect) is enabled.
engine string: Indicates the message engine.
id string: The provider-assigned unique ID for this managed resource.
nodeNum number: Indicates the node quantity.
partitionNum number: Indicates the number of partitions in Kafka instance.
podConnectAddress string: Indicates the connection address on the tenant side.
port number: The port number.
publicBandwidth number: Indicates the public network access bandwidth.
publicIpAddress string: Indicates the public IP addresses list of the instance.
region string: The region in which DMS Kafka instance is created.
resourceSpecCode string: Indicates a resource specifications identifier.
sslTwoWayEnable boolean: Indicates whether to enable two-way authentication.
status string: Indicates the status of the DMS Kafka instance.
storageResourceId string: Indicates the storage resource ID.
storageType string: Indicates the storage type.
type string: Indicates the DMS Kafka instance type.
usedStorageSpace number: Indicates the used message storage space. Unit: GB
userId string: Indicates the ID of the user who created the DMS Kafka instance
userName string: Indicates the name of the user who created the DMS Kafka instance

bandwidth str
cert_replaced bool: Indicates whether the certificate can be replaced.
connect_address str: Indicates the IP address of the DMS Kafka instance.
connector_node_num float: Indicates the number of connector node.
created_at str: Indicates the create time.
dumping bool: Whether message dumping(smart connect) is enabled.
engine str: Indicates the message engine.
id str: The provider-assigned unique ID for this managed resource.
node_num float: Indicates the node quantity.
partition_num float: Indicates the number of partitions in Kafka instance.
pod_connect_address str: Indicates the connection address on the tenant side.
port float: The port number.
public_bandwidth float: Indicates the public network access bandwidth.
public_ip_address str: Indicates the public IP addresses list of the instance.
region str: The region in which DMS Kafka instance is created.
resource_spec_code str: Indicates a resource specifications identifier.
ssl_two_way_enable bool: Indicates whether to enable two-way authentication.
status str: Indicates the status of the DMS Kafka instance.
storage_resource_id str: Indicates the storage resource ID.
storage_type str: Indicates the storage type.
type str: Indicates the DMS Kafka instance type.
used_storage_space float: Indicates the used message storage space. Unit: GB
user_id str: Indicates the ID of the user who created the DMS Kafka instance
user_name str: Indicates the name of the user who created the DMS Kafka instance

bandwidth String
certReplaced Boolean: Indicates whether the certificate can be replaced.
connectAddress String: Indicates the IP address of the DMS Kafka instance.
connectorNodeNum Number: Indicates the number of connector node.
createdAt String: Indicates the create time.
dumping Boolean: Whether message dumping(smart connect) is enabled.
engine String: Indicates the message engine.
id String: The provider-assigned unique ID for this managed resource.
nodeNum Number: Indicates the node quantity.
partitionNum Number: Indicates the number of partitions in Kafka instance.
podConnectAddress String: Indicates the connection address on the tenant side.
port Number: The port number.
publicBandwidth Number: Indicates the public network access bandwidth.
publicIpAddress String: Indicates the public IP addresses list of the instance.
region String: The region in which DMS Kafka instance is created.
resourceSpecCode String: Indicates a resource specifications identifier.
sslTwoWayEnable Boolean: Indicates whether to enable two-way authentication.
status String: Indicates the status of the DMS Kafka instance.
storageResourceId String: Indicates the storage resource ID.
storageType String: Indicates the storage type.
type String: Indicates the DMS Kafka instance type.
usedStorageSpace Number: Indicates the used message storage space. Unit: GB
userId String: Indicates the ID of the user who created the DMS Kafka instance
userName String: Indicates the name of the user who created the DMS Kafka instance

Look up Existing DmsDedicatedInstanceV2 Resource

Get an existing DmsDedicatedInstanceV2 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?: DmsDedicatedInstanceV2State, opts?: CustomResourceOptions): DmsDedicatedInstanceV2

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_user: Optional[str] = None,
        arch_type: Optional[str] = None,
        available_zones: Optional[Sequence[str]] = None,
        bandwidth: Optional[str] = None,
        broker_num: Optional[float] = None,
        cert_replaced: Optional[bool] = None,
        connect_address: Optional[str] = None,
        connector_node_num: Optional[float] = None,
        created_at: Optional[str] = None,
        cross_vpc_accesses: Optional[Sequence[DmsDedicatedInstanceV2CrossVpcAccessArgs]] = None,
        description: Optional[str] = None,
        disk_encrypted_enable: Optional[bool] = None,
        disk_encrypted_key: Optional[str] = None,
        dms_dedicated_instance_v2_id: Optional[str] = None,
        dumping: Optional[bool] = None,
        enable_publicip: Optional[bool] = None,
        enabled_mechanisms: Optional[Sequence[str]] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        flavor_id: Optional[str] = None,
        ipv6_enable: Optional[bool] = None,
        maintain_begin: Optional[str] = None,
        maintain_end: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        new_tenant_ips: Optional[Sequence[str]] = None,
        node_num: Optional[float] = None,
        partition_num: Optional[float] = None,
        password: Optional[str] = None,
        pod_connect_address: Optional[str] = None,
        port: Optional[float] = None,
        public_bandwidth: Optional[float] = None,
        public_ip_address: Optional[str] = None,
        publicip_ids: Optional[Sequence[str]] = None,
        region: Optional[str] = None,
        resource_spec_code: Optional[str] = None,
        retention_policy: Optional[str] = None,
        security_group_id: Optional[str] = None,
        security_protocol: Optional[str] = None,
        ssl_enable: Optional[bool] = None,
        ssl_two_way_enable: Optional[bool] = None,
        status: Optional[str] = None,
        storage_resource_id: Optional[str] = None,
        storage_space: Optional[float] = None,
        storage_spec_code: Optional[str] = None,
        storage_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        timeouts: Optional[DmsDedicatedInstanceV2TimeoutsArgs] = None,
        type: Optional[str] = None,
        used_storage_space: Optional[float] = None,
        user_id: Optional[str] = None,
        user_name: Optional[str] = None,
        vpc_id: Optional[str] = None) -> DmsDedicatedInstanceV2

func GetDmsDedicatedInstanceV2(ctx *Context, name string, id IDInput, state *DmsDedicatedInstanceV2State, opts ...ResourceOption) (*DmsDedicatedInstanceV2, error)

public static DmsDedicatedInstanceV2 Get(string name, Input<string> id, DmsDedicatedInstanceV2State? state, CustomResourceOptions? opts = null)

public static DmsDedicatedInstanceV2 get(String name, Output<String> id, DmsDedicatedInstanceV2State state, CustomResourceOptions options)

resources:  _:    type: opentelekomcloud:DmsDedicatedInstanceV2    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 the username of SASL_SSL user. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.

ArchType string

Specifies the CPU architecture. Valid value is X86. Changing this creates a new instance resource.

AvailableZones List<string>

Indicates the ID of an AZ. The parameter value can not be left blank or an empty array. For details, see section Querying AZ Information.

Bandwidth string

BrokerNum double

Specifies the broker numbers.

CertReplaced bool

Indicates whether the certificate can be replaced.

ConnectAddress string

Indicates the IP address of the DMS Kafka instance.

ConnectorNodeNum double

Indicates the number of connector node.

CreatedAt string

Indicates the create time.

CrossVpcAccesses List<DmsDedicatedInstanceV2CrossVpcAccess>

Specifies the cross-VPC access information. The object structure is documented below.

The cross_vpc_accesses block supports:

Description string

Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.

DiskEncryptedEnable bool

Indicates whether to enable disk encryption.

DiskEncryptedKey string

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

DmsDedicatedInstanceV2Id string

Specifies a resource ID in UUID format.

Dumping bool

Whether message dumping(smart connect) is enabled.

EnablePublicip bool

A list of IDs of the EIP bound to the instance. This parameter is mandatory if enable_publicip is set to true.

EnabledMechanisms List<string>

Specifies the authentication mechanisms to use after SASL is enabled. Value options:

PLAIN: Simple username and password verification.
SCRAM-SHA-512: User credential verification, which is more secure than PLAIN.

Defaults to [PLAIN]. Changing this creates a new instance resource.

Engine string

Indicates the message engine.

EngineVersion string

Specifies the version of the Kafka engine, such as 1.1.0, 2.3.0, 2.7 or other supported versions. Changing this creates a new instance resource.

FlavorId string

Ipv6Enable bool

Specifies whether to enable IPv6. Defaults to false. Changing this creates a new instance resource.

MaintainBegin string

MaintainEnd string

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 subnet. Changing this creates a new instance resource.

NewTenantIps List<string>

Specifies the IPv4 private IP addresses for the new brokers.

The number of specified IP addresses must be less than or equal to the number of new brokers.

NodeNum double

Indicates the node quantity.

PartitionNum double

Indicates the number of partitions in Kafka instance.

Password string

NOTE: access_user and password is mandatory and available when ssl_enable is true.

PodConnectAddress string

Indicates the connection address on the tenant side.

Port double

The port number.

PublicBandwidth double

Indicates the public network access bandwidth.

PublicIpAddress string

Indicates the public IP addresses list of the instance.

PublicipIds List<string>

Region string

The region in which DMS Kafka instance is created.

ResourceSpecCode string

Indicates a resource specifications identifier.

RetentionPolicy string

Specifies the action to be taken when the memory usage reaches the disk capacity threshold. The valid values are as follows:

time_base: Automatically delete the earliest messages.
produce_reject: Stop producing new messages.

SecurityGroupId string

Specifies the ID of a security group.

SecurityProtocol string

Specifies the protocol to use after SASL is enabled. Value options:

SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol only uses the SCRAM-SHA-512 mechanism and delivers high performance.

Defaults to SASL_SSL. Changing this creates a new instance resource.

SslEnable bool

Specifies whether the Kafka SASL_SSL is enabled. Changing this creates a new resource.

SslTwoWayEnable bool

Indicates whether to enable two-way authentication.

Status string

Indicates the status of the DMS Kafka instance.

StorageResourceId string

Indicates the storage resource ID.

StorageSpace double

Specifies the message storage capacity, the unit is GB. The storage spaces corresponding to the product IDs are as follows:

c6.2u4g.cluster (100MB bandwidth): 300 to 300,000 GB
c6.4u8g.cluster (300MB bandwidth): 300 to 600,000 GB
c6.8u16g.cluster (600MB bandwidth): 300 to 900,000 GB
c6.12u12g.cluster: 300 to 900,000 GB
c6.16u32g.cluster (1,200MB bandwidth): 300 to 900,000 GB

StorageSpecCode string

Specifies the storage I/O specification. The valid values are as follows:

dms.physical.storage.high.v2: Type of the disk that uses high I/O.
dms.physical.storage.ultra.v2: Type of the disk that uses ultra-high I/O.

StorageType string

Indicates the storage type.

Tags Dictionary<string, string>

The key/value pairs to associate with the DMS Kafka instance.

Timeouts DmsDedicatedInstanceV2Timeouts

Type string

Indicates the DMS Kafka instance type.

UsedStorageSpace double

Indicates the used message storage space. Unit: GB

UserId string

Indicates the ID of the user who created the DMS Kafka instance

UserName string

Indicates the name of the user who created the DMS Kafka instance

VpcId string

Specifies the ID of a VPC. Changing this creates a new instance resource.

AccessUser string

Specifies the username of SASL_SSL user. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.

ArchType string

Specifies the CPU architecture. Valid value is X86. Changing this creates a new instance resource.

AvailableZones []string

Indicates the ID of an AZ. The parameter value can not be left blank or an empty array. For details, see section Querying AZ Information.

Bandwidth string

BrokerNum float64

Specifies the broker numbers.

CertReplaced bool

Indicates whether the certificate can be replaced.

ConnectAddress string

Indicates the IP address of the DMS Kafka instance.

ConnectorNodeNum float64

Indicates the number of connector node.

CreatedAt string

Indicates the create time.

CrossVpcAccesses []DmsDedicatedInstanceV2CrossVpcAccessArgs

Specifies the cross-VPC access information. The object structure is documented below.

The cross_vpc_accesses block supports:

Description string

Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.

DiskEncryptedEnable bool

Indicates whether to enable disk encryption.

DiskEncryptedKey string

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

DmsDedicatedInstanceV2Id string

Specifies a resource ID in UUID format.

Dumping bool

Whether message dumping(smart connect) is enabled.

EnablePublicip bool

A list of IDs of the EIP bound to the instance. This parameter is mandatory if enable_publicip is set to true.

EnabledMechanisms []string

Specifies the authentication mechanisms to use after SASL is enabled. Value options:

PLAIN: Simple username and password verification.
SCRAM-SHA-512: User credential verification, which is more secure than PLAIN.

Defaults to [PLAIN]. Changing this creates a new instance resource.

Engine string

Indicates the message engine.

EngineVersion string

Specifies the version of the Kafka engine, such as 1.1.0, 2.3.0, 2.7 or other supported versions. Changing this creates a new instance resource.

FlavorId string

Ipv6Enable bool

Specifies whether to enable IPv6. Defaults to false. Changing this creates a new instance resource.

MaintainBegin string

MaintainEnd string

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 subnet. Changing this creates a new instance resource.

NewTenantIps []string

Specifies the IPv4 private IP addresses for the new brokers.

The number of specified IP addresses must be less than or equal to the number of new brokers.

NodeNum float64

Indicates the node quantity.

PartitionNum float64

Indicates the number of partitions in Kafka instance.

Password string

NOTE: access_user and password is mandatory and available when ssl_enable is true.

PodConnectAddress string

Indicates the connection address on the tenant side.

Port float64

The port number.

PublicBandwidth float64

Indicates the public network access bandwidth.

PublicIpAddress string

Indicates the public IP addresses list of the instance.

PublicipIds []string

Region string

The region in which DMS Kafka instance is created.

ResourceSpecCode string

Indicates a resource specifications identifier.

RetentionPolicy string

Specifies the action to be taken when the memory usage reaches the disk capacity threshold. The valid values are as follows:

time_base: Automatically delete the earliest messages.
produce_reject: Stop producing new messages.

SecurityGroupId string

Specifies the ID of a security group.

SecurityProtocol string

Specifies the protocol to use after SASL is enabled. Value options:

SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol only uses the SCRAM-SHA-512 mechanism and delivers high performance.

Defaults to SASL_SSL. Changing this creates a new instance resource.

SslEnable bool

Specifies whether the Kafka SASL_SSL is enabled. Changing this creates a new resource.

SslTwoWayEnable bool

Indicates whether to enable two-way authentication.

Status string

Indicates the status of the DMS Kafka instance.

StorageResourceId string

Indicates the storage resource ID.

StorageSpace float64

Specifies the message storage capacity, the unit is GB. The storage spaces corresponding to the product IDs are as follows:

c6.2u4g.cluster (100MB bandwidth): 300 to 300,000 GB
c6.4u8g.cluster (300MB bandwidth): 300 to 600,000 GB
c6.8u16g.cluster (600MB bandwidth): 300 to 900,000 GB
c6.12u12g.cluster: 300 to 900,000 GB
c6.16u32g.cluster (1,200MB bandwidth): 300 to 900,000 GB

StorageSpecCode string

Specifies the storage I/O specification. The valid values are as follows:

dms.physical.storage.high.v2: Type of the disk that uses high I/O.
dms.physical.storage.ultra.v2: Type of the disk that uses ultra-high I/O.

StorageType string

Indicates the storage type.

Tags map[string]string

The key/value pairs to associate with the DMS Kafka instance.

Timeouts DmsDedicatedInstanceV2TimeoutsArgs

Type string

Indicates the DMS Kafka instance type.

UsedStorageSpace float64

Indicates the used message storage space. Unit: GB

UserId string

Indicates the ID of the user who created the DMS Kafka instance

UserName string

Indicates the name of the user who created the DMS Kafka instance

VpcId string

Specifies the ID of a VPC. Changing this creates a new instance resource.

accessUser String

Specifies the username of SASL_SSL user. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.

archType String

Specifies the CPU architecture. Valid value is X86. Changing this creates a new instance resource.

availableZones List<String>

Indicates the ID of an AZ. The parameter value can not be left blank or an empty array. For details, see section Querying AZ Information.

bandwidth String

brokerNum Double

Specifies the broker numbers.

certReplaced Boolean

Indicates whether the certificate can be replaced.

connectAddress String

Indicates the IP address of the DMS Kafka instance.

connectorNodeNum Double

Indicates the number of connector node.

createdAt String

Indicates the create time.

crossVpcAccesses List<DmsDedicatedInstanceV2CrossVpcAccess>

Specifies the cross-VPC access information. The object structure is documented below.

The cross_vpc_accesses block supports:

description String

Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.

diskEncryptedEnable Boolean

Indicates whether to enable disk encryption.

diskEncryptedKey String

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

dmsDedicatedInstanceV2Id String

Specifies a resource ID in UUID format.

dumping Boolean

Whether message dumping(smart connect) is enabled.

enablePublicip Boolean

A list of IDs of the EIP bound to the instance. This parameter is mandatory if enable_publicip is set to true.

enabledMechanisms List<String>

Specifies the authentication mechanisms to use after SASL is enabled. Value options:

PLAIN: Simple username and password verification.
SCRAM-SHA-512: User credential verification, which is more secure than PLAIN.

Defaults to [PLAIN]. Changing this creates a new instance resource.

engine String

Indicates the message engine.

engineVersion String

Specifies the version of the Kafka engine, such as 1.1.0, 2.3.0, 2.7 or other supported versions. Changing this creates a new instance resource.

flavorId String

ipv6Enable Boolean

Specifies whether to enable IPv6. Defaults to false. Changing this creates a new instance resource.

maintainBegin String

maintainEnd String

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 subnet. Changing this creates a new instance resource.

newTenantIps List<String>

Specifies the IPv4 private IP addresses for the new brokers.

The number of specified IP addresses must be less than or equal to the number of new brokers.

nodeNum Double

Indicates the node quantity.

partitionNum Double

Indicates the number of partitions in Kafka instance.

password String

NOTE: access_user and password is mandatory and available when ssl_enable is true.

podConnectAddress String

Indicates the connection address on the tenant side.

port Double

The port number.

publicBandwidth Double

Indicates the public network access bandwidth.

publicIpAddress String

Indicates the public IP addresses list of the instance.

publicipIds List<String>

region String

The region in which DMS Kafka instance is created.

resourceSpecCode String

Indicates a resource specifications identifier.

retentionPolicy String

Specifies the action to be taken when the memory usage reaches the disk capacity threshold. The valid values are as follows:

time_base: Automatically delete the earliest messages.
produce_reject: Stop producing new messages.

securityGroupId String

Specifies the ID of a security group.

securityProtocol String

Specifies the protocol to use after SASL is enabled. Value options:

SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol only uses the SCRAM-SHA-512 mechanism and delivers high performance.

Defaults to SASL_SSL. Changing this creates a new instance resource.

sslEnable Boolean

Specifies whether the Kafka SASL_SSL is enabled. Changing this creates a new resource.

sslTwoWayEnable Boolean

Indicates whether to enable two-way authentication.

status String

Indicates the status of the DMS Kafka instance.

storageResourceId String

Indicates the storage resource ID.

storageSpace Double

Specifies the message storage capacity, the unit is GB. The storage spaces corresponding to the product IDs are as follows:

c6.2u4g.cluster (100MB bandwidth): 300 to 300,000 GB
c6.4u8g.cluster (300MB bandwidth): 300 to 600,000 GB
c6.8u16g.cluster (600MB bandwidth): 300 to 900,000 GB
c6.12u12g.cluster: 300 to 900,000 GB
c6.16u32g.cluster (1,200MB bandwidth): 300 to 900,000 GB

storageSpecCode String

Specifies the storage I/O specification. The valid values are as follows:

dms.physical.storage.high.v2: Type of the disk that uses high I/O.
dms.physical.storage.ultra.v2: Type of the disk that uses ultra-high I/O.

storageType String

Indicates the storage type.

tags Map<String,String>

The key/value pairs to associate with the DMS Kafka instance.

timeouts DmsDedicatedInstanceV2Timeouts

type String

Indicates the DMS Kafka instance type.

usedStorageSpace Double

Indicates the used message storage space. Unit: GB

userId String

Indicates the ID of the user who created the DMS Kafka instance

userName String

Indicates the name of the user who created the DMS Kafka instance

vpcId String

Specifies the ID of a VPC. Changing this creates a new instance resource.

accessUser string

Specifies the username of SASL_SSL user. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.

archType string

Specifies the CPU architecture. Valid value is X86. Changing this creates a new instance resource.

availableZones string[]

Indicates the ID of an AZ. The parameter value can not be left blank or an empty array. For details, see section Querying AZ Information.

bandwidth string

brokerNum number

Specifies the broker numbers.

certReplaced boolean

Indicates whether the certificate can be replaced.

connectAddress string

Indicates the IP address of the DMS Kafka instance.

connectorNodeNum number

Indicates the number of connector node.

createdAt string

Indicates the create time.

crossVpcAccesses DmsDedicatedInstanceV2CrossVpcAccess[]

Specifies the cross-VPC access information. The object structure is documented below.

The cross_vpc_accesses block supports:

description string

Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.

diskEncryptedEnable boolean

Indicates whether to enable disk encryption.

diskEncryptedKey string

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

dmsDedicatedInstanceV2Id string

Specifies a resource ID in UUID format.

dumping boolean

Whether message dumping(smart connect) is enabled.

enablePublicip boolean

A list of IDs of the EIP bound to the instance. This parameter is mandatory if enable_publicip is set to true.

enabledMechanisms string[]

Specifies the authentication mechanisms to use after SASL is enabled. Value options:

PLAIN: Simple username and password verification.
SCRAM-SHA-512: User credential verification, which is more secure than PLAIN.

Defaults to [PLAIN]. Changing this creates a new instance resource.

engine string

Indicates the message engine.

engineVersion string

Specifies the version of the Kafka engine, such as 1.1.0, 2.3.0, 2.7 or other supported versions. Changing this creates a new instance resource.

flavorId string

ipv6Enable boolean

Specifies whether to enable IPv6. Defaults to false. Changing this creates a new instance resource.

maintainBegin string

maintainEnd string

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 subnet. Changing this creates a new instance resource.

newTenantIps string[]

Specifies the IPv4 private IP addresses for the new brokers.

The number of specified IP addresses must be less than or equal to the number of new brokers.

nodeNum number

Indicates the node quantity.

partitionNum number

Indicates the number of partitions in Kafka instance.

password string

NOTE: access_user and password is mandatory and available when ssl_enable is true.

podConnectAddress string

Indicates the connection address on the tenant side.

port number

The port number.

publicBandwidth number

Indicates the public network access bandwidth.

publicIpAddress string

Indicates the public IP addresses list of the instance.

publicipIds string[]

region string

The region in which DMS Kafka instance is created.

resourceSpecCode string

Indicates a resource specifications identifier.

retentionPolicy string

Specifies the action to be taken when the memory usage reaches the disk capacity threshold. The valid values are as follows:

time_base: Automatically delete the earliest messages.
produce_reject: Stop producing new messages.

securityGroupId string

Specifies the ID of a security group.

securityProtocol string

Specifies the protocol to use after SASL is enabled. Value options:

SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol only uses the SCRAM-SHA-512 mechanism and delivers high performance.

Defaults to SASL_SSL. Changing this creates a new instance resource.

sslEnable boolean

Specifies whether the Kafka SASL_SSL is enabled. Changing this creates a new resource.

sslTwoWayEnable boolean

Indicates whether to enable two-way authentication.

status string

Indicates the status of the DMS Kafka instance.

storageResourceId string

Indicates the storage resource ID.

storageSpace number

Specifies the message storage capacity, the unit is GB. The storage spaces corresponding to the product IDs are as follows:

c6.2u4g.cluster (100MB bandwidth): 300 to 300,000 GB
c6.4u8g.cluster (300MB bandwidth): 300 to 600,000 GB
c6.8u16g.cluster (600MB bandwidth): 300 to 900,000 GB
c6.12u12g.cluster: 300 to 900,000 GB
c6.16u32g.cluster (1,200MB bandwidth): 300 to 900,000 GB

storageSpecCode string

Specifies the storage I/O specification. The valid values are as follows:

dms.physical.storage.high.v2: Type of the disk that uses high I/O.
dms.physical.storage.ultra.v2: Type of the disk that uses ultra-high I/O.

storageType string

Indicates the storage type.

tags {[key: string]: string}

The key/value pairs to associate with the DMS Kafka instance.

timeouts DmsDedicatedInstanceV2Timeouts

type string

Indicates the DMS Kafka instance type.

usedStorageSpace number

Indicates the used message storage space. Unit: GB

userId string

Indicates the ID of the user who created the DMS Kafka instance

userName string

Indicates the name of the user who created the DMS Kafka instance

vpcId string

Specifies the ID of a VPC. Changing this creates a new instance resource.

access_user str

Specifies the username of SASL_SSL user. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.

arch_type str

Specifies the CPU architecture. Valid value is X86. Changing this creates a new instance resource.

available_zones Sequence[str]

Indicates the ID of an AZ. The parameter value can not be left blank or an empty array. For details, see section Querying AZ Information.

bandwidth str

broker_num float

Specifies the broker numbers.

cert_replaced bool

Indicates whether the certificate can be replaced.

connect_address str

Indicates the IP address of the DMS Kafka instance.

connector_node_num float

Indicates the number of connector node.

created_at str

Indicates the create time.

cross_vpc_accesses Sequence[DmsDedicatedInstanceV2CrossVpcAccessArgs]

Specifies the cross-VPC access information. The object structure is documented below.

The cross_vpc_accesses block supports:

description str

Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.

disk_encrypted_enable bool

Indicates whether to enable disk encryption.

disk_encrypted_key str

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

dms_dedicated_instance_v2_id str

Specifies a resource ID in UUID format.

dumping bool

Whether message dumping(smart connect) is enabled.

enable_publicip bool

A list of IDs of the EIP bound to the instance. This parameter is mandatory if enable_publicip is set to true.

enabled_mechanisms Sequence[str]

Specifies the authentication mechanisms to use after SASL is enabled. Value options:

PLAIN: Simple username and password verification.
SCRAM-SHA-512: User credential verification, which is more secure than PLAIN.

Defaults to [PLAIN]. Changing this creates a new instance resource.

engine str

Indicates the message engine.

engine_version str

Specifies the version of the Kafka engine, such as 1.1.0, 2.3.0, 2.7 or other supported versions. Changing this creates a new instance resource.

flavor_id str

ipv6_enable bool

Specifies whether to enable IPv6. Defaults to false. Changing this creates a new instance resource.

maintain_begin str

maintain_end str

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 subnet. Changing this creates a new instance resource.

new_tenant_ips Sequence[str]

Specifies the IPv4 private IP addresses for the new brokers.

The number of specified IP addresses must be less than or equal to the number of new brokers.

node_num float

Indicates the node quantity.

partition_num float

Indicates the number of partitions in Kafka instance.

password str

NOTE: access_user and password is mandatory and available when ssl_enable is true.

pod_connect_address str

Indicates the connection address on the tenant side.

port float

The port number.

public_bandwidth float

Indicates the public network access bandwidth.

public_ip_address str

Indicates the public IP addresses list of the instance.

publicip_ids Sequence[str]

region str

The region in which DMS Kafka instance is created.

resource_spec_code str

Indicates a resource specifications identifier.

retention_policy str

Specifies the action to be taken when the memory usage reaches the disk capacity threshold. The valid values are as follows:

time_base: Automatically delete the earliest messages.
produce_reject: Stop producing new messages.

security_group_id str

Specifies the ID of a security group.

security_protocol str

Specifies the protocol to use after SASL is enabled. Value options:

SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol only uses the SCRAM-SHA-512 mechanism and delivers high performance.

Defaults to SASL_SSL. Changing this creates a new instance resource.

ssl_enable bool

Specifies whether the Kafka SASL_SSL is enabled. Changing this creates a new resource.

ssl_two_way_enable bool

Indicates whether to enable two-way authentication.

status str

Indicates the status of the DMS Kafka instance.

storage_resource_id str

Indicates the storage resource ID.

storage_space float

Specifies the message storage capacity, the unit is GB. The storage spaces corresponding to the product IDs are as follows:

c6.2u4g.cluster (100MB bandwidth): 300 to 300,000 GB
c6.4u8g.cluster (300MB bandwidth): 300 to 600,000 GB
c6.8u16g.cluster (600MB bandwidth): 300 to 900,000 GB
c6.12u12g.cluster: 300 to 900,000 GB
c6.16u32g.cluster (1,200MB bandwidth): 300 to 900,000 GB

storage_spec_code str

Specifies the storage I/O specification. The valid values are as follows:

dms.physical.storage.high.v2: Type of the disk that uses high I/O.
dms.physical.storage.ultra.v2: Type of the disk that uses ultra-high I/O.

storage_type str

Indicates the storage type.

tags Mapping[str, str]

The key/value pairs to associate with the DMS Kafka instance.

timeouts DmsDedicatedInstanceV2TimeoutsArgs

type str

Indicates the DMS Kafka instance type.

used_storage_space float

Indicates the used message storage space. Unit: GB

user_id str

Indicates the ID of the user who created the DMS Kafka instance

user_name str

Indicates the name of the user who created the DMS Kafka instance

vpc_id str

Specifies the ID of a VPC. Changing this creates a new instance resource.

accessUser String

Specifies the username of SASL_SSL user. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). Changing this creates a new instance resource.

archType String

Specifies the CPU architecture. Valid value is X86. Changing this creates a new instance resource.

availableZones List<String>

Indicates the ID of an AZ. The parameter value can not be left blank or an empty array. For details, see section Querying AZ Information.

bandwidth String

brokerNum Number

Specifies the broker numbers.

certReplaced Boolean

Indicates whether the certificate can be replaced.

connectAddress String

Indicates the IP address of the DMS Kafka instance.

connectorNodeNum Number

Indicates the number of connector node.

createdAt String

Indicates the create time.

crossVpcAccesses List<Property Map>

Specifies the cross-VPC access information. The object structure is documented below.

The cross_vpc_accesses block supports:

description String

Specifies the description of the DMS Kafka instance. It is a character string containing not more than 1,024 characters.

diskEncryptedEnable Boolean

Indicates whether to enable disk encryption.

diskEncryptedKey String

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

dmsDedicatedInstanceV2Id String

Specifies a resource ID in UUID format.

dumping Boolean

Whether message dumping(smart connect) is enabled.

enablePublicip Boolean

A list of IDs of the EIP bound to the instance. This parameter is mandatory if enable_publicip is set to true.

enabledMechanisms List<String>

Specifies the authentication mechanisms to use after SASL is enabled. Value options:

PLAIN: Simple username and password verification.
SCRAM-SHA-512: User credential verification, which is more secure than PLAIN.

Defaults to [PLAIN]. Changing this creates a new instance resource.

engine String

Indicates the message engine.

engineVersion String

Specifies the version of the Kafka engine, such as 1.1.0, 2.3.0, 2.7 or other supported versions. Changing this creates a new instance resource.

flavorId String

ipv6Enable Boolean

Specifies whether to enable IPv6. Defaults to false. Changing this creates a new instance resource.

maintainBegin String

maintainEnd String

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 subnet. Changing this creates a new instance resource.

newTenantIps List<String>

Specifies the IPv4 private IP addresses for the new brokers.

The number of specified IP addresses must be less than or equal to the number of new brokers.

nodeNum Number

Indicates the node quantity.

partitionNum Number

Indicates the number of partitions in Kafka instance.

password String

NOTE: access_user and password is mandatory and available when ssl_enable is true.

podConnectAddress String

Indicates the connection address on the tenant side.

port Number

The port number.

publicBandwidth Number

Indicates the public network access bandwidth.

publicIpAddress String

Indicates the public IP addresses list of the instance.

publicipIds List<String>

region String

The region in which DMS Kafka instance is created.

resourceSpecCode String

Indicates a resource specifications identifier.

retentionPolicy String

Specifies the action to be taken when the memory usage reaches the disk capacity threshold. The valid values are as follows:

time_base: Automatically delete the earliest messages.
produce_reject: Stop producing new messages.

securityGroupId String

Specifies the ID of a security group.

securityProtocol String

Specifies the protocol to use after SASL is enabled. Value options:

SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol only uses the SCRAM-SHA-512 mechanism and delivers high performance.

Defaults to SASL_SSL. Changing this creates a new instance resource.

sslEnable Boolean

Specifies whether the Kafka SASL_SSL is enabled. Changing this creates a new resource.

sslTwoWayEnable Boolean

Indicates whether to enable two-way authentication.

status String

Indicates the status of the DMS Kafka instance.

storageResourceId String

Indicates the storage resource ID.

storageSpace Number

Specifies the message storage capacity, the unit is GB. The storage spaces corresponding to the product IDs are as follows:

c6.2u4g.cluster (100MB bandwidth): 300 to 300,000 GB
c6.4u8g.cluster (300MB bandwidth): 300 to 600,000 GB
c6.8u16g.cluster (600MB bandwidth): 300 to 900,000 GB
c6.12u12g.cluster: 300 to 900,000 GB
c6.16u32g.cluster (1,200MB bandwidth): 300 to 900,000 GB

storageSpecCode String

Specifies the storage I/O specification. The valid values are as follows:

dms.physical.storage.high.v2: Type of the disk that uses high I/O.
dms.physical.storage.ultra.v2: Type of the disk that uses ultra-high I/O.

storageType String

Indicates the storage type.

tags Map<String>

The key/value pairs to associate with the DMS Kafka instance.

timeouts Property Map

type String

Indicates the DMS Kafka instance type.

usedStorageSpace Number

Indicates the used message storage space. Unit: GB

userId String

Indicates the ID of the user who created the DMS Kafka instance

userName String

Indicates the name of the user who created the DMS Kafka instance

vpcId String

Specifies the ID of a VPC. Changing this creates a new instance resource.

Supporting Types

DmsDedicatedInstanceV2CrossVpcAccess, DmsDedicatedInstanceV2CrossVpcAccessArgs

AdvertisedIp string: The advertised IP Address or domain name.
ListenerIp string: The listener IP address.
Port double: The port number.
PortId string: The port ID associated with the address.

AdvertisedIp string: The advertised IP Address or domain name.
ListenerIp string: The listener IP address.
Port float64: The port number.
PortId string: The port ID associated with the address.

advertisedIp String: The advertised IP Address or domain name.
listenerIp String: The listener IP address.
port Double: The port number.
portId String: The port ID associated with the address.

advertisedIp string: The advertised IP Address or domain name.
listenerIp string: The listener IP address.
port number: The port number.
portId string: The port ID associated with the address.

advertised_ip str: The advertised IP Address or domain name.
listener_ip str: The listener IP address.
port float: The port number.
port_id str: The port ID associated with the address.

advertisedIp String: The advertised IP Address or domain name.
listenerIp String: The listener IP address.
port Number: The port number.
portId String: The port ID associated with the address.

DmsDedicatedInstanceV2Timeouts, DmsDedicatedInstanceV2TimeoutsArgs

Create string
Delete string
Update string

Create string
Delete string
Update string

create String
delete String
update String

create string
delete string
update string

create str
delete str
update str

create String
delete String
update String

Import

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

$ pulumi import opentelekomcloud:index/dmsDedicatedInstanceV2:DmsDedicatedInstanceV2  opentelekomcloud_dms_dedicated_instance_v2.instance_1 8d3c7938-dc47-4937-a30f-c80de381c5e3

Note that the imported state may not be identical to your resource definition, due to some attributes missing from the

API response, security or some other reason. The missing attributes include:

password, manager_password, public_ip_ids, security_protocol, enabled_mechanisms and arch_type.

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 “opentelekomcloud_dms_dedicated_instance_v2” “instance_1” {

lifecycle {

ignore_changes = [

  "password",

  "used_storage_space",

  "cross_vpc_accesses",

  "publicip_id",

]

}

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

Package Details

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

opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.DmsDedicatedInstanceV2

On this page

On this page

Example Usage

Create DmsDedicatedInstanceV2 Resource

Constructor syntax

Parameters

Constructor example

DmsDedicatedInstanceV2 Resource Properties

Inputs

Outputs

Look up Existing DmsDedicatedInstanceV2 Resource

Supporting Types

DmsDedicatedInstanceV2CrossVpcAccess, DmsDedicatedInstanceV2CrossVpcAccessArgs

DmsDedicatedInstanceV2Timeouts, DmsDedicatedInstanceV2TimeoutsArgs

Import

Package Details

On this page

On this page