opentelekomcloud 1.36.38, May 9 25

opentelekomcloud 1.36.38 published on Friday, May 9, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.DmsInstanceV1

Explore with Pulumi AI

opentelekomcloud 1.36.38 published on Friday, May 9, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

Example Usage

Automatically detect the correct network

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

const secgroup1 = new opentelekomcloud.NetworkingSecgroupV2("secgroup1", {description: "secgroup_1"});
const az1 = opentelekomcloud.getDmsAzV1({
    name: "eu-de-01",
});
const product1 = opentelekomcloud.getDmsProductV1({
    engine: "kafka",
    version: "2.3.0",
    instanceType: "cluster",
    partitionNum: "300",
    storage: "600",
    storageSpecCode: "dms.physical.storage.high",
});
const instance1 = new opentelekomcloud.DmsInstanceV1("instance1", {
    engine: "kafka",
    productId: product1.then(product1 => product1.id),
    engineVersion: product1.then(product1 => product1.version),
    specification: product1.then(product1 => product1.bandwidth),
    partitionNum: product1.then(product1 => product1.partitionNum),
    storageSpecCode: product1.then(product1 => product1.storageSpecCode),
    storageSpace: product1.then(product1 => product1.storage),
    availableZones: [az1.then(az1 => az1.id)],
    securityGroupId: secgroup1.networkingSecgroupV2Id,
    vpcId: _var.vpc_id,
    subnetId: _var.subnet_id,
    accessUser: _var.access_user,
    password: _var.password,
});

import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

secgroup1 = opentelekomcloud.NetworkingSecgroupV2("secgroup1", description="secgroup_1")
az1 = opentelekomcloud.get_dms_az_v1(name="eu-de-01")
product1 = opentelekomcloud.get_dms_product_v1(engine="kafka",
    version="2.3.0",
    instance_type="cluster",
    partition_num="300",
    storage="600",
    storage_spec_code="dms.physical.storage.high")
