Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. rds_v2
  5. RdsInstanceV2
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.rds_v2.RdsInstanceV2

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Provides a resource to manage rds instance v2

Example Usage

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

const fooZones = volcengine.ecs.Zones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    vpcId: fooVpc.id,
});
const fooRdsInstanceV2 = new volcengine.rds_v2.RdsInstanceV2("fooRdsInstanceV2", {
    dbEngineVersion: "MySQL_5_7",
    nodeInfos: [
        {
            nodeType: "Primary",
            nodeSpec: "rds.mysql.2c4g",
            zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
        },
        {
            nodeType: "Secondary",
            nodeSpec: "rds.mysql.2c4g",
            zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
        },
    ],
    storageType: "LocalSSD",
    storageSpace: 100,
    vpcId: fooVpc.id,
    subnetId: fooSubnet.id,
    instanceName: "tf-test-v2",
    lowerCaseTableNames: "1",
    chargeInfo: {
        chargeType: "PostPaid",
    },
});
Copy
import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[0].id,
    vpc_id=foo_vpc.id)
foo_rds_instance_v2 = volcengine.rds_v2.RdsInstanceV2("fooRdsInstanceV2",
    db_engine_version="MySQL_5_7",
    node_infos=[
        volcengine.rds_v2.RdsInstanceV2NodeInfoArgs(
            node_type="Primary",
            node_spec="rds.mysql.2c4g",
            zone_id=foo_zones.zones[0].id,
        ),
        volcengine.rds_v2.RdsInstanceV2NodeInfoArgs(
            node_type="Secondary",
            node_spec="rds.mysql.2c4g",
            zone_id=foo_zones.zones[0].id,
        ),
    ],
    storage_type="LocalSSD",
    storage_space=100,
    vpc_id=foo_vpc.id,
    subnet_id=foo_subnet.id,
    instance_name="tf-test-v2",
    lower_case_table_names="1",
    charge_info=volcengine.rds_v2.RdsInstanceV2ChargeInfoArgs(
        charge_type="PostPaid",
    ))
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds_v2"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.Zones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		_, err = rds_v2.NewRdsInstanceV2(ctx, "fooRdsInstanceV2", &rds_v2.RdsInstanceV2Args{
			DbEngineVersion: pulumi.String("MySQL_5_7"),
			NodeInfos: rds_v2.RdsInstanceV2NodeInfoArray{
				&rds_v2.RdsInstanceV2NodeInfoArgs{
					NodeType: pulumi.String("Primary"),
					NodeSpec: pulumi.String("rds.mysql.2c4g"),
					ZoneId:   pulumi.String(fooZones.Zones[0].Id),
				},
				&rds_v2.RdsInstanceV2NodeInfoArgs{
					NodeType: pulumi.String("Secondary"),
					NodeSpec: pulumi.String("rds.mysql.2c4g"),
					ZoneId:   pulumi.String(fooZones.Zones[0].Id),
				},
			},
			StorageType:         pulumi.String("LocalSSD"),
			StorageSpace:        pulumi.Int(100),
			VpcId:               fooVpc.ID(),
			SubnetId:            fooSubnet.ID(),
			InstanceName:        pulumi.String("tf-test-v2"),
			LowerCaseTableNames: pulumi.String("1"),
			ChargeInfo: &rds_v2.RdsInstanceV2ChargeInfoArgs{
				ChargeType: pulumi.String("PostPaid"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.Zones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooRdsInstanceV2 = new Volcengine.Rds_v2.RdsInstanceV2("fooRdsInstanceV2", new()
    {
        DbEngineVersion = "MySQL_5_7",
        NodeInfos = new[]
        {
            new Volcengine.Rds_v2.Inputs.RdsInstanceV2NodeInfoArgs
            {
                NodeType = "Primary",
                NodeSpec = "rds.mysql.2c4g",
                ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
            },
            new Volcengine.Rds_v2.Inputs.RdsInstanceV2NodeInfoArgs
            {
                NodeType = "Secondary",
                NodeSpec = "rds.mysql.2c4g",
                ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
            },
        },
        StorageType = "LocalSSD",
        StorageSpace = 100,
        VpcId = fooVpc.Id,
        SubnetId = fooSubnet.Id,
        InstanceName = "tf-test-v2",
        LowerCaseTableNames = "1",
        ChargeInfo = new Volcengine.Rds_v2.Inputs.RdsInstanceV2ChargeInfoArgs
        {
            ChargeType = "PostPaid",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.rds_v2.RdsInstanceV2;
import com.pulumi.volcengine.rds_v2.RdsInstanceV2Args;
import com.pulumi.volcengine.rds_v2.inputs.RdsInstanceV2NodeInfoArgs;
import com.pulumi.volcengine.rds_v2.inputs.RdsInstanceV2ChargeInfoArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var fooZones = EcsFunctions.Zones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooRdsInstanceV2 = new RdsInstanceV2("fooRdsInstanceV2", RdsInstanceV2Args.builder()        
            .dbEngineVersion("MySQL_5_7")
            .nodeInfos(            
                RdsInstanceV2NodeInfoArgs.builder()
                    .nodeType("Primary")
                    .nodeSpec("rds.mysql.2c4g")
                    .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
                    .build(),
                RdsInstanceV2NodeInfoArgs.builder()
                    .nodeType("Secondary")
                    .nodeSpec("rds.mysql.2c4g")
                    .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
                    .build())
            .storageType("LocalSSD")
            .storageSpace(100)
            .vpcId(fooVpc.id())
            .subnetId(fooSubnet.id())
            .instanceName("tf-test-v2")
            .lowerCaseTableNames("1")
            .chargeInfo(RdsInstanceV2ChargeInfoArgs.builder()
                .chargeType("PostPaid")
                .build())
            .build());

    }
}
Copy
resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${fooZones.zones[0].id}
      vpcId: ${fooVpc.id}
  fooRdsInstanceV2:
    type: volcengine:rds_v2:RdsInstanceV2
    properties:
      dbEngineVersion: MySQL_5_7
      nodeInfos:
        - nodeType: Primary
          nodeSpec: rds.mysql.2c4g
          zoneId: ${fooZones.zones[0].id}
        - nodeType: Secondary
          nodeSpec: rds.mysql.2c4g
          zoneId: ${fooZones.zones[0].id}
      storageType: LocalSSD
      storageSpace: 100
      vpcId: ${fooVpc.id}
      subnetId: ${fooSubnet.id}
      instanceName: tf-test-v2
      lowerCaseTableNames: '1'
      chargeInfo:
        chargeType: PostPaid
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:Zones
      Arguments: {}
Copy

Create RdsInstanceV2 Resource

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

Constructor syntax

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

@overload
def RdsInstanceV2(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  charge_info: Optional[RdsInstanceV2ChargeInfoArgs] = None,
                  db_engine_version: Optional[str] = None,
                  vpc_id: Optional[str] = None,
                  subnet_id: Optional[str] = None,
                  storage_type: Optional[str] = None,
                  node_infos: Optional[Sequence[RdsInstanceV2NodeInfoArgs]] = None,
                  lower_case_table_names: Optional[str] = None,
                  instance_type: Optional[str] = None,
                  project_name: Optional[str] = None,
                  storage_space: Optional[int] = None,
                  instance_name: Optional[str] = None,
                  db_time_zone: Optional[str] = None,
                  db_param_group_id: Optional[str] = None)
func NewRdsInstanceV2(ctx *Context, name string, args RdsInstanceV2Args, opts ...ResourceOption) (*RdsInstanceV2, error)
public RdsInstanceV2(string name, RdsInstanceV2Args args, CustomResourceOptions? opts = null)
public RdsInstanceV2(String name, RdsInstanceV2Args args)
public RdsInstanceV2(String name, RdsInstanceV2Args args, CustomResourceOptions options)

type: volcengine:rds_v2:RdsInstanceV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RdsInstanceV2Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RdsInstanceV2Args
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RdsInstanceV2Args
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RdsInstanceV2Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RdsInstanceV2Args
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 rdsInstanceV2Resource = new Volcengine.Rds_v2.RdsInstanceV2("rdsInstanceV2Resource", new()
{
    ChargeInfo = new Volcengine.Rds_v2.Inputs.RdsInstanceV2ChargeInfoArgs
    {
        ChargeType = "string",
        AutoRenew = false,
        Period = 0,
        PeriodUnit = "string",
    },
    DbEngineVersion = "string",
    VpcId = "string",
    SubnetId = "string",
    StorageType = "string",
    NodeInfos = new[]
    {
        new Volcengine.Rds_v2.Inputs.RdsInstanceV2NodeInfoArgs
        {
            NodeSpec = "string",
            NodeType = "string",
            ZoneId = "string",
            NodeId = "string",
        },
    },
    LowerCaseTableNames = "string",
    ProjectName = "string",
    StorageSpace = 0,
    InstanceName = "string",
    DbTimeZone = "string",
    DbParamGroupId = "string",
});
Copy
example, err := rds_v2.NewRdsInstanceV2(ctx, "rdsInstanceV2Resource", &rds_v2.RdsInstanceV2Args{
	ChargeInfo: &rds_v2.RdsInstanceV2ChargeInfoArgs{
		ChargeType: pulumi.String("string"),
		AutoRenew:  pulumi.Bool(false),
		Period:     pulumi.Int(0),
		PeriodUnit: pulumi.String("string"),
	},
	DbEngineVersion: pulumi.String("string"),
	VpcId:           pulumi.String("string"),
	SubnetId:        pulumi.String("string"),
	StorageType:     pulumi.String("string"),
	NodeInfos: rds_v2.RdsInstanceV2NodeInfoArray{
		&rds_v2.RdsInstanceV2NodeInfoArgs{
			NodeSpec: pulumi.String("string"),
			NodeType: pulumi.String("string"),
			ZoneId:   pulumi.String("string"),
			NodeId:   pulumi.String("string"),
		},
	},
	LowerCaseTableNames: pulumi.String("string"),
	ProjectName:         pulumi.String("string"),
	StorageSpace:        pulumi.Int(0),
	InstanceName:        pulumi.String("string"),
	DbTimeZone:          pulumi.String("string"),
	DbParamGroupId:      pulumi.String("string"),
})
Copy
var rdsInstanceV2Resource = new RdsInstanceV2("rdsInstanceV2Resource", RdsInstanceV2Args.builder()
    .chargeInfo(RdsInstanceV2ChargeInfoArgs.builder()
        .chargeType("string")
        .autoRenew(false)
        .period(0)
        .periodUnit("string")
        .build())
    .dbEngineVersion("string")
    .vpcId("string")
    .subnetId("string")
    .storageType("string")
    .nodeInfos(RdsInstanceV2NodeInfoArgs.builder()
        .nodeSpec("string")
        .nodeType("string")
        .zoneId("string")
        .nodeId("string")
        .build())
    .lowerCaseTableNames("string")
    .projectName("string")
    .storageSpace(0)
    .instanceName("string")
    .dbTimeZone("string")
    .dbParamGroupId("string")
    .build());
Copy
rds_instance_v2_resource = volcengine.rds_v2.RdsInstanceV2("rdsInstanceV2Resource",
    charge_info={
        "charge_type": "string",
        "auto_renew": False,
        "period": 0,
        "period_unit": "string",
    },
    db_engine_version="string",
    vpc_id="string",
    subnet_id="string",
    storage_type="string",
    node_infos=[{
        "node_spec": "string",
        "node_type": "string",
        "zone_id": "string",
        "node_id": "string",
    }],
    lower_case_table_names="string",
    project_name="string",
    storage_space=0,
    instance_name="string",
    db_time_zone="string",
    db_param_group_id="string")
Copy
const rdsInstanceV2Resource = new volcengine.rds_v2.RdsInstanceV2("rdsInstanceV2Resource", {
    chargeInfo: {
        chargeType: "string",
        autoRenew: false,
        period: 0,
        periodUnit: "string",
    },
    dbEngineVersion: "string",
    vpcId: "string",
    subnetId: "string",
    storageType: "string",
    nodeInfos: [{
        nodeSpec: "string",
        nodeType: "string",
        zoneId: "string",
        nodeId: "string",
    }],
    lowerCaseTableNames: "string",
    projectName: "string",
    storageSpace: 0,
    instanceName: "string",
    dbTimeZone: "string",
    dbParamGroupId: "string",
});
Copy
type: volcengine:rds_v2:RdsInstanceV2
properties:
    chargeInfo:
        autoRenew: false
        chargeType: string
        period: 0
        periodUnit: string
    dbEngineVersion: string
    dbParamGroupId: string
    dbTimeZone: string
    instanceName: string
    lowerCaseTableNames: string
    nodeInfos:
        - nodeId: string
          nodeSpec: string
          nodeType: string
          zoneId: string
    projectName: string
    storageSpace: 0
    storageType: string
    subnetId: string
    vpcId: string
Copy

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

ChargeInfo
This property is required.
Changes to this property will trigger replacement.
RdsInstanceV2ChargeInfo
Payment methods.
DbEngineVersion
This property is required.
Changes to this property will trigger replacement.
string
Instance type. Value: MySQL_5_7 MySQL_8_0.
NodeInfos This property is required. List<RdsInstanceV2NodeInfo>
Instance specification configuration. This parameter is required for RDS for MySQL, RDS for PostgreSQL and MySQL Sharding. There is one and only one Primary node, one and only one Secondary node, and 0-10 Read-Only nodes.
StorageType This property is required. string
Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
SubnetId
This property is required.
Changes to this property will trigger replacement.
string
Subnet ID.
VpcId
This property is required.
Changes to this property will trigger replacement.
string
Private network (VPC) ID. You can call the DescribeVpcs query and use this parameter to specify the VPC where the instance is to be created.
DbParamGroupId Changes to this property will trigger replacement. string
Parameter template ID. It only takes effect when the database type is MySQL/PostgreSQL/SQL_Server. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
DbTimeZone Changes to this property will trigger replacement. string
Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
InstanceName Changes to this property will trigger replacement. string
Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
InstanceType string
The field instance_type is no longer support. The type of Instance.

Deprecated: The field instance_type is no longer support.

LowerCaseTableNames Changes to this property will trigger replacement. string
Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
ProjectName string
Subordinate to the project.
StorageSpace int
Instance storage space. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, value range: [20, 3000], unit: GB, increments every 100GB. When the database type is veDB_MySQL/veDB_PostgreSQL, this parameter does not need to be passed.
ChargeInfo
This property is required.
Changes to this property will trigger replacement.
RdsInstanceV2ChargeInfoArgs
Payment methods.
DbEngineVersion
This property is required.
Changes to this property will trigger replacement.
string
Instance type. Value: MySQL_5_7 MySQL_8_0.
NodeInfos This property is required. []RdsInstanceV2NodeInfoArgs
Instance specification configuration. This parameter is required for RDS for MySQL, RDS for PostgreSQL and MySQL Sharding. There is one and only one Primary node, one and only one Secondary node, and 0-10 Read-Only nodes.
StorageType This property is required. string
Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
SubnetId
This property is required.
Changes to this property will trigger replacement.
string
Subnet ID.
VpcId
This property is required.
Changes to this property will trigger replacement.
string
Private network (VPC) ID. You can call the DescribeVpcs query and use this parameter to specify the VPC where the instance is to be created.
DbParamGroupId Changes to this property will trigger replacement. string
Parameter template ID. It only takes effect when the database type is MySQL/PostgreSQL/SQL_Server. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
DbTimeZone Changes to this property will trigger replacement. string
Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
InstanceName Changes to this property will trigger replacement. string
Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
InstanceType string
The field instance_type is no longer support. The type of Instance.

Deprecated: The field instance_type is no longer support.

LowerCaseTableNames Changes to this property will trigger replacement. string
Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
ProjectName string
Subordinate to the project.
StorageSpace int
Instance storage space. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, value range: [20, 3000], unit: GB, increments every 100GB. When the database type is veDB_MySQL/veDB_PostgreSQL, this parameter does not need to be passed.
chargeInfo
This property is required.
Changes to this property will trigger replacement.
RdsInstanceV2ChargeInfo
Payment methods.
dbEngineVersion
This property is required.
Changes to this property will trigger replacement.
String
Instance type. Value: MySQL_5_7 MySQL_8_0.
nodeInfos This property is required. List<RdsInstanceV2NodeInfo>
Instance specification configuration. This parameter is required for RDS for MySQL, RDS for PostgreSQL and MySQL Sharding. There is one and only one Primary node, one and only one Secondary node, and 0-10 Read-Only nodes.
storageType This property is required. String
Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
subnetId
This property is required.
Changes to this property will trigger replacement.
String
Subnet ID.
vpcId
This property is required.
Changes to this property will trigger replacement.
String
Private network (VPC) ID. You can call the DescribeVpcs query and use this parameter to specify the VPC where the instance is to be created.
dbParamGroupId Changes to this property will trigger replacement. String
Parameter template ID. It only takes effect when the database type is MySQL/PostgreSQL/SQL_Server. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
dbTimeZone Changes to this property will trigger replacement. String
Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
instanceName Changes to this property will trigger replacement. String
Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
instanceType String
The field instance_type is no longer support. The type of Instance.

Deprecated: The field instance_type is no longer support.

lowerCaseTableNames Changes to this property will trigger replacement. String
Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
projectName String
Subordinate to the project.
storageSpace Integer
Instance storage space. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, value range: [20, 3000], unit: GB, increments every 100GB. When the database type is veDB_MySQL/veDB_PostgreSQL, this parameter does not need to be passed.
chargeInfo
This property is required.
Changes to this property will trigger replacement.
RdsInstanceV2ChargeInfo
Payment methods.
dbEngineVersion
This property is required.
Changes to this property will trigger replacement.
string
Instance type. Value: MySQL_5_7 MySQL_8_0.
nodeInfos This property is required. RdsInstanceV2NodeInfo[]
Instance specification configuration. This parameter is required for RDS for MySQL, RDS for PostgreSQL and MySQL Sharding. There is one and only one Primary node, one and only one Secondary node, and 0-10 Read-Only nodes.
storageType This property is required. string
Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
subnetId
This property is required.
Changes to this property will trigger replacement.
string
Subnet ID.
vpcId
This property is required.
Changes to this property will trigger replacement.
string
Private network (VPC) ID. You can call the DescribeVpcs query and use this parameter to specify the VPC where the instance is to be created.
dbParamGroupId Changes to this property will trigger replacement. string
Parameter template ID. It only takes effect when the database type is MySQL/PostgreSQL/SQL_Server. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
dbTimeZone Changes to this property will trigger replacement. string
Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
instanceName Changes to this property will trigger replacement. string
Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
instanceType string
The field instance_type is no longer support. The type of Instance.

Deprecated: The field instance_type is no longer support.

lowerCaseTableNames Changes to this property will trigger replacement. string
Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
projectName string
Subordinate to the project.
storageSpace number
Instance storage space. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, value range: [20, 3000], unit: GB, increments every 100GB. When the database type is veDB_MySQL/veDB_PostgreSQL, this parameter does not need to be passed.
charge_info
This property is required.
Changes to this property will trigger replacement.
RdsInstanceV2ChargeInfoArgs
Payment methods.
db_engine_version
This property is required.
Changes to this property will trigger replacement.
str
Instance type. Value: MySQL_5_7 MySQL_8_0.
node_infos This property is required. Sequence[RdsInstanceV2NodeInfoArgs]
Instance specification configuration. This parameter is required for RDS for MySQL, RDS for PostgreSQL and MySQL Sharding. There is one and only one Primary node, one and only one Secondary node, and 0-10 Read-Only nodes.
storage_type This property is required. str
Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
subnet_id
This property is required.
Changes to this property will trigger replacement.
str
Subnet ID.
vpc_id
This property is required.
Changes to this property will trigger replacement.
str
Private network (VPC) ID. You can call the DescribeVpcs query and use this parameter to specify the VPC where the instance is to be created.
db_param_group_id Changes to this property will trigger replacement. str
Parameter template ID. It only takes effect when the database type is MySQL/PostgreSQL/SQL_Server. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
db_time_zone Changes to this property will trigger replacement. str
Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
instance_name Changes to this property will trigger replacement. str
Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
instance_type str
The field instance_type is no longer support. The type of Instance.

Deprecated: The field instance_type is no longer support.

lower_case_table_names Changes to this property will trigger replacement. str
Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
project_name str
Subordinate to the project.
storage_space int
Instance storage space. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, value range: [20, 3000], unit: GB, increments every 100GB. When the database type is veDB_MySQL/veDB_PostgreSQL, this parameter does not need to be passed.
chargeInfo
This property is required.
Changes to this property will trigger replacement.
Property Map
Payment methods.
dbEngineVersion
This property is required.
Changes to this property will trigger replacement.
String
Instance type. Value: MySQL_5_7 MySQL_8_0.
nodeInfos This property is required. List<Property Map>
Instance specification configuration. This parameter is required for RDS for MySQL, RDS for PostgreSQL and MySQL Sharding. There is one and only one Primary node, one and only one Secondary node, and 0-10 Read-Only nodes.
storageType This property is required. String
Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
subnetId
This property is required.
Changes to this property will trigger replacement.
String
Subnet ID.
vpcId
This property is required.
Changes to this property will trigger replacement.
String
Private network (VPC) ID. You can call the DescribeVpcs query and use this parameter to specify the VPC where the instance is to be created.
dbParamGroupId Changes to this property will trigger replacement. String
Parameter template ID. It only takes effect when the database type is MySQL/PostgreSQL/SQL_Server. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
dbTimeZone Changes to this property will trigger replacement. String
Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
instanceName Changes to this property will trigger replacement. String
Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
instanceType String
The field instance_type is no longer support. The type of Instance.

Deprecated: The field instance_type is no longer support.

lowerCaseTableNames Changes to this property will trigger replacement. String
Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
projectName String
Subordinate to the project.
storageSpace Number
Instance storage space. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, value range: [20, 3000], unit: GB, increments every 100GB. When the database type is veDB_MySQL/veDB_PostgreSQL, this parameter does not need to be passed.

Outputs

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

ConnectionInfos List<RdsInstanceV2ConnectionInfo>
The connection info ot the RDS instance.
Id string
The provider-assigned unique ID for this managed resource.
ConnectionInfos []RdsInstanceV2ConnectionInfo
The connection info ot the RDS instance.
Id string
The provider-assigned unique ID for this managed resource.
connectionInfos List<RdsInstanceV2ConnectionInfo>
The connection info ot the RDS instance.
id String
The provider-assigned unique ID for this managed resource.
connectionInfos RdsInstanceV2ConnectionInfo[]
The connection info ot the RDS instance.
id string
The provider-assigned unique ID for this managed resource.
connection_infos Sequence[RdsInstanceV2ConnectionInfo]
The connection info ot the RDS instance.
id str
The provider-assigned unique ID for this managed resource.
connectionInfos List<Property Map>
The connection info ot the RDS instance.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing RdsInstanceV2 Resource

Get an existing RdsInstanceV2 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?: RdsInstanceV2State, opts?: CustomResourceOptions): RdsInstanceV2
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        charge_info: Optional[RdsInstanceV2ChargeInfoArgs] = None,
        connection_infos: Optional[Sequence[RdsInstanceV2ConnectionInfoArgs]] = None,
        db_engine_version: Optional[str] = None,
        db_param_group_id: Optional[str] = None,
        db_time_zone: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_type: Optional[str] = None,
        lower_case_table_names: Optional[str] = None,
        node_infos: Optional[Sequence[RdsInstanceV2NodeInfoArgs]] = None,
        project_name: Optional[str] = None,
        storage_space: Optional[int] = None,
        storage_type: Optional[str] = None,
        subnet_id: Optional[str] = None,
        vpc_id: Optional[str] = None) -> RdsInstanceV2
func GetRdsInstanceV2(ctx *Context, name string, id IDInput, state *RdsInstanceV2State, opts ...ResourceOption) (*RdsInstanceV2, error)
public static RdsInstanceV2 Get(string name, Input<string> id, RdsInstanceV2State? state, CustomResourceOptions? opts = null)
public static RdsInstanceV2 get(String name, Output<String> id, RdsInstanceV2State state, CustomResourceOptions options)
resources:  _:    type: volcengine:rds_v2:RdsInstanceV2    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ChargeInfo Changes to this property will trigger replacement. RdsInstanceV2ChargeInfo
Payment methods.
ConnectionInfos List<RdsInstanceV2ConnectionInfo>
The connection info ot the RDS instance.
DbEngineVersion Changes to this property will trigger replacement. string
Instance type. Value: MySQL_5_7 MySQL_8_0.
DbParamGroupId Changes to this property will trigger replacement. string
Parameter template ID. It only takes effect when the database type is MySQL/PostgreSQL/SQL_Server. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
DbTimeZone Changes to this property will trigger replacement. string
Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
InstanceName Changes to this property will trigger replacement. string
Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
InstanceType string
The field instance_type is no longer support. The type of Instance.

Deprecated: The field instance_type is no longer support.

LowerCaseTableNames Changes to this property will trigger replacement. string
Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
NodeInfos List<RdsInstanceV2NodeInfo>
Instance specification configuration. This parameter is required for RDS for MySQL, RDS for PostgreSQL and MySQL Sharding. There is one and only one Primary node, one and only one Secondary node, and 0-10 Read-Only nodes.
ProjectName string
Subordinate to the project.
StorageSpace int
Instance storage space. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, value range: [20, 3000], unit: GB, increments every 100GB. When the database type is veDB_MySQL/veDB_PostgreSQL, this parameter does not need to be passed.
StorageType string
Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
SubnetId Changes to this property will trigger replacement. string
Subnet ID.
VpcId Changes to this property will trigger replacement. string
Private network (VPC) ID. You can call the DescribeVpcs query and use this parameter to specify the VPC where the instance is to be created.
ChargeInfo Changes to this property will trigger replacement. RdsInstanceV2ChargeInfoArgs
Payment methods.
ConnectionInfos []RdsInstanceV2ConnectionInfoArgs
The connection info ot the RDS instance.
DbEngineVersion Changes to this property will trigger replacement. string
Instance type. Value: MySQL_5_7 MySQL_8_0.
DbParamGroupId Changes to this property will trigger replacement. string
Parameter template ID. It only takes effect when the database type is MySQL/PostgreSQL/SQL_Server. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
DbTimeZone Changes to this property will trigger replacement. string
Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
InstanceName Changes to this property will trigger replacement. string
Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
InstanceType string
The field instance_type is no longer support. The type of Instance.

Deprecated: The field instance_type is no longer support.

LowerCaseTableNames Changes to this property will trigger replacement. string
Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
NodeInfos []RdsInstanceV2NodeInfoArgs
Instance specification configuration. This parameter is required for RDS for MySQL, RDS for PostgreSQL and MySQL Sharding. There is one and only one Primary node, one and only one Secondary node, and 0-10 Read-Only nodes.
ProjectName string
Subordinate to the project.
StorageSpace int
Instance storage space. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, value range: [20, 3000], unit: GB, increments every 100GB. When the database type is veDB_MySQL/veDB_PostgreSQL, this parameter does not need to be passed.
StorageType string
Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
SubnetId Changes to this property will trigger replacement. string
Subnet ID.
VpcId Changes to this property will trigger replacement. string
Private network (VPC) ID. You can call the DescribeVpcs query and use this parameter to specify the VPC where the instance is to be created.
chargeInfo Changes to this property will trigger replacement. RdsInstanceV2ChargeInfo
Payment methods.
connectionInfos List<RdsInstanceV2ConnectionInfo>
The connection info ot the RDS instance.
dbEngineVersion Changes to this property will trigger replacement. String
Instance type. Value: MySQL_5_7 MySQL_8_0.
dbParamGroupId Changes to this property will trigger replacement. String
Parameter template ID. It only takes effect when the database type is MySQL/PostgreSQL/SQL_Server. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
dbTimeZone Changes to this property will trigger replacement. String
Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
instanceName Changes to this property will trigger replacement. String
Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
instanceType String
The field instance_type is no longer support. The type of Instance.

Deprecated: The field instance_type is no longer support.

lowerCaseTableNames Changes to this property will trigger replacement. String
Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
nodeInfos List<RdsInstanceV2NodeInfo>
Instance specification configuration. This parameter is required for RDS for MySQL, RDS for PostgreSQL and MySQL Sharding. There is one and only one Primary node, one and only one Secondary node, and 0-10 Read-Only nodes.
projectName String
Subordinate to the project.
storageSpace Integer
Instance storage space. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, value range: [20, 3000], unit: GB, increments every 100GB. When the database type is veDB_MySQL/veDB_PostgreSQL, this parameter does not need to be passed.
storageType String
Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
subnetId Changes to this property will trigger replacement. String
Subnet ID.
vpcId Changes to this property will trigger replacement. String
Private network (VPC) ID. You can call the DescribeVpcs query and use this parameter to specify the VPC where the instance is to be created.
chargeInfo Changes to this property will trigger replacement. RdsInstanceV2ChargeInfo
Payment methods.
connectionInfos RdsInstanceV2ConnectionInfo[]
The connection info ot the RDS instance.
dbEngineVersion Changes to this property will trigger replacement. string
Instance type. Value: MySQL_5_7 MySQL_8_0.
dbParamGroupId Changes to this property will trigger replacement. string
Parameter template ID. It only takes effect when the database type is MySQL/PostgreSQL/SQL_Server. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
dbTimeZone Changes to this property will trigger replacement. string
Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
instanceName Changes to this property will trigger replacement. string
Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
instanceType string
The field instance_type is no longer support. The type of Instance.

Deprecated: The field instance_type is no longer support.

lowerCaseTableNames Changes to this property will trigger replacement. string
Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
nodeInfos RdsInstanceV2NodeInfo[]
Instance specification configuration. This parameter is required for RDS for MySQL, RDS for PostgreSQL and MySQL Sharding. There is one and only one Primary node, one and only one Secondary node, and 0-10 Read-Only nodes.
projectName string
Subordinate to the project.
storageSpace number
Instance storage space. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, value range: [20, 3000], unit: GB, increments every 100GB. When the database type is veDB_MySQL/veDB_PostgreSQL, this parameter does not need to be passed.
storageType string
Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
subnetId Changes to this property will trigger replacement. string
Subnet ID.
vpcId Changes to this property will trigger replacement. string
Private network (VPC) ID. You can call the DescribeVpcs query and use this parameter to specify the VPC where the instance is to be created.
charge_info Changes to this property will trigger replacement. RdsInstanceV2ChargeInfoArgs
Payment methods.
connection_infos Sequence[RdsInstanceV2ConnectionInfoArgs]
The connection info ot the RDS instance.
db_engine_version Changes to this property will trigger replacement. str
Instance type. Value: MySQL_5_7 MySQL_8_0.
db_param_group_id Changes to this property will trigger replacement. str
Parameter template ID. It only takes effect when the database type is MySQL/PostgreSQL/SQL_Server. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
db_time_zone Changes to this property will trigger replacement. str
Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
instance_name Changes to this property will trigger replacement. str
Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
instance_type str
The field instance_type is no longer support. The type of Instance.

Deprecated: The field instance_type is no longer support.

lower_case_table_names Changes to this property will trigger replacement. str
Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
node_infos Sequence[RdsInstanceV2NodeInfoArgs]
Instance specification configuration. This parameter is required for RDS for MySQL, RDS for PostgreSQL and MySQL Sharding. There is one and only one Primary node, one and only one Secondary node, and 0-10 Read-Only nodes.
project_name str
Subordinate to the project.
storage_space int
Instance storage space. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, value range: [20, 3000], unit: GB, increments every 100GB. When the database type is veDB_MySQL/veDB_PostgreSQL, this parameter does not need to be passed.
storage_type str
Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
subnet_id Changes to this property will trigger replacement. str
Subnet ID.
vpc_id Changes to this property will trigger replacement. str
Private network (VPC) ID. You can call the DescribeVpcs query and use this parameter to specify the VPC where the instance is to be created.
chargeInfo Changes to this property will trigger replacement. Property Map
Payment methods.
connectionInfos List<Property Map>
The connection info ot the RDS instance.
dbEngineVersion Changes to this property will trigger replacement. String
Instance type. Value: MySQL_5_7 MySQL_8_0.
dbParamGroupId Changes to this property will trigger replacement. String
Parameter template ID. It only takes effect when the database type is MySQL/PostgreSQL/SQL_Server. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
dbTimeZone Changes to this property will trigger replacement. String
Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
instanceName Changes to this property will trigger replacement. String
Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
instanceType String
The field instance_type is no longer support. The type of Instance.

Deprecated: The field instance_type is no longer support.

lowerCaseTableNames Changes to this property will trigger replacement. String
Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
nodeInfos List<Property Map>
Instance specification configuration. This parameter is required for RDS for MySQL, RDS for PostgreSQL and MySQL Sharding. There is one and only one Primary node, one and only one Secondary node, and 0-10 Read-Only nodes.
projectName String
Subordinate to the project.
storageSpace Number
Instance storage space. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, value range: [20, 3000], unit: GB, increments every 100GB. When the database type is veDB_MySQL/veDB_PostgreSQL, this parameter does not need to be passed.
storageType String
Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
subnetId Changes to this property will trigger replacement. String
Subnet ID.
vpcId Changes to this property will trigger replacement. String
Private network (VPC) ID. You can call the DescribeVpcs query and use this parameter to specify the VPC where the instance is to be created.

Supporting Types

RdsInstanceV2ChargeInfo
, RdsInstanceV2ChargeInfoArgs

ChargeType
This property is required.
Changes to this property will trigger replacement.
string
Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
AutoRenew Changes to this property will trigger replacement. bool
Whether to automatically renew in prepaid scenarios.
Period Changes to this property will trigger replacement. int
Purchase duration in prepaid scenarios. Default: 1.
PeriodUnit Changes to this property will trigger replacement. string
The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
ChargeType
This property is required.
Changes to this property will trigger replacement.
string
Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
AutoRenew Changes to this property will trigger replacement. bool
Whether to automatically renew in prepaid scenarios.
Period Changes to this property will trigger replacement. int
Purchase duration in prepaid scenarios. Default: 1.
PeriodUnit Changes to this property will trigger replacement. string
The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
chargeType
This property is required.
Changes to this property will trigger replacement.
String
Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
autoRenew Changes to this property will trigger replacement. Boolean
Whether to automatically renew in prepaid scenarios.
period Changes to this property will trigger replacement. Integer
Purchase duration in prepaid scenarios. Default: 1.
periodUnit Changes to this property will trigger replacement. String
The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
chargeType
This property is required.
Changes to this property will trigger replacement.
string
Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
autoRenew Changes to this property will trigger replacement. boolean
Whether to automatically renew in prepaid scenarios.
period Changes to this property will trigger replacement. number
Purchase duration in prepaid scenarios. Default: 1.
periodUnit Changes to this property will trigger replacement. string
The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
charge_type
This property is required.
Changes to this property will trigger replacement.
str
Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
auto_renew Changes to this property will trigger replacement. bool
Whether to automatically renew in prepaid scenarios.
period Changes to this property will trigger replacement. int
Purchase duration in prepaid scenarios. Default: 1.
period_unit Changes to this property will trigger replacement. str
The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
chargeType
This property is required.
Changes to this property will trigger replacement.
String
Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
autoRenew Changes to this property will trigger replacement. Boolean
Whether to automatically renew in prepaid scenarios.
period Changes to this property will trigger replacement. Number
Purchase duration in prepaid scenarios. Default: 1.
periodUnit Changes to this property will trigger replacement. String
The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.

RdsInstanceV2ConnectionInfo
, RdsInstanceV2ConnectionInfoArgs

Addresses List<RdsInstanceV2ConnectionInfoAddress>
Address list.
AutoAddNewNodes string
When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
Description string
Address description.
EnableReadOnly string
Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
EnableReadWriteSplitting string
Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
EndpointId string
Instance connection terminal ID.
EndpointName string
The instance connection terminal name.
EndpointType string
Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
ReadOnlyNodeWeights List<RdsInstanceV2ConnectionInfoReadOnlyNodeWeight>
The list of nodes configured by the connection terminal and the corresponding read-only weights.
ReadWriteMode string
Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
Addresses []RdsInstanceV2ConnectionInfoAddress
Address list.
AutoAddNewNodes string
When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
Description string
Address description.
EnableReadOnly string
Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
EnableReadWriteSplitting string
Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
EndpointId string
Instance connection terminal ID.
EndpointName string
The instance connection terminal name.
EndpointType string
Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
ReadOnlyNodeWeights []RdsInstanceV2ConnectionInfoReadOnlyNodeWeight
The list of nodes configured by the connection terminal and the corresponding read-only weights.
ReadWriteMode string
Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
addresses List<RdsInstanceV2ConnectionInfoAddress>
Address list.
autoAddNewNodes String
When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
description String
Address description.
enableReadOnly String
Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
enableReadWriteSplitting String
Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
endpointId String
Instance connection terminal ID.
endpointName String
The instance connection terminal name.
endpointType String
Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
readOnlyNodeWeights List<RdsInstanceV2ConnectionInfoReadOnlyNodeWeight>
The list of nodes configured by the connection terminal and the corresponding read-only weights.
readWriteMode String
Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
addresses RdsInstanceV2ConnectionInfoAddress[]
Address list.
autoAddNewNodes string
When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
description string
Address description.
enableReadOnly string
Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
enableReadWriteSplitting string
Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
endpointId string
Instance connection terminal ID.
endpointName string
The instance connection terminal name.
endpointType string
Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
readOnlyNodeWeights RdsInstanceV2ConnectionInfoReadOnlyNodeWeight[]
The list of nodes configured by the connection terminal and the corresponding read-only weights.
readWriteMode string
Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
addresses Sequence[RdsInstanceV2ConnectionInfoAddress]
Address list.
auto_add_new_nodes str
When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
description str
Address description.
enable_read_only str
Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
enable_read_write_splitting str
Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
endpoint_id str
Instance connection terminal ID.
endpoint_name str
The instance connection terminal name.
endpoint_type str
Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
read_only_node_weights Sequence[RdsInstanceV2ConnectionInfoReadOnlyNodeWeight]
The list of nodes configured by the connection terminal and the corresponding read-only weights.
read_write_mode str
Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
addresses List<Property Map>
Address list.
autoAddNewNodes String
When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
description String
Address description.
enableReadOnly String
Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
enableReadWriteSplitting String
Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
endpointId String
Instance connection terminal ID.
endpointName String
The instance connection terminal name.
endpointType String
Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
readOnlyNodeWeights List<Property Map>
The list of nodes configured by the connection terminal and the corresponding read-only weights.
readWriteMode String
Read and write mode: ReadWrite: read and write ReadOnly: read only (default).

RdsInstanceV2ConnectionInfoAddress
, RdsInstanceV2ConnectionInfoAddressArgs

Domain string
Connect domain name.
EipId string
The ID of the EIP, only valid for Public addresses.
IpAddress string
The IP Address.
NetworkType string
Network address type, temporarily Private, Public, PublicService.
Port string
The Port.
SubnetId string
Subnet ID.
Domain string
Connect domain name.
EipId string
The ID of the EIP, only valid for Public addresses.
IpAddress string
The IP Address.
NetworkType string
Network address type, temporarily Private, Public, PublicService.
Port string
The Port.
SubnetId string
Subnet ID.
domain String
Connect domain name.
eipId String
The ID of the EIP, only valid for Public addresses.
ipAddress String
The IP Address.
networkType String
Network address type, temporarily Private, Public, PublicService.
port String
The Port.
subnetId String
Subnet ID.
domain string
Connect domain name.
eipId string
The ID of the EIP, only valid for Public addresses.
ipAddress string
The IP Address.
networkType string
Network address type, temporarily Private, Public, PublicService.
port string
The Port.
subnetId string
Subnet ID.
domain str
Connect domain name.
eip_id str
The ID of the EIP, only valid for Public addresses.
ip_address str
The IP Address.
network_type str
Network address type, temporarily Private, Public, PublicService.
port str
The Port.
subnet_id str
Subnet ID.
domain String
Connect domain name.
eipId String
The ID of the EIP, only valid for Public addresses.
ipAddress String
The IP Address.
networkType String
Network address type, temporarily Private, Public, PublicService.
port String
The Port.
subnetId String
Subnet ID.

RdsInstanceV2ConnectionInfoReadOnlyNodeWeight
, RdsInstanceV2ConnectionInfoReadOnlyNodeWeightArgs

NodeId string
The ID of the node.
NodeType string
The type of the node.
Weight int
The weight of the node.
NodeId string
The ID of the node.
NodeType string
The type of the node.
Weight int
The weight of the node.
nodeId String
The ID of the node.
nodeType String
The type of the node.
weight Integer
The weight of the node.
nodeId string
The ID of the node.
nodeType string
The type of the node.
weight number
The weight of the node.
node_id str
The ID of the node.
node_type str
The type of the node.
weight int
The weight of the node.
nodeId String
The ID of the node.
nodeType String
The type of the node.
weight Number
The weight of the node.

RdsInstanceV2NodeInfo
, RdsInstanceV2NodeInfoArgs

NodeSpec This property is required. string
Masternode specs. Pass DescribeDBInstanceSpecs Query the instance specifications that can be sold.
NodeType This property is required. string
Node type, the value is "Primary", "Secondary", "ReadOnly".
ZoneId This property is required. string
Zone ID.
NodeId string
The ID of the node.
NodeSpec This property is required. string
Masternode specs. Pass DescribeDBInstanceSpecs Query the instance specifications that can be sold.
NodeType This property is required. string
Node type, the value is "Primary", "Secondary", "ReadOnly".
ZoneId This property is required. string
Zone ID.
NodeId string
The ID of the node.
nodeSpec This property is required. String
Masternode specs. Pass DescribeDBInstanceSpecs Query the instance specifications that can be sold.
nodeType This property is required. String
Node type, the value is "Primary", "Secondary", "ReadOnly".
zoneId This property is required. String
Zone ID.
nodeId String
The ID of the node.
nodeSpec This property is required. string
Masternode specs. Pass DescribeDBInstanceSpecs Query the instance specifications that can be sold.
nodeType This property is required. string
Node type, the value is "Primary", "Secondary", "ReadOnly".
zoneId This property is required. string
Zone ID.
nodeId string
The ID of the node.
node_spec This property is required. str
Masternode specs. Pass DescribeDBInstanceSpecs Query the instance specifications that can be sold.
node_type This property is required. str
Node type, the value is "Primary", "Secondary", "ReadOnly".
zone_id This property is required. str
Zone ID.
node_id str
The ID of the node.
nodeSpec This property is required. String
Masternode specs. Pass DescribeDBInstanceSpecs Query the instance specifications that can be sold.
nodeType This property is required. String
Node type, the value is "Primary", "Secondary", "ReadOnly".
zoneId This property is required. String
Zone ID.
nodeId String
The ID of the node.

Import

RDS Instance can be imported using the id, e.g.

$ pulumi import volcengine:rds_v2/rdsInstanceV2:RdsInstanceV2 default mysql-42b38c769c4b
Copy

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

Package Details

Repository
volcengine volcengine/pulumi-volcengine
License
Apache-2.0
Notes
This Pulumi package is based on the volcengine Terraform Provider.
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine