VdbInstance

tencentcloud 1.82.93, May 11 26

Viewing docs for tencentcloud 1.82.93
published on Monday, May 11, 2026 by tencentcloudstack

Schema (JSON)

tencentcloudstack/terraform-provider-tencentcloud

Viewing docs for tencentcloud 1.82.93
published on Monday, May 11, 2026 by tencentcloudstack

Schema (JSON)

tencentcloudstack/terraform-provider-tencentcloud

Example Usage

Create a pay-as-you-go single instance

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

const example = new tencentcloud.VdbInstance("example", {
    vpcId: "vpc-xxxxxxxx",
    subnetId: "subnet-xxxxxxxx",
    payMode: 0,
    securityGroupIds: ["sg-xxxxxxxx"],
    instanceName: "tf-example",
    instanceType: "single",
    nodeType: "normal",
    cpu: 2,
    memory: 4,
    diskSize: 50,
    workerNodeNum: 1,
    forceDelete: false,
});

import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.VdbInstance("example",
    vpc_id="vpc-xxxxxxxx",
    subnet_id="subnet-xxxxxxxx",
    pay_mode=0,
    security_group_ids=["sg-xxxxxxxx"],
    instance_name="tf-example",
    instance_type="single",
    node_type="normal",
    cpu=2,
    memory=4,
    disk_size=50,
    worker_node_num=1,
    force_delete=False)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewVdbInstance(ctx, "example", &tencentcloud.VdbInstanceArgs{
			VpcId:    pulumi.String("vpc-xxxxxxxx"),
			SubnetId: pulumi.String("subnet-xxxxxxxx"),
			PayMode:  pulumi.Float64(0),
			SecurityGroupIds: pulumi.StringArray{
				pulumi.String("sg-xxxxxxxx"),
			},
			InstanceName:  pulumi.String("tf-example"),
			InstanceType:  pulumi.String("single"),
			NodeType:      pulumi.String("normal"),
			Cpu:           pulumi.Float64(2),
			Memory:        pulumi.Float64(4),
			DiskSize:      pulumi.Float64(50),
			WorkerNodeNum: pulumi.Float64(1),
			ForceDelete:   pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Tencentcloud.VdbInstance("example", new()
    {
        VpcId = "vpc-xxxxxxxx",
        SubnetId = "subnet-xxxxxxxx",
        PayMode = 0,
        SecurityGroupIds = new[]
        {
            "sg-xxxxxxxx",
        },
        InstanceName = "tf-example",
        InstanceType = "single",
        NodeType = "normal",
        Cpu = 2,
        Memory = 4,
        DiskSize = 50,
        WorkerNodeNum = 1,
        ForceDelete = false,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.VdbInstance;
import com.pulumi.tencentcloud.VdbInstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var example = new VdbInstance("example", VdbInstanceArgs.builder()
            .vpcId("vpc-xxxxxxxx")
            .subnetId("subnet-xxxxxxxx")
            .payMode(0.0)
            .securityGroupIds("sg-xxxxxxxx")
            .instanceName("tf-example")
            .instanceType("single")
            .nodeType("normal")
            .cpu(2.0)
            .memory(4.0)
            .diskSize(50.0)
            .workerNodeNum(1.0)
            .forceDelete(false)
            .build());

    }
}

resources:
  example:
    type: tencentcloud:VdbInstance
    properties:
      vpcId: vpc-xxxxxxxx
      subnetId: subnet-xxxxxxxx
      payMode: 0
      securityGroupIds:
        - sg-xxxxxxxx
      instanceName: tf-example
      instanceType: single
      nodeType: normal
      cpu: 2
      memory: 4
      diskSize: 50
      workerNodeNum: 1
      forceDelete: false

Example coming soon!

Create a monthly subscription cluster instance with all parameters

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

const cluster = new tencentcloud.VdbInstance("cluster", {
    vpcId: "vpc-xxxxxxxx",
    subnetId: "subnet-xxxxxxxx",
    payMode: 1,
    payPeriod: 1,
    autoRenew: 1,
    instanceName: "tf-example-cluster",
    instanceType: "cluster",
    mode: "two",
    productType: 0,
    nodeType: "compute",
    cpu: 4,
    memory: 8,
    diskSize: 100,
    workerNodeNum: 2,
    params: "{\"key\":\"value\"}",
    forceDelete: true,
    securityGroupIds: ["sg-xxxxxxxx"],
    resourceTags: [
        {
            tagKey: "env",
            tagValue: "test",
        },
        {
            tagKey: "project",
            tagValue: "demo",
        },
    ],
});

import pulumi
import pulumi_tencentcloud as tencentcloud

cluster = tencentcloud.VdbInstance("cluster",
    vpc_id="vpc-xxxxxxxx",
    subnet_id="subnet-xxxxxxxx",
    pay_mode=1,
    pay_period=1,
    auto_renew=1,
    instance_name="tf-example-cluster",
    instance_type="cluster",
    mode="two",
    product_type=0,
    node_type="compute",
    cpu=4,
    memory=8,
    disk_size=100,
    worker_node_num=2,
    params="{\"key\":\"value\"}",
    force_delete=True,
    security_group_ids=["sg-xxxxxxxx"],
    resource_tags=[
        {
            "tag_key": "env",
            "tag_value": "test",
        },
        {
            "tag_key": "project",
            "tag_value": "demo",
        },
    ])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewVdbInstance(ctx, "cluster", &tencentcloud.VdbInstanceArgs{
			VpcId:         pulumi.String("vpc-xxxxxxxx"),
			SubnetId:      pulumi.String("subnet-xxxxxxxx"),
			PayMode:       pulumi.Float64(1),
			PayPeriod:     pulumi.Float64(1),
			AutoRenew:     pulumi.Float64(1),
			InstanceName:  pulumi.String("tf-example-cluster"),
			InstanceType:  pulumi.String("cluster"),
			Mode:          pulumi.String("two"),
			ProductType:   pulumi.Float64(0),
			NodeType:      pulumi.String("compute"),
			Cpu:           pulumi.Float64(4),
			Memory:        pulumi.Float64(8),
			DiskSize:      pulumi.Float64(100),
			WorkerNodeNum: pulumi.Float64(2),
			Params:        pulumi.String("{\"key\":\"value\"}"),
			ForceDelete:   pulumi.Bool(true),
			SecurityGroupIds: pulumi.StringArray{
				pulumi.String("sg-xxxxxxxx"),
			},
			ResourceTags: tencentcloud.VdbInstanceResourceTagArray{
				&tencentcloud.VdbInstanceResourceTagArgs{
					TagKey:   pulumi.String("env"),
					TagValue: pulumi.String("test"),
				},
				&tencentcloud.VdbInstanceResourceTagArgs{
					TagKey:   pulumi.String("project"),
					TagValue: pulumi.String("demo"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var cluster = new Tencentcloud.VdbInstance("cluster", new()
    {
        VpcId = "vpc-xxxxxxxx",
        SubnetId = "subnet-xxxxxxxx",
        PayMode = 1,
        PayPeriod = 1,
        AutoRenew = 1,
        InstanceName = "tf-example-cluster",
        InstanceType = "cluster",
        Mode = "two",
        ProductType = 0,
        NodeType = "compute",
        Cpu = 4,
        Memory = 8,
        DiskSize = 100,
        WorkerNodeNum = 2,
        Params = "{\"key\":\"value\"}",
        ForceDelete = true,
        SecurityGroupIds = new[]
        {
            "sg-xxxxxxxx",
        },
        ResourceTags = new[]
        {
            new Tencentcloud.Inputs.VdbInstanceResourceTagArgs
            {
                TagKey = "env",
                TagValue = "test",
            },
            new Tencentcloud.Inputs.VdbInstanceResourceTagArgs
            {
                TagKey = "project",
                TagValue = "demo",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.VdbInstance;
import com.pulumi.tencentcloud.VdbInstanceArgs;
import com.pulumi.tencentcloud.inputs.VdbInstanceResourceTagArgs;
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 cluster = new VdbInstance("cluster", VdbInstanceArgs.builder()
            .vpcId("vpc-xxxxxxxx")
            .subnetId("subnet-xxxxxxxx")
            .payMode(1.0)
            .payPeriod(1.0)
            .autoRenew(1.0)
            .instanceName("tf-example-cluster")
            .instanceType("cluster")
            .mode("two")
            .productType(0.0)
            .nodeType("compute")
            .cpu(4.0)
            .memory(8.0)
            .diskSize(100.0)
            .workerNodeNum(2.0)
            .params("{\"key\":\"value\"}")
            .forceDelete(true)
            .securityGroupIds("sg-xxxxxxxx")
            .resourceTags(            
                VdbInstanceResourceTagArgs.builder()
                    .tagKey("env")
                    .tagValue("test")
                    .build(),
                VdbInstanceResourceTagArgs.builder()
                    .tagKey("project")
                    .tagValue("demo")
                    .build())
            .build());

    }
}

resources:
  cluster:
    type: tencentcloud:VdbInstance
    properties:
      vpcId: vpc-xxxxxxxx
      subnetId: subnet-xxxxxxxx
      payMode: 1
      payPeriod: 1
      autoRenew: 1
      instanceName: tf-example-cluster
      instanceType: cluster
      mode: two
      productType: 0
      nodeType: compute
      cpu: 4
      memory: 8
      diskSize: 100
      workerNodeNum: 2
      params: '{"key":"value"}'
      forceDelete: true
      securityGroupIds:
        - sg-xxxxxxxx
      resourceTags:
        - tagKey: env
          tagValue: test
        - tagKey: project
          tagValue: demo

Example coming soon!

Create VdbInstance Resource

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

Constructor syntax

new VdbInstance(name: string, args: VdbInstanceArgs, opts?: CustomResourceOptions);

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

@overload
def VdbInstance(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                subnet_id: Optional[str] = None,
                pay_mode: Optional[float] = None,
                vpc_id: Optional[str] = None,
                security_group_ids: Optional[Sequence[str]] = None,
                cpu: Optional[float] = None,
                pay_period: Optional[float] = None,
                memory: Optional[float] = None,
                mode: Optional[str] = None,
                params: Optional[str] = None,
                node_type: Optional[str] = None,
                product_type: Optional[float] = None,
                instance_type: Optional[str] = None,
                instance_name: Optional[str] = None,
                resource_tags: Optional[Sequence[VdbInstanceResourceTagArgs]] = None,
                force_delete: Optional[bool] = None,
                auto_renew: Optional[float] = None,
                timeouts: Optional[VdbInstanceTimeoutsArgs] = None,
                vdb_instance_id: Optional[str] = None,
                disk_size: Optional[float] = None,
                worker_node_num: Optional[float] = None)

func NewVdbInstance(ctx *Context, name string, args VdbInstanceArgs, opts ...ResourceOption) (*VdbInstance, error)

public VdbInstance(string name, VdbInstanceArgs args, CustomResourceOptions? opts = null)

public VdbInstance(String name, VdbInstanceArgs args)
public VdbInstance(String name, VdbInstanceArgs args, CustomResourceOptions options)

type: tencentcloud:VdbInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "tencentcloud_vdbinstance" "name" {
    # resource properties
}

Parameters

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

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

name String: The unique name of the resource.
args VdbInstanceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

PayMode double: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
SecurityGroupIds List<string>: Security group IDs.
SubnetId string: Subnet ID.
VpcId string: VPC ID.
AutoRenew double: Auto-renew flag. 0: disabled, 1: enabled.
Cpu double: CPU cores.
DiskSize double: Disk size in GB.
ForceDelete bool: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
InstanceName string: Instance name. Supports up to 60 characters.
InstanceType string: Instance type. Valid values: base, single, cluster.
Memory double: Memory size in GB.
Mode string: Availability zone mode for cluster type. Valid values: two, three.
NodeType string: Node type. Valid values: compute, normal, store.
Params string: Instance extra parameters, submitted via JSON.
PayPeriod double: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
ProductType double: Product version. 0: standard, 1: capacity-enhanced.
ResourceTags List<VdbInstanceResourceTag>: Tag list.
Timeouts VdbInstanceTimeouts
VdbInstanceId string: ID of the resource.
WorkerNodeNum double: Number of worker nodes.

PayMode float64: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
SecurityGroupIds []string: Security group IDs.
SubnetId string: Subnet ID.
VpcId string: VPC ID.
AutoRenew float64: Auto-renew flag. 0: disabled, 1: enabled.
Cpu float64: CPU cores.
DiskSize float64: Disk size in GB.
ForceDelete bool: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
InstanceName string: Instance name. Supports up to 60 characters.
InstanceType string: Instance type. Valid values: base, single, cluster.
Memory float64: Memory size in GB.
Mode string: Availability zone mode for cluster type. Valid values: two, three.
NodeType string: Node type. Valid values: compute, normal, store.
Params string: Instance extra parameters, submitted via JSON.
PayPeriod float64: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
ProductType float64: Product version. 0: standard, 1: capacity-enhanced.
ResourceTags []VdbInstanceResourceTagArgs: Tag list.
Timeouts VdbInstanceTimeoutsArgs
VdbInstanceId string: ID of the resource.
WorkerNodeNum float64: Number of worker nodes.

pay_mode number: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
security_group_ids list(string): Security group IDs.
subnet_id string: Subnet ID.
vpc_id string: VPC ID.
auto_renew number: Auto-renew flag. 0: disabled, 1: enabled.
cpu number: CPU cores.
disk_size number: Disk size in GB.
force_delete bool: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
instance_name string: Instance name. Supports up to 60 characters.
instance_type string: Instance type. Valid values: base, single, cluster.
memory number: Memory size in GB.
mode string: Availability zone mode for cluster type. Valid values: two, three.
node_type string: Node type. Valid values: compute, normal, store.
params string: Instance extra parameters, submitted via JSON.
pay_period number: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
product_type number: Product version. 0: standard, 1: capacity-enhanced.
resource_tags list(object): Tag list.
timeouts object
vdb_instance_id string: ID of the resource.
worker_node_num number: Number of worker nodes.

payMode Double: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
securityGroupIds List<String>: Security group IDs.
subnetId String: Subnet ID.
vpcId String: VPC ID.
autoRenew Double: Auto-renew flag. 0: disabled, 1: enabled.
cpu Double: CPU cores.
diskSize Double: Disk size in GB.
forceDelete Boolean: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
instanceName String: Instance name. Supports up to 60 characters.
instanceType String: Instance type. Valid values: base, single, cluster.
memory Double: Memory size in GB.
mode String: Availability zone mode for cluster type. Valid values: two, three.
nodeType String: Node type. Valid values: compute, normal, store.
params String: Instance extra parameters, submitted via JSON.
payPeriod Double: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
productType Double: Product version. 0: standard, 1: capacity-enhanced.
resourceTags List<VdbInstanceResourceTag>: Tag list.
timeouts VdbInstanceTimeouts
vdbInstanceId String: ID of the resource.
workerNodeNum Double: Number of worker nodes.

payMode number: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
securityGroupIds string[]: Security group IDs.
subnetId string: Subnet ID.
vpcId string: VPC ID.
autoRenew number: Auto-renew flag. 0: disabled, 1: enabled.
cpu number: CPU cores.
diskSize number: Disk size in GB.
forceDelete boolean: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
instanceName string: Instance name. Supports up to 60 characters.
instanceType string: Instance type. Valid values: base, single, cluster.
memory number: Memory size in GB.
mode string: Availability zone mode for cluster type. Valid values: two, three.
nodeType string: Node type. Valid values: compute, normal, store.
params string: Instance extra parameters, submitted via JSON.
payPeriod number: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
productType number: Product version. 0: standard, 1: capacity-enhanced.
resourceTags VdbInstanceResourceTag[]: Tag list.
timeouts VdbInstanceTimeouts
vdbInstanceId string: ID of the resource.
workerNodeNum number: Number of worker nodes.

pay_mode float: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
security_group_ids Sequence[str]: Security group IDs.
subnet_id str: Subnet ID.
vpc_id str: VPC ID.
auto_renew float: Auto-renew flag. 0: disabled, 1: enabled.
cpu float: CPU cores.
disk_size float: Disk size in GB.
force_delete bool: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
instance_name str: Instance name. Supports up to 60 characters.
instance_type str: Instance type. Valid values: base, single, cluster.
memory float: Memory size in GB.
mode str: Availability zone mode for cluster type. Valid values: two, three.
node_type str: Node type. Valid values: compute, normal, store.
params str: Instance extra parameters, submitted via JSON.
pay_period float: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
product_type float: Product version. 0: standard, 1: capacity-enhanced.
resource_tags Sequence[VdbInstanceResourceTagArgs]: Tag list.
timeouts VdbInstanceTimeoutsArgs
vdb_instance_id str: ID of the resource.
worker_node_num float: Number of worker nodes.

payMode Number: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
securityGroupIds List<String>: Security group IDs.
subnetId String: Subnet ID.
vpcId String: VPC ID.
autoRenew Number: Auto-renew flag. 0: disabled, 1: enabled.
cpu Number: CPU cores.
diskSize Number: Disk size in GB.
forceDelete Boolean: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
instanceName String: Instance name. Supports up to 60 characters.
instanceType String: Instance type. Valid values: base, single, cluster.
memory Number: Memory size in GB.
mode String: Availability zone mode for cluster type. Valid values: two, three.
nodeType String: Node type. Valid values: compute, normal, store.
params String: Instance extra parameters, submitted via JSON.
payPeriod Number: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
productType Number: Product version. 0: standard, 1: capacity-enhanced.
resourceTags List<Property Map>: Tag list.
timeouts Property Map
vdbInstanceId String: ID of the resource.
workerNodeNum Number: Number of worker nodes.

Outputs

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

ApiVersion string: API version.
CreatedAt string: Creation time.
EngineName string: Engine name.
EngineVersion string: Engine version.
ExpiredAt string: Expiration time.
Extend string: Extended information in JSON format.
Id string: The provider-assigned unique ID for this managed resource.
IsNoExpired bool: Whether the instance never expires.
IsolateAt string: Isolation time.
Networks List<VdbInstanceNetwork>: Network information.
Nodes List<VdbInstanceNode>: Instance node list.
Product string: Product.
Region string: Region.
ShardNum double: Shard number.
Status string: Instance status.
TaskStatus double: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
WanAddress string: Public network address.
Zone string: Availability zone.

ApiVersion string: API version.
CreatedAt string: Creation time.
EngineName string: Engine name.
EngineVersion string: Engine version.
ExpiredAt string: Expiration time.
Extend string: Extended information in JSON format.
Id string: The provider-assigned unique ID for this managed resource.
IsNoExpired bool: Whether the instance never expires.
IsolateAt string: Isolation time.
Networks []VdbInstanceNetwork: Network information.
Nodes []VdbInstanceNode: Instance node list.
Product string: Product.
Region string: Region.
ShardNum float64: Shard number.
Status string: Instance status.
TaskStatus float64: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
WanAddress string: Public network address.
Zone string: Availability zone.

api_version string: API version.
created_at string: Creation time.
engine_name string: Engine name.
engine_version string: Engine version.
expired_at string: Expiration time.
extend string: Extended information in JSON format.
id string: The provider-assigned unique ID for this managed resource.
is_no_expired bool: Whether the instance never expires.
isolate_at string: Isolation time.
networks list(object): Network information.
nodes list(object): Instance node list.
product string: Product.
region string: Region.
shard_num number: Shard number.
status string: Instance status.
task_status number: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
wan_address string: Public network address.
zone string: Availability zone.

apiVersion String: API version.
createdAt String: Creation time.
engineName String: Engine name.
engineVersion String: Engine version.
expiredAt String: Expiration time.
extend String: Extended information in JSON format.
id String: The provider-assigned unique ID for this managed resource.
isNoExpired Boolean: Whether the instance never expires.
isolateAt String: Isolation time.
networks List<VdbInstanceNetwork>: Network information.
nodes List<VdbInstanceNode>: Instance node list.
product String: Product.
region String: Region.
shardNum Double: Shard number.
status String: Instance status.
taskStatus Double: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
wanAddress String: Public network address.
zone String: Availability zone.

apiVersion string: API version.
createdAt string: Creation time.
engineName string: Engine name.
engineVersion string: Engine version.
expiredAt string: Expiration time.
extend string: Extended information in JSON format.
id string: The provider-assigned unique ID for this managed resource.
isNoExpired boolean: Whether the instance never expires.
isolateAt string: Isolation time.
networks VdbInstanceNetwork[]: Network information.
nodes VdbInstanceNode[]: Instance node list.
product string: Product.
region string: Region.
shardNum number: Shard number.
status string: Instance status.
taskStatus number: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
wanAddress string: Public network address.
zone string: Availability zone.

api_version str: API version.
created_at str: Creation time.
engine_name str: Engine name.
engine_version str: Engine version.
expired_at str: Expiration time.
extend str: Extended information in JSON format.
id str: The provider-assigned unique ID for this managed resource.
is_no_expired bool: Whether the instance never expires.
isolate_at str: Isolation time.
networks Sequence[VdbInstanceNetwork]: Network information.
nodes Sequence[VdbInstanceNode]: Instance node list.
product str: Product.
region str: Region.
shard_num float: Shard number.
status str: Instance status.
task_status float: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
wan_address str: Public network address.
zone str: Availability zone.

apiVersion String: API version.
createdAt String: Creation time.
engineName String: Engine name.
engineVersion String: Engine version.
expiredAt String: Expiration time.
extend String: Extended information in JSON format.
id String: The provider-assigned unique ID for this managed resource.
isNoExpired Boolean: Whether the instance never expires.
isolateAt String: Isolation time.
networks List<Property Map>: Network information.
nodes List<Property Map>: Instance node list.
product String: Product.
region String: Region.
shardNum Number: Shard number.
status String: Instance status.
taskStatus Number: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
wanAddress String: Public network address.
zone String: Availability zone.

Look up Existing VdbInstance Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_version: Optional[str] = None,
        auto_renew: Optional[float] = None,
        cpu: Optional[float] = None,
        created_at: Optional[str] = None,
        disk_size: Optional[float] = None,
        engine_name: Optional[str] = None,
        engine_version: Optional[str] = None,
        expired_at: Optional[str] = None,
        extend: Optional[str] = None,
        force_delete: Optional[bool] = None,
        instance_name: Optional[str] = None,
        instance_type: Optional[str] = None,
        is_no_expired: Optional[bool] = None,
        isolate_at: Optional[str] = None,
        memory: Optional[float] = None,
        mode: Optional[str] = None,
        networks: Optional[Sequence[VdbInstanceNetworkArgs]] = None,
        node_type: Optional[str] = None,
        nodes: Optional[Sequence[VdbInstanceNodeArgs]] = None,
        params: Optional[str] = None,
        pay_mode: Optional[float] = None,
        pay_period: Optional[float] = None,
        product: Optional[str] = None,
        product_type: Optional[float] = None,
        region: Optional[str] = None,
        resource_tags: Optional[Sequence[VdbInstanceResourceTagArgs]] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        shard_num: Optional[float] = None,
        status: Optional[str] = None,
        subnet_id: Optional[str] = None,
        task_status: Optional[float] = None,
        timeouts: Optional[VdbInstanceTimeoutsArgs] = None,
        vdb_instance_id: Optional[str] = None,
        vpc_id: Optional[str] = None,
        wan_address: Optional[str] = None,
        worker_node_num: Optional[float] = None,
        zone: Optional[str] = None) -> VdbInstance

func GetVdbInstance(ctx *Context, name string, id IDInput, state *VdbInstanceState, opts ...ResourceOption) (*VdbInstance, error)

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

public static VdbInstance get(String name, Output<String> id, VdbInstanceState state, CustomResourceOptions options)

resources:  _:    type: tencentcloud:VdbInstance    get:      id: ${id}

import {
  to = tencentcloud_vdbinstance.example
  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:

ApiVersion string: API version.
AutoRenew double: Auto-renew flag. 0: disabled, 1: enabled.
Cpu double: CPU cores.
CreatedAt string: Creation time.
DiskSize double: Disk size in GB.
EngineName string: Engine name.
EngineVersion string: Engine version.
ExpiredAt string: Expiration time.
Extend string: Extended information in JSON format.
ForceDelete bool: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
InstanceName string: Instance name. Supports up to 60 characters.
InstanceType string: Instance type. Valid values: base, single, cluster.
IsNoExpired bool: Whether the instance never expires.
IsolateAt string: Isolation time.
Memory double: Memory size in GB.
Mode string: Availability zone mode for cluster type. Valid values: two, three.
Networks List<VdbInstanceNetwork>: Network information.
NodeType string: Node type. Valid values: compute, normal, store.
Nodes List<VdbInstanceNode>: Instance node list.
Params string: Instance extra parameters, submitted via JSON.
PayMode double: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
PayPeriod double: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
Product string: Product.
ProductType double: Product version. 0: standard, 1: capacity-enhanced.
Region string: Region.
ResourceTags List<VdbInstanceResourceTag>: Tag list.
SecurityGroupIds List<string>: Security group IDs.
ShardNum double: Shard number.
Status string: Instance status.
SubnetId string: Subnet ID.
TaskStatus double: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
Timeouts VdbInstanceTimeouts
VdbInstanceId string: ID of the resource.
VpcId string: VPC ID.
WanAddress string: Public network address.
WorkerNodeNum double: Number of worker nodes.
Zone string: Availability zone.

ApiVersion string: API version.
AutoRenew float64: Auto-renew flag. 0: disabled, 1: enabled.
Cpu float64: CPU cores.
CreatedAt string: Creation time.
DiskSize float64: Disk size in GB.
EngineName string: Engine name.
EngineVersion string: Engine version.
ExpiredAt string: Expiration time.
Extend string: Extended information in JSON format.
ForceDelete bool: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
InstanceName string: Instance name. Supports up to 60 characters.
InstanceType string: Instance type. Valid values: base, single, cluster.
IsNoExpired bool: Whether the instance never expires.
IsolateAt string: Isolation time.
Memory float64: Memory size in GB.
Mode string: Availability zone mode for cluster type. Valid values: two, three.
Networks []VdbInstanceNetworkArgs: Network information.
NodeType string: Node type. Valid values: compute, normal, store.
Nodes []VdbInstanceNodeArgs: Instance node list.
Params string: Instance extra parameters, submitted via JSON.
PayMode float64: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
PayPeriod float64: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
Product string: Product.
ProductType float64: Product version. 0: standard, 1: capacity-enhanced.
Region string: Region.
ResourceTags []VdbInstanceResourceTagArgs: Tag list.
SecurityGroupIds []string: Security group IDs.
ShardNum float64: Shard number.
Status string: Instance status.
SubnetId string: Subnet ID.
TaskStatus float64: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
Timeouts VdbInstanceTimeoutsArgs
VdbInstanceId string: ID of the resource.
VpcId string: VPC ID.
WanAddress string: Public network address.
WorkerNodeNum float64: Number of worker nodes.
Zone string: Availability zone.

api_version string: API version.
auto_renew number: Auto-renew flag. 0: disabled, 1: enabled.
cpu number: CPU cores.
created_at string: Creation time.
disk_size number: Disk size in GB.
engine_name string: Engine name.
engine_version string: Engine version.
expired_at string: Expiration time.
extend string: Extended information in JSON format.
force_delete bool: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
instance_name string: Instance name. Supports up to 60 characters.
instance_type string: Instance type. Valid values: base, single, cluster.
is_no_expired bool: Whether the instance never expires.
isolate_at string: Isolation time.
memory number: Memory size in GB.
mode string: Availability zone mode for cluster type. Valid values: two, three.
networks list(object): Network information.
node_type string: Node type. Valid values: compute, normal, store.
nodes list(object): Instance node list.
params string: Instance extra parameters, submitted via JSON.
pay_mode number: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
pay_period number: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
product string: Product.
product_type number: Product version. 0: standard, 1: capacity-enhanced.
region string: Region.
resource_tags list(object): Tag list.
security_group_ids list(string): Security group IDs.
shard_num number: Shard number.
status string: Instance status.
subnet_id string: Subnet ID.
task_status number: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
timeouts object
vdb_instance_id string: ID of the resource.
vpc_id string: VPC ID.
wan_address string: Public network address.
worker_node_num number: Number of worker nodes.
zone string: Availability zone.

apiVersion String: API version.
autoRenew Double: Auto-renew flag. 0: disabled, 1: enabled.
cpu Double: CPU cores.
createdAt String: Creation time.
diskSize Double: Disk size in GB.
engineName String: Engine name.
engineVersion String: Engine version.
expiredAt String: Expiration time.
extend String: Extended information in JSON format.
forceDelete Boolean: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
instanceName String: Instance name. Supports up to 60 characters.
instanceType String: Instance type. Valid values: base, single, cluster.
isNoExpired Boolean: Whether the instance never expires.
isolateAt String: Isolation time.
memory Double: Memory size in GB.
mode String: Availability zone mode for cluster type. Valid values: two, three.
networks List<VdbInstanceNetwork>: Network information.
nodeType String: Node type. Valid values: compute, normal, store.
nodes List<VdbInstanceNode>: Instance node list.
params String: Instance extra parameters, submitted via JSON.
payMode Double: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
payPeriod Double: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
product String: Product.
productType Double: Product version. 0: standard, 1: capacity-enhanced.
region String: Region.
resourceTags List<VdbInstanceResourceTag>: Tag list.
securityGroupIds List<String>: Security group IDs.
shardNum Double: Shard number.
status String: Instance status.
subnetId String: Subnet ID.
taskStatus Double: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
timeouts VdbInstanceTimeouts
vdbInstanceId String: ID of the resource.
vpcId String: VPC ID.
wanAddress String: Public network address.
workerNodeNum Double: Number of worker nodes.
zone String: Availability zone.

apiVersion string: API version.
autoRenew number: Auto-renew flag. 0: disabled, 1: enabled.
cpu number: CPU cores.
createdAt string: Creation time.
diskSize number: Disk size in GB.
engineName string: Engine name.
engineVersion string: Engine version.
expiredAt string: Expiration time.
extend string: Extended information in JSON format.
forceDelete boolean: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
instanceName string: Instance name. Supports up to 60 characters.
instanceType string: Instance type. Valid values: base, single, cluster.
isNoExpired boolean: Whether the instance never expires.
isolateAt string: Isolation time.
memory number: Memory size in GB.
mode string: Availability zone mode for cluster type. Valid values: two, three.
networks VdbInstanceNetwork[]: Network information.
nodeType string: Node type. Valid values: compute, normal, store.
nodes VdbInstanceNode[]: Instance node list.
params string: Instance extra parameters, submitted via JSON.
payMode number: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
payPeriod number: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
product string: Product.
productType number: Product version. 0: standard, 1: capacity-enhanced.
region string: Region.
resourceTags VdbInstanceResourceTag[]: Tag list.
securityGroupIds string[]: Security group IDs.
shardNum number: Shard number.
status string: Instance status.
subnetId string: Subnet ID.
taskStatus number: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
timeouts VdbInstanceTimeouts
vdbInstanceId string: ID of the resource.
vpcId string: VPC ID.
wanAddress string: Public network address.
workerNodeNum number: Number of worker nodes.
zone string: Availability zone.

api_version str: API version.
auto_renew float: Auto-renew flag. 0: disabled, 1: enabled.
cpu float: CPU cores.
created_at str: Creation time.
disk_size float: Disk size in GB.
engine_name str: Engine name.
engine_version str: Engine version.
expired_at str: Expiration time.
extend str: Extended information in JSON format.
force_delete bool: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
instance_name str: Instance name. Supports up to 60 characters.
instance_type str: Instance type. Valid values: base, single, cluster.
is_no_expired bool: Whether the instance never expires.
isolate_at str: Isolation time.
memory float: Memory size in GB.
mode str: Availability zone mode for cluster type. Valid values: two, three.
networks Sequence[VdbInstanceNetworkArgs]: Network information.
node_type str: Node type. Valid values: compute, normal, store.
nodes Sequence[VdbInstanceNodeArgs]: Instance node list.
params str: Instance extra parameters, submitted via JSON.
pay_mode float: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
pay_period float: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
product str: Product.
product_type float: Product version. 0: standard, 1: capacity-enhanced.
region str: Region.
resource_tags Sequence[VdbInstanceResourceTagArgs]: Tag list.
security_group_ids Sequence[str]: Security group IDs.
shard_num float: Shard number.
status str: Instance status.
subnet_id str: Subnet ID.
task_status float: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
timeouts VdbInstanceTimeoutsArgs
vdb_instance_id str: ID of the resource.
vpc_id str: VPC ID.
wan_address str: Public network address.
worker_node_num float: Number of worker nodes.
zone str: Availability zone.

apiVersion String: API version.
autoRenew Number: Auto-renew flag. 0: disabled, 1: enabled.
cpu Number: CPU cores.
createdAt String: Creation time.
diskSize Number: Disk size in GB.
engineName String: Engine name.
engineVersion String: Engine version.
expiredAt String: Expiration time.
extend String: Extended information in JSON format.
forceDelete Boolean: Whether to force delete (destroy) the instance. If false, only isolate to recycle bin. If true, isolate then destroy. Default is false.
instanceName String: Instance name. Supports up to 60 characters.
instanceType String: Instance type. Valid values: base, single, cluster.
isNoExpired Boolean: Whether the instance never expires.
isolateAt String: Isolation time.
memory Number: Memory size in GB.
mode String: Availability zone mode for cluster type. Valid values: two, three.
networks List<Property Map>: Network information.
nodeType String: Node type. Valid values: compute, normal, store.
nodes List<Property Map>: Instance node list.
params String: Instance extra parameters, submitted via JSON.
payMode Number: Billing mode. 0: pay-as-you-go, 1: monthly subscription.
payPeriod Number: Monthly subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default is 1.
product String: Product.
productType Number: Product version. 0: standard, 1: capacity-enhanced.
region String: Region.
resourceTags List<Property Map>: Tag list.
securityGroupIds List<String>: Security group IDs.
shardNum Number: Shard number.
status String: Instance status.
subnetId String: Subnet ID.
taskStatus Number: Task status. 0: no task, 1: pending, 2-11: various operations in progress.
timeouts Property Map
vdbInstanceId String: ID of the resource.
vpcId String: VPC ID.
wanAddress String: Public network address.
workerNodeNum Number: Number of worker nodes.
zone String: Availability zone.

Supporting Types

VdbInstanceNetwork, VdbInstanceNetworkArgs

ExpireTime string: Old IP expiration time.
Port double: Internal port.
PreserveDuration double: Old IP preservation duration in days.
SubnetId string: Subnet ID.
Vip string: Internal IP.
VpcId string: VPC ID.

ExpireTime string: Old IP expiration time.
Port float64: Internal port.
PreserveDuration float64: Old IP preservation duration in days.
SubnetId string: Subnet ID.
Vip string: Internal IP.
VpcId string: VPC ID.

expire_time string: Old IP expiration time.
port number: Internal port.
preserve_duration number: Old IP preservation duration in days.
subnet_id string: Subnet ID.
vip string: Internal IP.
vpc_id string: VPC ID.

expireTime String: Old IP expiration time.
port Double: Internal port.
preserveDuration Double: Old IP preservation duration in days.
subnetId String: Subnet ID.
vip String: Internal IP.
vpcId String: VPC ID.

expireTime string: Old IP expiration time.
port number: Internal port.
preserveDuration number: Old IP preservation duration in days.
subnetId string: Subnet ID.
vip string: Internal IP.
vpcId string: VPC ID.

expire_time str: Old IP expiration time.
port float: Internal port.
preserve_duration float: Old IP preservation duration in days.
subnet_id str: Subnet ID.
vip str: Internal IP.
vpc_id str: VPC ID.

expireTime String: Old IP expiration time.
port Number: Internal port.
preserveDuration Number: Old IP preservation duration in days.
subnetId String: Subnet ID.
vip String: Internal IP.
vpcId String: VPC ID.

VdbInstanceNode, VdbInstanceNodeArgs

Name string: Pod name.
Status string: Instance status.

Name string: Pod name.
Status string: Instance status.

name string: Pod name.
status string: Instance status.

name String: Pod name.
status String: Instance status.

name string: Pod name.
status string: Instance status.

name str: Pod name.
status str: Instance status.

name String: Pod name.
status String: Instance status.

VdbInstanceResourceTag, VdbInstanceResourceTagArgs

TagKey string: Tag key.
TagValue string: Tag value.

TagKey string: Tag key.
TagValue string: Tag value.

tag_key string: Tag key.
tag_value string: Tag value.

tagKey String: Tag key.
tagValue String: Tag value.

tagKey string: Tag key.
tagValue string: Tag value.

tag_key str: Tag key.
tag_value str: Tag value.

tagKey String: Tag key.
tagValue String: Tag value.

VdbInstanceTimeouts, VdbInstanceTimeoutsArgs

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 string
delete string
update string

create str
delete str
update str

create String
delete String
update String

Import

VDB instance can be imported using the id, e.g.

$ pulumi import tencentcloud:index/vdbInstance:VdbInstance example vdb-xxxxxxxx

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

Package Details

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

Viewing docs for tencentcloud 1.82.93
published on Monday, May 11, 2026 by tencentcloudstack

Schema (JSON)

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.VdbInstance

On this page

On this page

Example Usage

Create a pay-as-you-go single instance

Create a monthly subscription cluster instance with all parameters

Create VdbInstance Resource

Constructor syntax

Parameters

VdbInstance Resource Properties

Inputs

Outputs

Look up Existing VdbInstance Resource

Supporting Types

VdbInstanceNetwork, VdbInstanceNetworkArgs

VdbInstanceNode, VdbInstanceNodeArgs

VdbInstanceResourceTag, VdbInstanceResourceTagArgs

VdbInstanceTimeouts, VdbInstanceTimeoutsArgs

Import

Package Details

On this page

On this page