instance1 = opentelekomcloud.DmsInstanceV1("instance1",
    engine="kafka",
    product_id=product1.id,
    engine_version=product1.version,
    specification=product1.bandwidth,
    partition_num=product1.partition_num,
    storage_spec_code=product1.storage_spec_code,
    storage_space=product1.storage,
    available_zones=[az1.id],
    security_group_id=secgroup1.networking_secgroup_v2_id,
    vpc_id=var["vpc_id"],
    subnet_id=var["subnet_id"],
    access_user=var["access_user"],
    password=var["password"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		secgroup1, err := opentelekomcloud.NewNetworkingSecgroupV2(ctx, "secgroup1", &opentelekomcloud.NetworkingSecgroupV2Args{
			Description: pulumi.String("secgroup_1"),
		})
		if err != nil {
			return err
		}
		az1, err := opentelekomcloud.GetDmsAzV1(ctx, &opentelekomcloud.GetDmsAzV1Args{
			Name: pulumi.StringRef("eu-de-01"),
		}, nil)
		if err != nil {
			return err
		}
		product1, err := opentelekomcloud.GetDmsProductV1(ctx, &opentelekomcloud.GetDmsProductV1Args{
			Engine:          "kafka",
			Version:         pulumi.StringRef("2.3.0"),
			InstanceType:    "cluster",
			PartitionNum:    pulumi.StringRef("300"),
			Storage:         pulumi.StringRef("600"),
			StorageSpecCode: pulumi.StringRef("dms.physical.storage.high"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = opentelekomcloud.NewDmsInstanceV1(ctx, "instance1", &opentelekomcloud.DmsInstanceV1Args{
			Engine:          pulumi.String("kafka"),
			ProductId:       pulumi.String(product1.Id),
			EngineVersion:   pulumi.String(product1.Version),
			Specification:   pulumi.String(product1.Bandwidth),
			PartitionNum:    pulumi.String(product1.PartitionNum),
			StorageSpecCode: pulumi.String(product1.StorageSpecCode),
			StorageSpace:    pulumi.String(product1.Storage),
			AvailableZones: pulumi.StringArray{
				pulumi.String(az1.Id),
			},
			SecurityGroupId: secgroup1.NetworkingSecgroupV2Id,
			VpcId:           pulumi.Any(_var.Vpc_id),
			SubnetId:        pulumi.Any(_var.Subnet_id),
			AccessUser:      pulumi.Any(_var.Access_user),
			Password:        pulumi.Any(_var.Password),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var secgroup1 = new Opentelekomcloud.NetworkingSecgroupV2("secgroup1", new()
    {
        Description = "secgroup_1",
    });

    var az1 = Opentelekomcloud.GetDmsAzV1.Invoke(new()
    {
        Name = "eu-de-01",
    });

    var product1 = Opentelekomcloud.GetDmsProductV1.Invoke(new()
    {
        Engine = "kafka",
        Version = "2.3.0",
        InstanceType = "cluster",
        PartitionNum = "300",
        Storage = "600",
        StorageSpecCode = "dms.physical.storage.high",
    });

    var instance1 = new Opentelekomcloud.DmsInstanceV1("instance1", new()
    {
        Engine = "kafka",
        ProductId = product1.Apply(getDmsProductV1Result => getDmsProductV1Result.Id),
        EngineVersion = product1.Apply(getDmsProductV1Result => getDmsProductV1Result.Version),
        Specification = product1.Apply(getDmsProductV1Result => getDmsProductV1Result.Bandwidth),
        PartitionNum = product1.Apply(getDmsProductV1Result => getDmsProductV1Result.PartitionNum),
        StorageSpecCode = product1.Apply(getDmsProductV1Result => getDmsProductV1Result.StorageSpecCode),
        StorageSpace = product1.Apply(getDmsProductV1Result => getDmsProductV1Result.Storage),
        AvailableZones = new[]
        {
            az1.Apply(getDmsAzV1Result => getDmsAzV1Result.Id),
        },
        SecurityGroupId = secgroup1.NetworkingSecgroupV2Id,
        VpcId = @var.Vpc_id,
        SubnetId = @var.Subnet_id,
        AccessUser = @var.Access_user,
        Password = @var.Password,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.NetworkingSecgroupV2;
import com.pulumi.opentelekomcloud.NetworkingSecgroupV2Args;
import com.pulumi.opentelekomcloud.OpentelekomcloudFunctions;
import com.pulumi.opentelekomcloud.inputs.GetDmsAzV1Args;
import com.pulumi.opentelekomcloud.inputs.GetDmsProductV1Args;
import com.pulumi.opentelekomcloud.DmsInstanceV1;
import com.pulumi.opentelekomcloud.DmsInstanceV1Args;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var secgroup1 = new NetworkingSecgroupV2("secgroup1", NetworkingSecgroupV2Args.builder()
            .description("secgroup_1")
            .build());

        final var az1 = OpentelekomcloudFunctions.getDmsAzV1(GetDmsAzV1Args.builder()
            .name("eu-de-01")
            .build());

        final var product1 = OpentelekomcloudFunctions.getDmsProductV1(GetDmsProductV1Args.builder()
            .engine("kafka")
            .version("2.3.0")
            .instanceType("cluster")
            .partitionNum(300)
            .storage(600)
            .storageSpecCode("dms.physical.storage.high")
            .build());

        var instance1 = new DmsInstanceV1("instance1", DmsInstanceV1Args.builder()
            .engine("kafka")
            .productId(product1.applyValue(getDmsProductV1Result -> getDmsProductV1Result.id()))
            .engineVersion(product1.applyValue(getDmsProductV1Result -> getDmsProductV1Result.version()))
            .specification(product1.applyValue(getDmsProductV1Result -> getDmsProductV1Result.bandwidth()))
            .partitionNum(product1.applyValue(getDmsProductV1Result -> getDmsProductV1Result.partitionNum()))
            .storageSpecCode(product1.applyValue(getDmsProductV1Result -> getDmsProductV1Result.storageSpecCode()))
            .storageSpace(product1.applyValue(getDmsProductV1Result -> getDmsProductV1Result.storage()))
            .availableZones(az1.applyValue(getDmsAzV1Result -> getDmsAzV1Result.id()))
            .securityGroupId(secgroup1.networkingSecgroupV2Id())
            .vpcId(var_.vpc_id())
            .subnetId(var_.subnet_id())
            .accessUser(var_.access_user())
            .password(var_.password())
            .build());

    }
}

resources:
  secgroup1:
    type: opentelekomcloud:NetworkingSecgroupV2
    properties:
      description: secgroup_1
  instance1:
    type: opentelekomcloud:DmsInstanceV1
    properties:
      engine: kafka
      productId: ${product1.id}
      engineVersion: ${product1.version}
      specification: ${product1.bandwidth}
      partitionNum: ${product1.partitionNum}
      storageSpecCode: ${product1.storageSpecCode}
      storageSpace: ${product1.storage}
      availableZones:
        - ${az1.id}
      securityGroupId: ${secgroup1.networkingSecgroupV2Id}
      vpcId: ${var.vpc_id}
      subnetId: ${var.subnet_id}
      accessUser: ${var.access_user}
      password: ${var.password}
variables:
  az1:
    fn::invoke:
      function: opentelekomcloud:getDmsAzV1
      arguments:
        name: eu-de-01
  product1:
    fn::invoke:
      function: opentelekomcloud:getDmsProductV1
      arguments:
        engine: kafka
        version: 2.3.0
        instanceType: cluster
        partitionNum: 300
        storage: 600
        storageSpecCode: dms.physical.storage.high

Create DmsInstanceV1 Resource

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

Constructor syntax

new DmsInstanceV1(name: string, args: DmsInstanceV1Args, opts?: CustomResourceOptions);

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

@overload
def DmsInstanceV1(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  product_id: Optional[str] = None,
                  available_zones: Optional[Sequence[str]] = None,
                  vpc_id: Optional[str] = None,
                  subnet_id: Optional[str] = None,
                  engine: Optional[str] = None,
                  engine_version: Optional[str] = None,
                  storage_spec_code: Optional[str] = None,
                  storage_space: Optional[float] = None,
                  security_group_id: Optional[str] = None,
                  name: Optional[str] = None,
                  password: Optional[str] = None,
                  partition_num: Optional[float] = None,
                  retention_policy: Optional[str] = None,
                  access_user: Optional[str] = None,
                  specification: Optional[str] = None,
                  maintain_end: Optional[str] = None,
                  maintain_begin: Optional[str] = None,
                  dms_instance_v1_id: Optional[str] = None,
                  description: Optional[str] = None)

func NewDmsInstanceV1(ctx *Context, name string, args DmsInstanceV1Args, opts ...ResourceOption) (*DmsInstanceV1, error)

public DmsInstanceV1(string name, DmsInstanceV1Args args, CustomResourceOptions? opts = null)

public DmsInstanceV1(String name, DmsInstanceV1Args args)
public DmsInstanceV1(String name, DmsInstanceV1Args args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args DmsInstanceV1Args: 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 dmsInstanceV1Resource = new Opentelekomcloud.DmsInstanceV1("dmsInstanceV1Resource", new()
{
    ProductId = "string",
    AvailableZones = new[]
    {
        "string",
    },
    VpcId = "string",
    SubnetId = "string",
    Engine = "string",
    EngineVersion = "string",
    StorageSpecCode = "string",
    StorageSpace = 0,
    SecurityGroupId = "string",
    Name = "string",
    Password = "string",
    PartitionNum = 0,
    RetentionPolicy = "string",
    AccessUser = "string",
    Specification = "string",
    MaintainEnd = "string",
    MaintainBegin = "string",
    DmsInstanceV1Id = "string",
    Description = "string",
});

example, err := opentelekomcloud.NewDmsInstanceV1(ctx, "dmsInstanceV1Resource", &opentelekomcloud.DmsInstanceV1Args{
	ProductId: pulumi.String("string"),
	AvailableZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	VpcId:           pulumi.String("string"),
	SubnetId:        pulumi.String("string"),
	Engine:          pulumi.String("string"),
	EngineVersion:   pulumi.String("string"),
	StorageSpecCode: pulumi.String("string"),
	StorageSpace:    pulumi.Float64(0),
	SecurityGroupId: pulumi.String("string"),
	Name:            pulumi.String("string"),
	Password:        pulumi.String("string"),
	PartitionNum:    pulumi.Float64(0),
	RetentionPolicy: pulumi.String("string"),
	AccessUser:      pulumi.String("string"),
	Specification:   pulumi.String("string"),
	MaintainEnd:     pulumi.String("string"),
	MaintainBegin:   pulumi.String("string"),
	DmsInstanceV1Id: pulumi.String("string"),
	Description:     pulumi.String("string"),
})

var dmsInstanceV1Resource = new DmsInstanceV1("dmsInstanceV1Resource", DmsInstanceV1Args.builder()
    .productId("string")
    .availableZones("string")
    .vpcId("string")
    .subnetId("string")
    .engine("string")
    .engineVersion("string")
    .storageSpecCode("string")
    .storageSpace(0.0)
    .securityGroupId("string")
    .name("string")
    .password("string")
    .partitionNum(0.0)
    .retentionPolicy("string")
    .accessUser("string")
    .specification("string")
    .maintainEnd("string")
    .maintainBegin("string")
    .dmsInstanceV1Id("string")
    .description("string")
    .build());

dms_instance_v1_resource = opentelekomcloud.DmsInstanceV1("dmsInstanceV1Resource",
    product_id="string",
    available_zones=["string"],
    vpc_id="string",
    subnet_id="string",
    engine="string",
    engine_version="string",
    storage_spec_code="string",
    storage_space=0,
    security_group_id="string",
    name="string",
    password="string",
    partition_num=0,
    retention_policy="string",
    access_user="string",
    specification="string",
    maintain_end="string",
    maintain_begin="string",
    dms_instance_v1_id="string",
    description="string")

const dmsInstanceV1Resource = new opentelekomcloud.DmsInstanceV1("dmsInstanceV1Resource", {
    productId: "string",
    availableZones: ["string"],
    vpcId: "string",
    subnetId: "string",
    engine: "string",
    engineVersion: "string",
    storageSpecCode: "string",
    storageSpace: 0,
    securityGroupId: "string",
    name: "string",
    password: "string",
    partitionNum: 0,
    retentionPolicy: "string",
    accessUser: "string",
    specification: "string",
    maintainEnd: "string",
    maintainBegin: "string",
    dmsInstanceV1Id: "string",
    description: "string",
});

type: opentelekomcloud:DmsInstanceV1
properties:
    accessUser: string
    availableZones:
        - string
    description: string
    dmsInstanceV1Id: string
    engine: string
    engineVersion: string
    maintainBegin: string
    maintainEnd: string
    name: string
    partitionNum: 0
    password: string
    productId: string
    retentionPolicy: string
    securityGroupId: string
    specification: string
    storageSpace: 0
    storageSpecCode: string
    subnetId: string
    vpcId: string

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

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.

Engine string

Indicates a message engine. Only kafka is supported now.

EngineVersion string

Indicates the version of a message engine. Only 2.3.0 is supported now.

ProductId string

Indicates a product ID.

SecurityGroupId string

Indicates the ID of a security group.

StorageSpace double

Indicates the message storage space. Value range:

Kafka instance with specification being 100MB: 600–90000 GB
Kafka instance with specification being 300MB: 1200–90000 GB
Kafka instance with specification being 600MB: 2400–90000 GB
Kafka instance with specification being 1200MB: 4800–90000 GB

StorageSpecCode string

Indicates the storage I/O specification. Options for a Kafka instance:

When specification is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 600MB: dms.physical.storage.ultra
When specification is 1200MB: dms.physical.storage.ultra

SubnetId string

Indicates the ID of the subnet (OpenStack network ID).

VpcId string

Indicates the ID of a VPC (OpenStack router ID).

AccessUser string

Indicates a username. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-).

Description string

Indicates the description of an instance. It is a character string containing not more than 1024 characters.

DmsInstanceV1Id string

MaintainBegin string

Indicates 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

Indicates 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

Indicates the name of an instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, and hyphens (-).

PartitionNum double

This parameter is mandatory when a kafka instance is created. Indicates the maximum number of topics in a Kafka instance.

When specification is 100MB: 300
When specification is 300MB: 900
When specification is 600MB: 1800
When specification is 1200MB: 1800

Password string

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

RetentionPolicy string

Indicates the action to be taken when the memory usage reaches the disk capacity threshold. The possible values are:

Specification string

This parameter is mandatory if the engine is kafka. Indicates the baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. Unit: byte/s. Options: 100MB, 300MB, 600MB, 1200MB.

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.

Engine string

Indicates a message engine. Only kafka is supported now.

EngineVersion string

Indicates the version of a message engine. Only 2.3.0 is supported now.

ProductId string

Indicates a product ID.

SecurityGroupId string

Indicates the ID of a security group.

StorageSpace float64

Indicates the message storage space. Value range:

Kafka instance with specification being 100MB: 600–90000 GB
Kafka instance with specification being 300MB: 1200–90000 GB
Kafka instance with specification being 600MB: 2400–90000 GB
Kafka instance with specification being 1200MB: 4800–90000 GB

StorageSpecCode string

Indicates the storage I/O specification. Options for a Kafka instance:

When specification is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 600MB: dms.physical.storage.ultra
When specification is 1200MB: dms.physical.storage.ultra

SubnetId string

Indicates the ID of the subnet (OpenStack network ID).

VpcId string

Indicates the ID of a VPC (OpenStack router ID).

AccessUser string

Indicates a username. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-).

Description string

Indicates the description of an instance. It is a character string containing not more than 1024 characters.

DmsInstanceV1Id string

MaintainBegin string

Indicates 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

Indicates 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

Indicates the name of an instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, and hyphens (-).

PartitionNum float64

This parameter is mandatory when a kafka instance is created. Indicates the maximum number of topics in a Kafka instance.

When specification is 100MB: 300
When specification is 300MB: 900
When specification is 600MB: 1800
When specification is 1200MB: 1800

Password string

RetentionPolicy string

Indicates the action to be taken when the memory usage reaches the disk capacity threshold. The possible values are:

Specification string

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.

engine String

Indicates a message engine. Only kafka is supported now.

engineVersion String

Indicates the version of a message engine. Only 2.3.0 is supported now.

productId String

Indicates a product ID.

securityGroupId String

Indicates the ID of a security group.

storageSpace Double

Indicates the message storage space. Value range:

Kafka instance with specification being 100MB: 600–90000 GB
Kafka instance with specification being 300MB: 1200–90000 GB
Kafka instance with specification being 600MB: 2400–90000 GB
Kafka instance with specification being 1200MB: 4800–90000 GB

storageSpecCode String

Indicates the storage I/O specification. Options for a Kafka instance:

When specification is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 600MB: dms.physical.storage.ultra
When specification is 1200MB: dms.physical.storage.ultra

subnetId String

Indicates the ID of the subnet (OpenStack network ID).

vpcId String

Indicates the ID of a VPC (OpenStack router ID).

accessUser String

Indicates a username. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-).

description String

Indicates the description of an instance. It is a character string containing not more than 1024 characters.

dmsInstanceV1Id String

maintainBegin String

Indicates 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

Indicates 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

Indicates the name of an instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, and hyphens (-).

partitionNum Double

This parameter is mandatory when a kafka instance is created. Indicates the maximum number of topics in a Kafka instance.

When specification is 100MB: 300
When specification is 300MB: 900
When specification is 600MB: 1800
When specification is 1200MB: 1800

password String

retentionPolicy String

Indicates the action to be taken when the memory usage reaches the disk capacity threshold. The possible values are:

specification String

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.

engine string

Indicates a message engine. Only kafka is supported now.

engineVersion string

Indicates the version of a message engine. Only 2.3.0 is supported now.

productId string

Indicates a product ID.

securityGroupId string

Indicates the ID of a security group.

storageSpace number

Indicates the message storage space. Value range:

Kafka instance with specification being 100MB: 600–90000 GB
Kafka instance with specification being 300MB: 1200–90000 GB
Kafka instance with specification being 600MB: 2400–90000 GB
Kafka instance with specification being 1200MB: 4800–90000 GB

storageSpecCode string

Indicates the storage I/O specification. Options for a Kafka instance:

When specification is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 600MB: dms.physical.storage.ultra
When specification is 1200MB: dms.physical.storage.ultra

subnetId string

Indicates the ID of the subnet (OpenStack network ID).

vpcId string

Indicates the ID of a VPC (OpenStack router ID).

accessUser string

Indicates a username. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-).

description string

Indicates the description of an instance. It is a character string containing not more than 1024 characters.

dmsInstanceV1Id string

maintainBegin string

Indicates 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

Indicates 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

Indicates the name of an instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, and hyphens (-).

partitionNum number

This parameter is mandatory when a kafka instance is created. Indicates the maximum number of topics in a Kafka instance.

When specification is 100MB: 300
When specification is 300MB: 900
When specification is 600MB: 1800
When specification is 1200MB: 1800

password string

retentionPolicy string

Indicates the action to be taken when the memory usage reaches the disk capacity threshold. The possible values are:

specification string

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.

engine str

Indicates a message engine. Only kafka is supported now.

engine_version str

Indicates the version of a message engine. Only 2.3.0 is supported now.

product_id str

Indicates a product ID.

security_group_id str

Indicates the ID of a security group.

storage_space float

Indicates the message storage space. Value range:

Kafka instance with specification being 100MB: 600–90000 GB
Kafka instance with specification being 300MB: 1200–90000 GB
Kafka instance with specification being 600MB: 2400–90000 GB
Kafka instance with specification being 1200MB: 4800–90000 GB

storage_spec_code str

Indicates the storage I/O specification. Options for a Kafka instance:

When specification is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 600MB: dms.physical.storage.ultra
When specification is 1200MB: dms.physical.storage.ultra

subnet_id str

Indicates the ID of the subnet (OpenStack network ID).

vpc_id str

Indicates the ID of a VPC (OpenStack router ID).

access_user str

Indicates a username. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-).

description str

Indicates the description of an instance. It is a character string containing not more than 1024 characters.

dms_instance_v1_id str

maintain_begin str

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

maintain_end str

Indicates 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 str

Indicates the name of an instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, and hyphens (-).

partition_num float

This parameter is mandatory when a kafka instance is created. Indicates the maximum number of topics in a Kafka instance.

When specification is 100MB: 300
When specification is 300MB: 900
When specification is 600MB: 1800
When specification is 1200MB: 1800

password str

retention_policy str

Indicates the action to be taken when the memory usage reaches the disk capacity threshold. The possible values are:

specification str

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.

engine String

Indicates a message engine. Only kafka is supported now.

engineVersion String

Indicates the version of a message engine. Only 2.3.0 is supported now.

productId String

Indicates a product ID.

securityGroupId String

Indicates the ID of a security group.

storageSpace Number

Indicates the message storage space. Value range:

Kafka instance with specification being 100MB: 600–90000 GB
Kafka instance with specification being 300MB: 1200–90000 GB
Kafka instance with specification being 600MB: 2400–90000 GB
Kafka instance with specification being 1200MB: 4800–90000 GB

storageSpecCode String

Indicates the storage I/O specification. Options for a Kafka instance:

When specification is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 600MB: dms.physical.storage.ultra
When specification is 1200MB: dms.physical.storage.ultra

subnetId String

Indicates the ID of the subnet (OpenStack network ID).

vpcId String

Indicates the ID of a VPC (OpenStack router ID).

accessUser String

Indicates a username. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-).

description String

Indicates the description of an instance. It is a character string containing not more than 1024 characters.

dmsInstanceV1Id String

maintainBegin String

Indicates 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

Indicates 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

Indicates the name of an instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, and hyphens (-).

partitionNum Number

This parameter is mandatory when a kafka instance is created. Indicates the maximum number of topics in a Kafka instance.

When specification is 100MB: 300
When specification is 300MB: 900
When specification is 600MB: 1800
When specification is 1200MB: 1800

password String

retentionPolicy String

Indicates the action to be taken when the memory usage reaches the disk capacity threshold. The possible values are:

specification String

Outputs

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

ConnectAddress string: Indicates the IP address of an instance.
CreatedAt string: Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.
Id string: The provider-assigned unique ID for this managed resource.
OrderId string
Port double: Indicates the port number of an instance.
ResourceSpecCode string: Indicates a resource specifications identifier.
SecurityGroupName string: Indicates the name of a security group.
Status string: Indicates the status of an instance. For details, see section Instance Status.
SubnetName string: Indicates the name of a subnet.
Type string: Indicates an instance type. Options: single and cluster.
UsedStorageSpace double: Indicates the used message storage space. Unit: GB
UserId string: Indicates a user ID.
UserName string: Indicates a username.
VpcName string

ConnectAddress string: Indicates the IP address of an instance.
CreatedAt string: Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.
Id string: The provider-assigned unique ID for this managed resource.
OrderId string
Port float64: Indicates the port number of an instance.
ResourceSpecCode string: Indicates a resource specifications identifier.
SecurityGroupName string: Indicates the name of a security group.
Status string: Indicates the status of an instance. For details, see section Instance Status.
SubnetName string: Indicates the name of a subnet.
Type string: Indicates an instance type. Options: single and cluster.
UsedStorageSpace float64: Indicates the used message storage space. Unit: GB
UserId string: Indicates a user ID.
UserName string: Indicates a username.
VpcName string

connectAddress String: Indicates the IP address of an instance.
createdAt String: Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.
id String: The provider-assigned unique ID for this managed resource.
orderId String
port Double: Indicates the port number of an instance.
resourceSpecCode String: Indicates a resource specifications identifier.
securityGroupName String: Indicates the name of a security group.
status String: Indicates the status of an instance. For details, see section Instance Status.
subnetName String: Indicates the name of a subnet.
type String: Indicates an instance type. Options: single and cluster.
usedStorageSpace Double: Indicates the used message storage space. Unit: GB
userId String: Indicates a user ID.
userName String: Indicates a username.
vpcName String

connectAddress string: Indicates the IP address of an instance.
createdAt string: Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.
id string: The provider-assigned unique ID for this managed resource.
orderId string
port number: Indicates the port number of an instance.
resourceSpecCode string: Indicates a resource specifications identifier.
securityGroupName string: Indicates the name of a security group.
status string: Indicates the status of an instance. For details, see section Instance Status.
subnetName string: Indicates the name of a subnet.
type string: Indicates an instance type. Options: single and cluster.
usedStorageSpace number: Indicates the used message storage space. Unit: GB
userId string: Indicates a user ID.
userName string: Indicates a username.
vpcName string

connect_address str: Indicates the IP address of an instance.
created_at str: Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.
id str: The provider-assigned unique ID for this managed resource.
order_id str
port float: Indicates the port number of an instance.
resource_spec_code str: Indicates a resource specifications identifier.
security_group_name str: Indicates the name of a security group.
status str: Indicates the status of an instance. For details, see section Instance Status.
subnet_name str: Indicates the name of a subnet.
type str: Indicates an instance type. Options: single and cluster.
used_storage_space float: Indicates the used message storage space. Unit: GB
user_id str: Indicates a user ID.
user_name str: Indicates a username.
vpc_name str

connectAddress String: Indicates the IP address of an instance.
createdAt String: Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.
id String: The provider-assigned unique ID for this managed resource.
orderId String
port Number: Indicates the port number of an instance.
resourceSpecCode String: Indicates a resource specifications identifier.
securityGroupName String: Indicates the name of a security group.
status String: Indicates the status of an instance. For details, see section Instance Status.
subnetName String: Indicates the name of a subnet.
type String: Indicates an instance type. Options: single and cluster.
usedStorageSpace Number: Indicates the used message storage space. Unit: GB
userId String: Indicates a user ID.
userName String: Indicates a username.
vpcName String

Look up Existing DmsInstanceV1 Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_user: Optional[str] = None,
        available_zones: Optional[Sequence[str]] = None,
        connect_address: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        dms_instance_v1_id: Optional[str] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        maintain_begin: Optional[str] = None,
        maintain_end: Optional[str] = None,
        name: Optional[str] = None,
        order_id: Optional[str] = None,
        partition_num: Optional[float] = None,
        password: Optional[str] = None,
        port: Optional[float] = None,
        product_id: Optional[str] = None,
        resource_spec_code: Optional[str] = None,
        retention_policy: Optional[str] = None,
        security_group_id: Optional[str] = None,
        security_group_name: Optional[str] = None,
        specification: Optional[str] = None,
        status: Optional[str] = None,
        storage_space: Optional[float] = None,
        storage_spec_code: Optional[str] = None,
        subnet_id: Optional[str] = None,
        subnet_name: Optional[str] = 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,
        vpc_name: Optional[str] = None) -> DmsInstanceV1

func GetDmsInstanceV1(ctx *Context, name string, id IDInput, state *DmsInstanceV1State, opts ...ResourceOption) (*DmsInstanceV1, error)

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

public static DmsInstanceV1 get(String name, Output<String> id, DmsInstanceV1State state, CustomResourceOptions options)

resources:  _:    type: opentelekomcloud:DmsInstanceV1    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

Indicates a username. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-).

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.

ConnectAddress string

Indicates the IP address of an instance.

CreatedAt string

Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.

Description string

Indicates the description of an instance. It is a character string containing not more than 1024 characters.

DmsInstanceV1Id string

Engine string

Indicates a message engine. Only kafka is supported now.

EngineVersion string

Indicates the version of a message engine. Only 2.3.0 is supported now.

MaintainBegin string

Indicates 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

Indicates 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

Indicates the name of an instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, and hyphens (-).

OrderId string

PartitionNum double

This parameter is mandatory when a kafka instance is created. Indicates the maximum number of topics in a Kafka instance.

When specification is 100MB: 300
When specification is 300MB: 900
When specification is 600MB: 1800
When specification is 1200MB: 1800

Password string

Port double

Indicates the port number of an instance.

ProductId string

Indicates a product ID.

ResourceSpecCode string

Indicates a resource specifications identifier.

RetentionPolicy string

Indicates the action to be taken when the memory usage reaches the disk capacity threshold. The possible values are:

SecurityGroupId string

Indicates the ID of a security group.

SecurityGroupName string

Indicates the name of a security group.

Specification string

Status string

Indicates the status of an instance. For details, see section Instance Status.

StorageSpace double

Indicates the message storage space. Value range:

Kafka instance with specification being 100MB: 600–90000 GB
Kafka instance with specification being 300MB: 1200–90000 GB
Kafka instance with specification being 600MB: 2400–90000 GB
Kafka instance with specification being 1200MB: 4800–90000 GB

StorageSpecCode string

Indicates the storage I/O specification. Options for a Kafka instance:

When specification is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 600MB: dms.physical.storage.ultra
When specification is 1200MB: dms.physical.storage.ultra

SubnetId string

Indicates the ID of the subnet (OpenStack network ID).

SubnetName string

Indicates the name of a subnet.

Type string

Indicates an instance type. Options: single and cluster.

UsedStorageSpace double

Indicates the used message storage space. Unit: GB

UserId string

Indicates a user ID.

UserName string

Indicates a username.

VpcId string

Indicates the ID of a VPC (OpenStack router ID).

VpcName string

AccessUser string

Indicates a username. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-).

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.

ConnectAddress string

Indicates the IP address of an instance.

CreatedAt string

Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.

Description string

Indicates the description of an instance. It is a character string containing not more than 1024 characters.

DmsInstanceV1Id string

Engine string

Indicates a message engine. Only kafka is supported now.

EngineVersion string

Indicates the version of a message engine. Only 2.3.0 is supported now.

MaintainBegin string

Indicates 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

Indicates 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

Indicates the name of an instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, and hyphens (-).

OrderId string

PartitionNum float64

This parameter is mandatory when a kafka instance is created. Indicates the maximum number of topics in a Kafka instance.

When specification is 100MB: 300
When specification is 300MB: 900
When specification is 600MB: 1800
When specification is 1200MB: 1800

Password string

Port float64

Indicates the port number of an instance.

ProductId string

Indicates a product ID.

ResourceSpecCode string

Indicates a resource specifications identifier.

RetentionPolicy string

Indicates the action to be taken when the memory usage reaches the disk capacity threshold. The possible values are:

SecurityGroupId string

Indicates the ID of a security group.

SecurityGroupName string

Indicates the name of a security group.

Specification string

Status string

Indicates the status of an instance. For details, see section Instance Status.

StorageSpace float64

Indicates the message storage space. Value range:

Kafka instance with specification being 100MB: 600–90000 GB
Kafka instance with specification being 300MB: 1200–90000 GB
Kafka instance with specification being 600MB: 2400–90000 GB
Kafka instance with specification being 1200MB: 4800–90000 GB

StorageSpecCode string

Indicates the storage I/O specification. Options for a Kafka instance:

When specification is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 600MB: dms.physical.storage.ultra
When specification is 1200MB: dms.physical.storage.ultra

SubnetId string

Indicates the ID of the subnet (OpenStack network ID).

SubnetName string

Indicates the name of a subnet.

Type string

Indicates an instance type. Options: single and cluster.

UsedStorageSpace float64

Indicates the used message storage space. Unit: GB

UserId string

Indicates a user ID.

UserName string

Indicates a username.

VpcId string

Indicates the ID of a VPC (OpenStack router ID).

VpcName string

accessUser String

Indicates a username. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-).

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.

connectAddress String

Indicates the IP address of an instance.

createdAt String

Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.

description String

Indicates the description of an instance. It is a character string containing not more than 1024 characters.

dmsInstanceV1Id String

engine String

Indicates a message engine. Only kafka is supported now.

engineVersion String

Indicates the version of a message engine. Only 2.3.0 is supported now.

maintainBegin String

Indicates 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

Indicates 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

Indicates the name of an instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, and hyphens (-).

orderId String

partitionNum Double

This parameter is mandatory when a kafka instance is created. Indicates the maximum number of topics in a Kafka instance.

When specification is 100MB: 300
When specification is 300MB: 900
When specification is 600MB: 1800
When specification is 1200MB: 1800

password String

port Double

Indicates the port number of an instance.

productId String

Indicates a product ID.

resourceSpecCode String

Indicates a resource specifications identifier.

retentionPolicy String

Indicates the action to be taken when the memory usage reaches the disk capacity threshold. The possible values are:

securityGroupId String

Indicates the ID of a security group.

securityGroupName String

Indicates the name of a security group.

specification String

status String

Indicates the status of an instance. For details, see section Instance Status.

storageSpace Double

Indicates the message storage space. Value range:

Kafka instance with specification being 100MB: 600–90000 GB
Kafka instance with specification being 300MB: 1200–90000 GB
Kafka instance with specification being 600MB: 2400–90000 GB
Kafka instance with specification being 1200MB: 4800–90000 GB

storageSpecCode String

Indicates the storage I/O specification. Options for a Kafka instance:

When specification is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 600MB: dms.physical.storage.ultra
When specification is 1200MB: dms.physical.storage.ultra

subnetId String

Indicates the ID of the subnet (OpenStack network ID).

subnetName String

Indicates the name of a subnet.

type String

Indicates an instance type. Options: single and cluster.

usedStorageSpace Double

Indicates the used message storage space. Unit: GB

userId String

Indicates a user ID.

userName String

Indicates a username.

vpcId String

Indicates the ID of a VPC (OpenStack router ID).

vpcName String

accessUser string

Indicates a username. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-).

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.

connectAddress string

Indicates the IP address of an instance.

createdAt string

Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.

description string

Indicates the description of an instance. It is a character string containing not more than 1024 characters.

dmsInstanceV1Id string

engine string

Indicates a message engine. Only kafka is supported now.

engineVersion string

Indicates the version of a message engine. Only 2.3.0 is supported now.

maintainBegin string

Indicates 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

Indicates 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

Indicates the name of an instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, and hyphens (-).

orderId string

partitionNum number

This parameter is mandatory when a kafka instance is created. Indicates the maximum number of topics in a Kafka instance.

When specification is 100MB: 300
When specification is 300MB: 900
When specification is 600MB: 1800
When specification is 1200MB: 1800

password string

port number

Indicates the port number of an instance.

productId string

Indicates a product ID.

resourceSpecCode string

Indicates a resource specifications identifier.

retentionPolicy string

Indicates the action to be taken when the memory usage reaches the disk capacity threshold. The possible values are:

securityGroupId string

Indicates the ID of a security group.

securityGroupName string

Indicates the name of a security group.

specification string

status string

Indicates the status of an instance. For details, see section Instance Status.

storageSpace number

Indicates the message storage space. Value range:

Kafka instance with specification being 100MB: 600–90000 GB
Kafka instance with specification being 300MB: 1200–90000 GB
Kafka instance with specification being 600MB: 2400–90000 GB
Kafka instance with specification being 1200MB: 4800–90000 GB

storageSpecCode string

Indicates the storage I/O specification. Options for a Kafka instance:

When specification is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 600MB: dms.physical.storage.ultra
When specification is 1200MB: dms.physical.storage.ultra

subnetId string

Indicates the ID of the subnet (OpenStack network ID).

subnetName string

Indicates the name of a subnet.

type string

Indicates an instance type. Options: single and cluster.

usedStorageSpace number

Indicates the used message storage space. Unit: GB

userId string

Indicates a user ID.

userName string

Indicates a username.

vpcId string

Indicates the ID of a VPC (OpenStack router ID).

vpcName string

access_user str

Indicates a username. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-).

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.

connect_address str

Indicates the IP address of an instance.

created_at str

Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.

description str

Indicates the description of an instance. It is a character string containing not more than 1024 characters.

dms_instance_v1_id str

engine str

Indicates a message engine. Only kafka is supported now.

engine_version str

Indicates the version of a message engine. Only 2.3.0 is supported now.

maintain_begin str

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

maintain_end str

Indicates 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 str

Indicates the name of an instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, and hyphens (-).

order_id str

partition_num float

This parameter is mandatory when a kafka instance is created. Indicates the maximum number of topics in a Kafka instance.

When specification is 100MB: 300
When specification is 300MB: 900
When specification is 600MB: 1800
When specification is 1200MB: 1800

password str

port float

Indicates the port number of an instance.

product_id str

Indicates a product ID.

resource_spec_code str

Indicates a resource specifications identifier.

retention_policy str

Indicates the action to be taken when the memory usage reaches the disk capacity threshold. The possible values are:

security_group_id str

Indicates the ID of a security group.

security_group_name str

Indicates the name of a security group.

specification str

status str

Indicates the status of an instance. For details, see section Instance Status.

storage_space float

Indicates the message storage space. Value range:

Kafka instance with specification being 100MB: 600–90000 GB
Kafka instance with specification being 300MB: 1200–90000 GB
Kafka instance with specification being 600MB: 2400–90000 GB
Kafka instance with specification being 1200MB: 4800–90000 GB

storage_spec_code str

Indicates the storage I/O specification. Options for a Kafka instance:

When specification is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 600MB: dms.physical.storage.ultra
When specification is 1200MB: dms.physical.storage.ultra

subnet_id str

Indicates the ID of the subnet (OpenStack network ID).

subnet_name str

Indicates the name of a subnet.

type str

Indicates an instance type. Options: single and cluster.

used_storage_space float

Indicates the used message storage space. Unit: GB

user_id str

Indicates a user ID.

user_name str

Indicates a username.

vpc_id str

Indicates the ID of a VPC (OpenStack router ID).

vpc_name str

accessUser String

Indicates a username. A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-).

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.

connectAddress String

Indicates the IP address of an instance.

createdAt String

Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.

description String

Indicates the description of an instance. It is a character string containing not more than 1024 characters.

dmsInstanceV1Id String

engine String

Indicates a message engine. Only kafka is supported now.

engineVersion String

Indicates the version of a message engine. Only 2.3.0 is supported now.

maintainBegin String

Indicates 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

Indicates 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

Indicates the name of an instance. An instance name starts with a letter, consists of 4 to 64 characters, and supports only letters, digits, and hyphens (-).

orderId String

partitionNum Number

This parameter is mandatory when a kafka instance is created. Indicates the maximum number of topics in a Kafka instance.

When specification is 100MB: 300
When specification is 300MB: 900
When specification is 600MB: 1800
When specification is 1200MB: 1800

password String

port Number

Indicates the port number of an instance.

productId String

Indicates a product ID.

resourceSpecCode String

Indicates a resource specifications identifier.

retentionPolicy String

Indicates the action to be taken when the memory usage reaches the disk capacity threshold. The possible values are:

securityGroupId String

Indicates the ID of a security group.

securityGroupName String

Indicates the name of a security group.

specification String

status String

Indicates the status of an instance. For details, see section Instance Status.

storageSpace Number

Indicates the message storage space. Value range:

Kafka instance with specification being 100MB: 600–90000 GB
Kafka instance with specification being 300MB: 1200–90000 GB
Kafka instance with specification being 600MB: 2400–90000 GB
Kafka instance with specification being 1200MB: 4800–90000 GB

storageSpecCode String

Indicates the storage I/O specification. Options for a Kafka instance:

When specification is 100MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 300MB: dms.physical.storage.high or dms.physical.storage.ultra
When specification is 600MB: dms.physical.storage.ultra
When specification is 1200MB: dms.physical.storage.ultra

subnetId String