1. Packages
  2. Volcengine
  3. API Docs
  4. rds
  5. Instance
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine

volcengine.rds.Instance

Explore with Pulumi AI

Example Usage

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

const foo = new volcengine.rds.Instance("foo", {
    chargeType: "PostPaid",
    dbEngine: "MySQL",
    dbEngineVersion: "MySQL_Community_5_7",
    instanceName: "tf-test",
    instanceSpecName: "rds.mysql.1c2g",
    instanceType: "HA",
    region: "cn-north-4",
    storageSpaceGb: 100,
    storageType: "LocalSSD",
    subnetId: "subnet-1g0d4fkh1nabk8ibuxx1jtvss",
    vpcId: "vpc-3cj17x7u9bzeo6c6rrtzfpaeb",
    zone: "cn-langfang-b",
});
Copy
import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.rds.Instance("foo",
    charge_type="PostPaid",
    db_engine="MySQL",
    db_engine_version="MySQL_Community_5_7",
    instance_name="tf-test",
    instance_spec_name="rds.mysql.1c2g",
    instance_type="HA",
    region="cn-north-4",
    storage_space_gb=100,
    storage_type="LocalSSD",
    subnet_id="subnet-1g0d4fkh1nabk8ibuxx1jtvss",
    vpc_id="vpc-3cj17x7u9bzeo6c6rrtzfpaeb",
    zone="cn-langfang-b")
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.NewInstance(ctx, "foo", &rds.InstanceArgs{
			ChargeType:       pulumi.String("PostPaid"),
			DbEngine:         pulumi.String("MySQL"),
			DbEngineVersion:  pulumi.String("MySQL_Community_5_7"),
			InstanceName:     pulumi.String("tf-test"),
			InstanceSpecName: pulumi.String("rds.mysql.1c2g"),
			InstanceType:     pulumi.String("HA"),
			Region:           pulumi.String("cn-north-4"),
			StorageSpaceGb:   pulumi.Int(100),
			StorageType:      pulumi.String("LocalSSD"),
			SubnetId:         pulumi.String("subnet-1g0d4fkh1nabk8ibuxx1jtvss"),
			VpcId:            pulumi.String("vpc-3cj17x7u9bzeo6c6rrtzfpaeb"),
			Zone:             pulumi.String("cn-langfang-b"),
		})
		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 foo = new Volcengine.Rds.Instance("foo", new()
    {
        ChargeType = "PostPaid",
        DbEngine = "MySQL",
        DbEngineVersion = "MySQL_Community_5_7",
        InstanceName = "tf-test",
        InstanceSpecName = "rds.mysql.1c2g",
        InstanceType = "HA",
        Region = "cn-north-4",
        StorageSpaceGb = 100,
        StorageType = "LocalSSD",
        SubnetId = "subnet-1g0d4fkh1nabk8ibuxx1jtvss",
        VpcId = "vpc-3cj17x7u9bzeo6c6rrtzfpaeb",
        Zone = "cn-langfang-b",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds.Instance;
import com.pulumi.volcengine.rds.InstanceArgs;
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 foo = new Instance("foo", InstanceArgs.builder()        
            .chargeType("PostPaid")
            .dbEngine("MySQL")
            .dbEngineVersion("MySQL_Community_5_7")
            .instanceName("tf-test")
            .instanceSpecName("rds.mysql.1c2g")
            .instanceType("HA")
            .region("cn-north-4")
            .storageSpaceGb(100)
            .storageType("LocalSSD")
            .subnetId("subnet-1g0d4fkh1nabk8ibuxx1jtvss")
            .vpcId("vpc-3cj17x7u9bzeo6c6rrtzfpaeb")
            .zone("cn-langfang-b")
            .build());

    }
}
Copy
resources:
  foo:
    type: volcengine:rds:Instance
    properties:
      chargeType: PostPaid
      dbEngine: MySQL
      dbEngineVersion: MySQL_Community_5_7
      instanceName: tf-test
      instanceSpecName: rds.mysql.1c2g
      instanceType: HA
      region: cn-north-4
      storageSpaceGb: 100
      storageType: LocalSSD
      subnetId: subnet-1g0d4fkh1nabk8ibuxx1jtvss
      vpcId: vpc-3cj17x7u9bzeo6c6rrtzfpaeb
      zone: cn-langfang-b
Copy

Create Instance Resource

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

Constructor syntax

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

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             storage_space_gb: Optional[int] = None,
             charge_type: Optional[str] = None,
             zone: Optional[str] = None,
             db_engine_version: Optional[str] = None,
             vpc_id: Optional[str] = None,
             instance_spec_name: Optional[str] = None,
             instance_type: Optional[str] = None,
             subnet_id: Optional[str] = None,
             storage_type: Optional[str] = None,
             instance_name: Optional[str] = None,
             region: Optional[str] = None,
             project_name: Optional[str] = None,
             prepaid_period: Optional[str] = None,
             super_account_name: Optional[str] = None,
             super_account_password: Optional[str] = None,
             supper_account_password: Optional[str] = None,
             used_time: Optional[int] = None,
             auto_renew: Optional[bool] = None,
             db_engine: Optional[str] = None)
func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: volcengine:rds:Instance
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. InstanceArgs
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. InstanceArgs
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. InstanceArgs
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. InstanceArgs
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. InstanceArgs
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 exampleinstanceResourceResourceFromRdsinstance = new Volcengine.Rds.Instance("exampleinstanceResourceResourceFromRdsinstance", new()
{
    StorageSpaceGb = 0,
    ChargeType = "string",
    Zone = "string",
    DbEngineVersion = "string",
    VpcId = "string",
    InstanceSpecName = "string",
    InstanceType = "string",
    SubnetId = "string",
    StorageType = "string",
    InstanceName = "string",
    Region = "string",
    ProjectName = "string",
    PrepaidPeriod = "string",
    SuperAccountName = "string",
    SuperAccountPassword = "string",
    UsedTime = 0,
    AutoRenew = false,
    DbEngine = "string",
});
Copy
example, err := rds.NewInstance(ctx, "exampleinstanceResourceResourceFromRdsinstance", &rds.InstanceArgs{
	StorageSpaceGb:       pulumi.Int(0),
	ChargeType:           pulumi.String("string"),
	Zone:                 pulumi.String("string"),
	DbEngineVersion:      pulumi.String("string"),
	VpcId:                pulumi.String("string"),
	InstanceSpecName:     pulumi.String("string"),
	InstanceType:         pulumi.String("string"),
	SubnetId:             pulumi.String("string"),
	StorageType:          pulumi.String("string"),
	InstanceName:         pulumi.String("string"),
	Region:               pulumi.String("string"),
	ProjectName:          pulumi.String("string"),
	PrepaidPeriod:        pulumi.String("string"),
	SuperAccountName:     pulumi.String("string"),
	SuperAccountPassword: pulumi.String("string"),
	UsedTime:             pulumi.Int(0),
	AutoRenew:            pulumi.Bool(false),
	DbEngine:             pulumi.String("string"),
})
Copy
var exampleinstanceResourceResourceFromRdsinstance = new Instance("exampleinstanceResourceResourceFromRdsinstance", InstanceArgs.builder()
    .storageSpaceGb(0)
    .chargeType("string")
    .zone("string")
    .dbEngineVersion("string")
    .vpcId("string")
    .instanceSpecName("string")
    .instanceType("string")
    .subnetId("string")
    .storageType("string")
    .instanceName("string")
    .region("string")
    .projectName("string")
    .prepaidPeriod("string")
    .superAccountName("string")
    .superAccountPassword("string")
    .usedTime(0)
    .autoRenew(false)
    .dbEngine("string")
    .build());
Copy
exampleinstance_resource_resource_from_rdsinstance = volcengine.rds.Instance("exampleinstanceResourceResourceFromRdsinstance",
    storage_space_gb=0,
    charge_type="string",
    zone="string",
    db_engine_version="string",
    vpc_id="string",
    instance_spec_name="string",
    instance_type="string",
    subnet_id="string",
    storage_type="string",
    instance_name="string",
    region="string",
    project_name="string",
    prepaid_period="string",
    super_account_name="string",
    super_account_password="string",
    used_time=0,
    auto_renew=False,
    db_engine="string")
Copy
const exampleinstanceResourceResourceFromRdsinstance = new volcengine.rds.Instance("exampleinstanceResourceResourceFromRdsinstance", {
    storageSpaceGb: 0,
    chargeType: "string",
    zone: "string",
    dbEngineVersion: "string",
    vpcId: "string",
    instanceSpecName: "string",
    instanceType: "string",
    subnetId: "string",
    storageType: "string",
    instanceName: "string",
    region: "string",
    projectName: "string",
    prepaidPeriod: "string",
    superAccountName: "string",
    superAccountPassword: "string",
    usedTime: 0,
    autoRenew: false,
    dbEngine: "string",
});
Copy
type: volcengine:rds:Instance
properties:
    autoRenew: false
    chargeType: string
    dbEngine: string
    dbEngineVersion: string
    instanceName: string
    instanceSpecName: string
    instanceType: string
    prepaidPeriod: string
    projectName: string
    region: string
    storageSpaceGb: 0
    storageType: string
    subnetId: string
    superAccountName: string
    superAccountPassword: string
    usedTime: 0
    vpcId: string
    zone: string
Copy

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

ChargeType
This property is required.
Changes to this property will trigger replacement.
string
Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
DbEngineVersion
This property is required.
Changes to this property will trigger replacement.
string
Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
InstanceSpecName
This property is required.
Changes to this property will trigger replacement.
string
Instance specification name, you can specify the specification name of the instance to be created. Value: rds.mysql.1c2g rds.mysql.2c4g rds.mysql.4c8g rds.mysql.4c16g rds.mysql.8c32g rds.mysql.16c64g rds.mysql.16c128g rds.mysql.32c128g rds.mysql.32c256g.
InstanceType
This property is required.
Changes to this property will trigger replacement.
string
Instance type. Value: HA: High availability version.
StorageSpaceGb
This property is required.
Changes to this property will trigger replacement.
int
The storage space(GB) of the RDS instance.
StorageType
This property is required.
Changes to this property will trigger replacement.
string
Instance storage type. Value: LocalSSD: Local SSD disk.
SubnetId
This property is required.
Changes to this property will trigger replacement.
string
Subnet ID. The subnet must belong to the selected Availability Zone.
VpcId
This property is required.
Changes to this property will trigger replacement.
string
The vpc ID of the RDS instance.
Zone
This property is required.
Changes to this property will trigger replacement.
string
The available zone of the RDS instance.
AutoRenew Changes to this property will trigger replacement. bool
Whether to automatically renew. Default: false. Value: true: yes. false: no. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
DbEngine Changes to this property will trigger replacement. string
Database type. Value: MySQL (default).
InstanceName Changes to this property will trigger replacement. string

Set the name of the instance. The naming rules are as follows:

Cannot start with a number, a dash (-). It can only contain Chinese characters, letters, numbers, underscores (_) and underscores (-). The length needs to be within 1~128 characters.

PrepaidPeriod Changes to this property will trigger replacement. string
The purchase cycle in the prepaid scenario. Value: Month: monthly subscription. Year: yearly subscription. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
ProjectName Changes to this property will trigger replacement. string
Select the project to which the instance belongs. If this parameter is left blank, the new instance will not be added to any project. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
Region Changes to this property will trigger replacement. string
The region of the RDS instance.
SuperAccountName Changes to this property will trigger replacement. string
Fill in the high-privileged user account name. The naming rules are as follows: Unique name. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, or underscores (_). The length is 2~32 characters. Keywords are not allowed for account names.
SuperAccountPassword Changes to this property will trigger replacement. string
Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.
SupperAccountPassword Changes to this property will trigger replacement. string
supper_account_password is deprecated, use super_account_password instead Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.

Deprecated: supper_account_password is deprecated, use super_account_password instead

UsedTime Changes to this property will trigger replacement. int
The purchase time of RDS instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
ChargeType
This property is required.
Changes to this property will trigger replacement.
string
Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
DbEngineVersion
This property is required.
Changes to this property will trigger replacement.
string
Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
InstanceSpecName
This property is required.
Changes to this property will trigger replacement.
string
Instance specification name, you can specify the specification name of the instance to be created. Value: rds.mysql.1c2g rds.mysql.2c4g rds.mysql.4c8g rds.mysql.4c16g rds.mysql.8c32g rds.mysql.16c64g rds.mysql.16c128g rds.mysql.32c128g rds.mysql.32c256g.
InstanceType
This property is required.
Changes to this property will trigger replacement.
string
Instance type. Value: HA: High availability version.
StorageSpaceGb
This property is required.
Changes to this property will trigger replacement.
int
The storage space(GB) of the RDS instance.
StorageType
This property is required.
Changes to this property will trigger replacement.
string
Instance storage type. Value: LocalSSD: Local SSD disk.
SubnetId
This property is required.
Changes to this property will trigger replacement.
string
Subnet ID. The subnet must belong to the selected Availability Zone.
VpcId
This property is required.
Changes to this property will trigger replacement.
string
The vpc ID of the RDS instance.
Zone
This property is required.
Changes to this property will trigger replacement.
string
The available zone of the RDS instance.
AutoRenew Changes to this property will trigger replacement. bool
Whether to automatically renew. Default: false. Value: true: yes. false: no. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
DbEngine Changes to this property will trigger replacement. string
Database type. Value: MySQL (default).
InstanceName Changes to this property will trigger replacement. string

Set the name of the instance. The naming rules are as follows:

Cannot start with a number, a dash (-). It can only contain Chinese characters, letters, numbers, underscores (_) and underscores (-). The length needs to be within 1~128 characters.

PrepaidPeriod Changes to this property will trigger replacement. string
The purchase cycle in the prepaid scenario. Value: Month: monthly subscription. Year: yearly subscription. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
ProjectName Changes to this property will trigger replacement. string
Select the project to which the instance belongs. If this parameter is left blank, the new instance will not be added to any project. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
Region Changes to this property will trigger replacement. string
The region of the RDS instance.
SuperAccountName Changes to this property will trigger replacement. string
Fill in the high-privileged user account name. The naming rules are as follows: Unique name. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, or underscores (_). The length is 2~32 characters. Keywords are not allowed for account names.
SuperAccountPassword Changes to this property will trigger replacement. string
Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.
SupperAccountPassword Changes to this property will trigger replacement. string
supper_account_password is deprecated, use super_account_password instead Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.

Deprecated: supper_account_password is deprecated, use super_account_password instead

UsedTime Changes to this property will trigger replacement. int
The purchase time of RDS instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
chargeType
This property is required.
Changes to this property will trigger replacement.
String
Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
dbEngineVersion
This property is required.
Changes to this property will trigger replacement.
String
Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
instanceSpecName
This property is required.
Changes to this property will trigger replacement.
String
Instance specification name, you can specify the specification name of the instance to be created. Value: rds.mysql.1c2g rds.mysql.2c4g rds.mysql.4c8g rds.mysql.4c16g rds.mysql.8c32g rds.mysql.16c64g rds.mysql.16c128g rds.mysql.32c128g rds.mysql.32c256g.
instanceType
This property is required.
Changes to this property will trigger replacement.
String
Instance type. Value: HA: High availability version.
storageSpaceGb
This property is required.
Changes to this property will trigger replacement.
Integer
The storage space(GB) of the RDS instance.
storageType
This property is required.
Changes to this property will trigger replacement.
String
Instance storage type. Value: LocalSSD: Local SSD disk.
subnetId
This property is required.
Changes to this property will trigger replacement.
String
Subnet ID. The subnet must belong to the selected Availability Zone.
vpcId
This property is required.
Changes to this property will trigger replacement.
String
The vpc ID of the RDS instance.
zone
This property is required.
Changes to this property will trigger replacement.
String
The available zone of the RDS instance.
autoRenew Changes to this property will trigger replacement. Boolean
Whether to automatically renew. Default: false. Value: true: yes. false: no. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
dbEngine Changes to this property will trigger replacement. String
Database type. Value: MySQL (default).
instanceName Changes to this property will trigger replacement. String

Set the name of the instance. The naming rules are as follows:

Cannot start with a number, a dash (-). It can only contain Chinese characters, letters, numbers, underscores (_) and underscores (-). The length needs to be within 1~128 characters.

prepaidPeriod Changes to this property will trigger replacement. String
The purchase cycle in the prepaid scenario. Value: Month: monthly subscription. Year: yearly subscription. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
projectName Changes to this property will trigger replacement. String
Select the project to which the instance belongs. If this parameter is left blank, the new instance will not be added to any project. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
region Changes to this property will trigger replacement. String
The region of the RDS instance.
superAccountName Changes to this property will trigger replacement. String
Fill in the high-privileged user account name. The naming rules are as follows: Unique name. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, or underscores (_). The length is 2~32 characters. Keywords are not allowed for account names.
superAccountPassword Changes to this property will trigger replacement. String
Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.
supperAccountPassword Changes to this property will trigger replacement. String
supper_account_password is deprecated, use super_account_password instead Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.

Deprecated: supper_account_password is deprecated, use super_account_password instead

usedTime Changes to this property will trigger replacement. Integer
The purchase time of RDS instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
chargeType
This property is required.
Changes to this property will trigger replacement.
string
Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
dbEngineVersion
This property is required.
Changes to this property will trigger replacement.
string
Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
instanceSpecName
This property is required.
Changes to this property will trigger replacement.
string
Instance specification name, you can specify the specification name of the instance to be created. Value: rds.mysql.1c2g rds.mysql.2c4g rds.mysql.4c8g rds.mysql.4c16g rds.mysql.8c32g rds.mysql.16c64g rds.mysql.16c128g rds.mysql.32c128g rds.mysql.32c256g.
instanceType
This property is required.
Changes to this property will trigger replacement.
string
Instance type. Value: HA: High availability version.
storageSpaceGb
This property is required.
Changes to this property will trigger replacement.
number
The storage space(GB) of the RDS instance.
storageType
This property is required.
Changes to this property will trigger replacement.
string
Instance storage type. Value: LocalSSD: Local SSD disk.
subnetId
This property is required.
Changes to this property will trigger replacement.
string
Subnet ID. The subnet must belong to the selected Availability Zone.
vpcId
This property is required.
Changes to this property will trigger replacement.
string
The vpc ID of the RDS instance.
zone
This property is required.
Changes to this property will trigger replacement.
string
The available zone of the RDS instance.
autoRenew Changes to this property will trigger replacement. boolean
Whether to automatically renew. Default: false. Value: true: yes. false: no. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
dbEngine Changes to this property will trigger replacement. string
Database type. Value: MySQL (default).
instanceName Changes to this property will trigger replacement. string

Set the name of the instance. The naming rules are as follows:

Cannot start with a number, a dash (-). It can only contain Chinese characters, letters, numbers, underscores (_) and underscores (-). The length needs to be within 1~128 characters.

prepaidPeriod Changes to this property will trigger replacement. string
The purchase cycle in the prepaid scenario. Value: Month: monthly subscription. Year: yearly subscription. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
projectName Changes to this property will trigger replacement. string
Select the project to which the instance belongs. If this parameter is left blank, the new instance will not be added to any project. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
region Changes to this property will trigger replacement. string
The region of the RDS instance.
superAccountName Changes to this property will trigger replacement. string
Fill in the high-privileged user account name. The naming rules are as follows: Unique name. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, or underscores (_). The length is 2~32 characters. Keywords are not allowed for account names.
superAccountPassword Changes to this property will trigger replacement. string
Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.
supperAccountPassword Changes to this property will trigger replacement. string
supper_account_password is deprecated, use super_account_password instead Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.

Deprecated: supper_account_password is deprecated, use super_account_password instead

usedTime Changes to this property will trigger replacement. number
The purchase time of RDS instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
charge_type
This property is required.
Changes to this property will trigger replacement.
str
Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
db_engine_version
This property is required.
Changes to this property will trigger replacement.
str
Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
instance_spec_name
This property is required.
Changes to this property will trigger replacement.
str
Instance specification name, you can specify the specification name of the instance to be created. Value: rds.mysql.1c2g rds.mysql.2c4g rds.mysql.4c8g rds.mysql.4c16g rds.mysql.8c32g rds.mysql.16c64g rds.mysql.16c128g rds.mysql.32c128g rds.mysql.32c256g.
instance_type
This property is required.
Changes to this property will trigger replacement.
str
Instance type. Value: HA: High availability version.
storage_space_gb
This property is required.
Changes to this property will trigger replacement.
int
The storage space(GB) of the RDS instance.
storage_type
This property is required.
Changes to this property will trigger replacement.
str
Instance storage type. Value: LocalSSD: Local SSD disk.
subnet_id
This property is required.
Changes to this property will trigger replacement.
str
Subnet ID. The subnet must belong to the selected Availability Zone.
vpc_id
This property is required.
Changes to this property will trigger replacement.
str
The vpc ID of the RDS instance.
zone
This property is required.
Changes to this property will trigger replacement.
str
The available zone of the RDS instance.
auto_renew Changes to this property will trigger replacement. bool
Whether to automatically renew. Default: false. Value: true: yes. false: no. 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_engine Changes to this property will trigger replacement. str
Database type. Value: MySQL (default).
instance_name Changes to this property will trigger replacement. str

Set the name of the instance. The naming rules are as follows:

Cannot start with a number, a dash (-). It can only contain Chinese characters, letters, numbers, underscores (_) and underscores (-). The length needs to be within 1~128 characters.

prepaid_period Changes to this property will trigger replacement. str
The purchase cycle in the prepaid scenario. Value: Month: monthly subscription. Year: yearly subscription. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
project_name Changes to this property will trigger replacement. str
Select the project to which the instance belongs. If this parameter is left blank, the new instance will not be added to any project. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
region Changes to this property will trigger replacement. str
The region of the RDS instance.
super_account_name Changes to this property will trigger replacement. str
Fill in the high-privileged user account name. The naming rules are as follows: Unique name. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, or underscores (_). The length is 2~32 characters. Keywords are not allowed for account names.
super_account_password Changes to this property will trigger replacement. str
Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.
supper_account_password Changes to this property will trigger replacement. str
supper_account_password is deprecated, use super_account_password instead Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.

Deprecated: supper_account_password is deprecated, use super_account_password instead

used_time Changes to this property will trigger replacement. int
The purchase time of RDS instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
chargeType
This property is required.
Changes to this property will trigger replacement.
String
Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
dbEngineVersion
This property is required.
Changes to this property will trigger replacement.
String
Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
instanceSpecName
This property is required.
Changes to this property will trigger replacement.
String
Instance specification name, you can specify the specification name of the instance to be created. Value: rds.mysql.1c2g rds.mysql.2c4g rds.mysql.4c8g rds.mysql.4c16g rds.mysql.8c32g rds.mysql.16c64g rds.mysql.16c128g rds.mysql.32c128g rds.mysql.32c256g.
instanceType
This property is required.
Changes to this property will trigger replacement.
String
Instance type. Value: HA: High availability version.
storageSpaceGb
This property is required.
Changes to this property will trigger replacement.
Number
The storage space(GB) of the RDS instance.
storageType
This property is required.
Changes to this property will trigger replacement.
String
Instance storage type. Value: LocalSSD: Local SSD disk.
subnetId
This property is required.
Changes to this property will trigger replacement.
String
Subnet ID. The subnet must belong to the selected Availability Zone.
vpcId
This property is required.
Changes to this property will trigger replacement.
String
The vpc ID of the RDS instance.
zone
This property is required.
Changes to this property will trigger replacement.
String
The available zone of the RDS instance.
autoRenew Changes to this property will trigger replacement. Boolean
Whether to automatically renew. Default: false. Value: true: yes. false: no. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
dbEngine Changes to this property will trigger replacement. String
Database type. Value: MySQL (default).
instanceName Changes to this property will trigger replacement. String

Set the name of the instance. The naming rules are as follows:

Cannot start with a number, a dash (-). It can only contain Chinese characters, letters, numbers, underscores (_) and underscores (-). The length needs to be within 1~128 characters.

prepaidPeriod Changes to this property will trigger replacement. String
The purchase cycle in the prepaid scenario. Value: Month: monthly subscription. Year: yearly subscription. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
projectName Changes to this property will trigger replacement. String
Select the project to which the instance belongs. If this parameter is left blank, the new instance will not be added to any project. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
region Changes to this property will trigger replacement. String
The region of the RDS instance.
superAccountName Changes to this property will trigger replacement. String
Fill in the high-privileged user account name. The naming rules are as follows: Unique name. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, or underscores (_). The length is 2~32 characters. Keywords are not allowed for account names.
superAccountPassword Changes to this property will trigger replacement. String
Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.
supperAccountPassword Changes to this property will trigger replacement. String
supper_account_password is deprecated, use super_account_password instead Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.

Deprecated: supper_account_password is deprecated, use super_account_password instead

usedTime Changes to this property will trigger replacement. Number
The purchase time of RDS instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.

Outputs

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

ConnectionInfo InstanceConnectionInfo
The connection info ot the RDS instance.
Id string
The provider-assigned unique ID for this managed resource.
ConnectionInfo InstanceConnectionInfo
The connection info ot the RDS instance.
Id string
The provider-assigned unique ID for this managed resource.
connectionInfo InstanceConnectionInfo
The connection info ot the RDS instance.
id String
The provider-assigned unique ID for this managed resource.
connectionInfo InstanceConnectionInfo
The connection info ot the RDS instance.
id string
The provider-assigned unique ID for this managed resource.
connection_info InstanceConnectionInfo
The connection info ot the RDS instance.
id str
The provider-assigned unique ID for this managed resource.
connectionInfo Property Map
The connection info ot the RDS instance.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Instance Resource

Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_renew: Optional[bool] = None,
        charge_type: Optional[str] = None,
        connection_info: Optional[InstanceConnectionInfoArgs] = None,
        db_engine: Optional[str] = None,
        db_engine_version: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_spec_name: Optional[str] = None,
        instance_type: Optional[str] = None,
        prepaid_period: Optional[str] = None,
        project_name: Optional[str] = None,
        region: Optional[str] = None,
        storage_space_gb: Optional[int] = None,
        storage_type: Optional[str] = None,
        subnet_id: Optional[str] = None,
        super_account_name: Optional[str] = None,
        super_account_password: Optional[str] = None,
        supper_account_password: Optional[str] = None,
        used_time: Optional[int] = None,
        vpc_id: Optional[str] = None,
        zone: Optional[str] = None) -> Instance
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
resources:  _:    type: volcengine:rds:Instance    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:
AutoRenew Changes to this property will trigger replacement. bool
Whether to automatically renew. Default: false. Value: true: yes. false: no. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
ChargeType Changes to this property will trigger replacement. string
Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
ConnectionInfo InstanceConnectionInfo
The connection info ot the RDS instance.
DbEngine Changes to this property will trigger replacement. string
Database type. Value: MySQL (default).
DbEngineVersion Changes to this property will trigger replacement. string
Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
InstanceName Changes to this property will trigger replacement. string

Set the name of the instance. The naming rules are as follows:

Cannot start with a number, a dash (-). It can only contain Chinese characters, letters, numbers, underscores (_) and underscores (-). The length needs to be within 1~128 characters.

InstanceSpecName Changes to this property will trigger replacement. string
Instance specification name, you can specify the specification name of the instance to be created. Value: rds.mysql.1c2g rds.mysql.2c4g rds.mysql.4c8g rds.mysql.4c16g rds.mysql.8c32g rds.mysql.16c64g rds.mysql.16c128g rds.mysql.32c128g rds.mysql.32c256g.
InstanceType Changes to this property will trigger replacement. string
Instance type. Value: HA: High availability version.
PrepaidPeriod Changes to this property will trigger replacement. string
The purchase cycle in the prepaid scenario. Value: Month: monthly subscription. Year: yearly subscription. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
ProjectName Changes to this property will trigger replacement. string
Select the project to which the instance belongs. If this parameter is left blank, the new instance will not be added to any project. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
Region Changes to this property will trigger replacement. string
The region of the RDS instance.
StorageSpaceGb Changes to this property will trigger replacement. int
The storage space(GB) of the RDS instance.
StorageType Changes to this property will trigger replacement. string
Instance storage type. Value: LocalSSD: Local SSD disk.
SubnetId Changes to this property will trigger replacement. string
Subnet ID. The subnet must belong to the selected Availability Zone.
SuperAccountName Changes to this property will trigger replacement. string
Fill in the high-privileged user account name. The naming rules are as follows: Unique name. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, or underscores (_). The length is 2~32 characters. Keywords are not allowed for account names.
SuperAccountPassword Changes to this property will trigger replacement. string
Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.
SupperAccountPassword Changes to this property will trigger replacement. string
supper_account_password is deprecated, use super_account_password instead Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.

Deprecated: supper_account_password is deprecated, use super_account_password instead

UsedTime Changes to this property will trigger replacement. int
The purchase time of RDS instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
VpcId Changes to this property will trigger replacement. string
The vpc ID of the RDS instance.
Zone Changes to this property will trigger replacement. string
The available zone of the RDS instance.
AutoRenew Changes to this property will trigger replacement. bool
Whether to automatically renew. Default: false. Value: true: yes. false: no. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
ChargeType Changes to this property will trigger replacement. string
Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
ConnectionInfo InstanceConnectionInfoArgs
The connection info ot the RDS instance.
DbEngine Changes to this property will trigger replacement. string
Database type. Value: MySQL (default).
DbEngineVersion Changes to this property will trigger replacement. string
Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
InstanceName Changes to this property will trigger replacement. string

Set the name of the instance. The naming rules are as follows:

Cannot start with a number, a dash (-). It can only contain Chinese characters, letters, numbers, underscores (_) and underscores (-). The length needs to be within 1~128 characters.

InstanceSpecName Changes to this property will trigger replacement. string
Instance specification name, you can specify the specification name of the instance to be created. Value: rds.mysql.1c2g rds.mysql.2c4g rds.mysql.4c8g rds.mysql.4c16g rds.mysql.8c32g rds.mysql.16c64g rds.mysql.16c128g rds.mysql.32c128g rds.mysql.32c256g.
InstanceType Changes to this property will trigger replacement. string
Instance type. Value: HA: High availability version.
PrepaidPeriod Changes to this property will trigger replacement. string
The purchase cycle in the prepaid scenario. Value: Month: monthly subscription. Year: yearly subscription. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
ProjectName Changes to this property will trigger replacement. string
Select the project to which the instance belongs. If this parameter is left blank, the new instance will not be added to any project. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
Region Changes to this property will trigger replacement. string
The region of the RDS instance.
StorageSpaceGb Changes to this property will trigger replacement. int
The storage space(GB) of the RDS instance.
StorageType Changes to this property will trigger replacement. string
Instance storage type. Value: LocalSSD: Local SSD disk.
SubnetId Changes to this property will trigger replacement. string
Subnet ID. The subnet must belong to the selected Availability Zone.
SuperAccountName Changes to this property will trigger replacement. string
Fill in the high-privileged user account name. The naming rules are as follows: Unique name. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, or underscores (_). The length is 2~32 characters. Keywords are not allowed for account names.
SuperAccountPassword Changes to this property will trigger replacement. string
Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.
SupperAccountPassword Changes to this property will trigger replacement. string
supper_account_password is deprecated, use super_account_password instead Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.

Deprecated: supper_account_password is deprecated, use super_account_password instead

UsedTime Changes to this property will trigger replacement. int
The purchase time of RDS instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
VpcId Changes to this property will trigger replacement. string
The vpc ID of the RDS instance.
Zone Changes to this property will trigger replacement. string
The available zone of the RDS instance.
autoRenew Changes to this property will trigger replacement. Boolean
Whether to automatically renew. Default: false. Value: true: yes. false: no. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
chargeType Changes to this property will trigger replacement. String
Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
connectionInfo InstanceConnectionInfo
The connection info ot the RDS instance.
dbEngine Changes to this property will trigger replacement. String
Database type. Value: MySQL (default).
dbEngineVersion Changes to this property will trigger replacement. String
Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
instanceName Changes to this property will trigger replacement. String

Set the name of the instance. The naming rules are as follows:

Cannot start with a number, a dash (-). It can only contain Chinese characters, letters, numbers, underscores (_) and underscores (-). The length needs to be within 1~128 characters.

instanceSpecName Changes to this property will trigger replacement. String
Instance specification name, you can specify the specification name of the instance to be created. Value: rds.mysql.1c2g rds.mysql.2c4g rds.mysql.4c8g rds.mysql.4c16g rds.mysql.8c32g rds.mysql.16c64g rds.mysql.16c128g rds.mysql.32c128g rds.mysql.32c256g.
instanceType Changes to this property will trigger replacement. String
Instance type. Value: HA: High availability version.
prepaidPeriod Changes to this property will trigger replacement. String
The purchase cycle in the prepaid scenario. Value: Month: monthly subscription. Year: yearly subscription. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
projectName Changes to this property will trigger replacement. String
Select the project to which the instance belongs. If this parameter is left blank, the new instance will not be added to any project. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
region Changes to this property will trigger replacement. String
The region of the RDS instance.
storageSpaceGb Changes to this property will trigger replacement. Integer
The storage space(GB) of the RDS instance.
storageType Changes to this property will trigger replacement. String
Instance storage type. Value: LocalSSD: Local SSD disk.
subnetId Changes to this property will trigger replacement. String
Subnet ID. The subnet must belong to the selected Availability Zone.
superAccountName Changes to this property will trigger replacement. String
Fill in the high-privileged user account name. The naming rules are as follows: Unique name. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, or underscores (_). The length is 2~32 characters. Keywords are not allowed for account names.
superAccountPassword Changes to this property will trigger replacement. String
Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.
supperAccountPassword Changes to this property will trigger replacement. String
supper_account_password is deprecated, use super_account_password instead Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.

Deprecated: supper_account_password is deprecated, use super_account_password instead

usedTime Changes to this property will trigger replacement. Integer
The purchase time of RDS instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
vpcId Changes to this property will trigger replacement. String
The vpc ID of the RDS instance.
zone Changes to this property will trigger replacement. String
The available zone of the RDS instance.
autoRenew Changes to this property will trigger replacement. boolean
Whether to automatically renew. Default: false. Value: true: yes. false: no. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
chargeType Changes to this property will trigger replacement. string
Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
connectionInfo InstanceConnectionInfo
The connection info ot the RDS instance.
dbEngine Changes to this property will trigger replacement. string
Database type. Value: MySQL (default).
dbEngineVersion Changes to this property will trigger replacement. string
Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
instanceName Changes to this property will trigger replacement. string

Set the name of the instance. The naming rules are as follows:

Cannot start with a number, a dash (-). It can only contain Chinese characters, letters, numbers, underscores (_) and underscores (-). The length needs to be within 1~128 characters.

instanceSpecName Changes to this property will trigger replacement. string
Instance specification name, you can specify the specification name of the instance to be created. Value: rds.mysql.1c2g rds.mysql.2c4g rds.mysql.4c8g rds.mysql.4c16g rds.mysql.8c32g rds.mysql.16c64g rds.mysql.16c128g rds.mysql.32c128g rds.mysql.32c256g.
instanceType Changes to this property will trigger replacement. string
Instance type. Value: HA: High availability version.
prepaidPeriod Changes to this property will trigger replacement. string
The purchase cycle in the prepaid scenario. Value: Month: monthly subscription. Year: yearly subscription. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
projectName Changes to this property will trigger replacement. string
Select the project to which the instance belongs. If this parameter is left blank, the new instance will not be added to any project. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
region Changes to this property will trigger replacement. string
The region of the RDS instance.
storageSpaceGb Changes to this property will trigger replacement. number
The storage space(GB) of the RDS instance.
storageType Changes to this property will trigger replacement. string
Instance storage type. Value: LocalSSD: Local SSD disk.
subnetId Changes to this property will trigger replacement. string
Subnet ID. The subnet must belong to the selected Availability Zone.
superAccountName Changes to this property will trigger replacement. string
Fill in the high-privileged user account name. The naming rules are as follows: Unique name. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, or underscores (_). The length is 2~32 characters. Keywords are not allowed for account names.
superAccountPassword Changes to this property will trigger replacement. string
Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.
supperAccountPassword Changes to this property will trigger replacement. string
supper_account_password is deprecated, use super_account_password instead Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.

Deprecated: supper_account_password is deprecated, use super_account_password instead

usedTime Changes to this property will trigger replacement. number
The purchase time of RDS instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
vpcId Changes to this property will trigger replacement. string
The vpc ID of the RDS instance.
zone Changes to this property will trigger replacement. string
The available zone of the RDS instance.
auto_renew Changes to this property will trigger replacement. bool
Whether to automatically renew. Default: false. Value: true: yes. false: no. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
charge_type Changes to this property will trigger replacement. str
Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
connection_info InstanceConnectionInfoArgs
The connection info ot the RDS instance.
db_engine Changes to this property will trigger replacement. str
Database type. Value: MySQL (default).
db_engine_version Changes to this property will trigger replacement. str
Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
instance_name Changes to this property will trigger replacement. str

Set the name of the instance. The naming rules are as follows:

Cannot start with a number, a dash (-). It can only contain Chinese characters, letters, numbers, underscores (_) and underscores (-). The length needs to be within 1~128 characters.

instance_spec_name Changes to this property will trigger replacement. str
Instance specification name, you can specify the specification name of the instance to be created. Value: rds.mysql.1c2g rds.mysql.2c4g rds.mysql.4c8g rds.mysql.4c16g rds.mysql.8c32g rds.mysql.16c64g rds.mysql.16c128g rds.mysql.32c128g rds.mysql.32c256g.
instance_type Changes to this property will trigger replacement. str
Instance type. Value: HA: High availability version.
prepaid_period Changes to this property will trigger replacement. str
The purchase cycle in the prepaid scenario. Value: Month: monthly subscription. Year: yearly subscription. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
project_name Changes to this property will trigger replacement. str
Select the project to which the instance belongs. If this parameter is left blank, the new instance will not be added to any project. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
region Changes to this property will trigger replacement. str
The region of the RDS instance.
storage_space_gb Changes to this property will trigger replacement. int
The storage space(GB) of the RDS instance.
storage_type Changes to this property will trigger replacement. str
Instance storage type. Value: LocalSSD: Local SSD disk.
subnet_id Changes to this property will trigger replacement. str
Subnet ID. The subnet must belong to the selected Availability Zone.
super_account_name Changes to this property will trigger replacement. str
Fill in the high-privileged user account name. The naming rules are as follows: Unique name. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, or underscores (_). The length is 2~32 characters. Keywords are not allowed for account names.
super_account_password Changes to this property will trigger replacement. str
Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.
supper_account_password Changes to this property will trigger replacement. str
supper_account_password is deprecated, use super_account_password instead Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.

Deprecated: supper_account_password is deprecated, use super_account_password instead

used_time Changes to this property will trigger replacement. int
The purchase time of RDS instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
vpc_id Changes to this property will trigger replacement. str
The vpc ID of the RDS instance.
zone Changes to this property will trigger replacement. str
The available zone of the RDS instance.
autoRenew Changes to this property will trigger replacement. Boolean
Whether to automatically renew. Default: false. Value: true: yes. false: no. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
chargeType Changes to this property will trigger replacement. String
Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
connectionInfo Property Map
The connection info ot the RDS instance.
dbEngine Changes to this property will trigger replacement. String
Database type. Value: MySQL (default).
dbEngineVersion Changes to this property will trigger replacement. String
Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
instanceName Changes to this property will trigger replacement. String

Set the name of the instance. The naming rules are as follows:

Cannot start with a number, a dash (-). It can only contain Chinese characters, letters, numbers, underscores (_) and underscores (-). The length needs to be within 1~128 characters.

instanceSpecName Changes to this property will trigger replacement. String
Instance specification name, you can specify the specification name of the instance to be created. Value: rds.mysql.1c2g rds.mysql.2c4g rds.mysql.4c8g rds.mysql.4c16g rds.mysql.8c32g rds.mysql.16c64g rds.mysql.16c128g rds.mysql.32c128g rds.mysql.32c256g.
instanceType Changes to this property will trigger replacement. String
Instance type. Value: HA: High availability version.
prepaidPeriod Changes to this property will trigger replacement. String
The purchase cycle in the prepaid scenario. Value: Month: monthly subscription. Year: yearly subscription. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
projectName Changes to this property will trigger replacement. String
Select the project to which the instance belongs. If this parameter is left blank, the new instance will not be added to any project. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
region Changes to this property will trigger replacement. String
The region of the RDS instance.
storageSpaceGb Changes to this property will trigger replacement. Number
The storage space(GB) of the RDS instance.
storageType Changes to this property will trigger replacement. String
Instance storage type. Value: LocalSSD: Local SSD disk.
subnetId Changes to this property will trigger replacement. String
Subnet ID. The subnet must belong to the selected Availability Zone.
superAccountName Changes to this property will trigger replacement. String
Fill in the high-privileged user account name. The naming rules are as follows: Unique name. Start with a letter and end with a letter or number. Consists of lowercase letters, numbers, or underscores (_). The length is 2~32 characters. Keywords are not allowed for account names.
superAccountPassword Changes to this property will trigger replacement. String
Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.
supperAccountPassword Changes to this property will trigger replacement. String
supper_account_password is deprecated, use super_account_password instead Set a high-privilege account password. The rules are as follows: Only uppercase and lowercase letters, numbers and the following special characters _#!@$%^*()+=-. The length needs to be within 8~32 characters. Contains at least 3 of uppercase letters, lowercase letters, numbers or special characters.

Deprecated: supper_account_password is deprecated, use super_account_password instead

usedTime Changes to this property will trigger replacement. Number
The purchase time of RDS instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
vpcId Changes to this property will trigger replacement. String
The vpc ID of the RDS instance.
zone Changes to this property will trigger replacement. String
The available zone of the RDS instance.

Supporting Types

InstanceConnectionInfo
, InstanceConnectionInfoArgs

EnableReadOnly string
Whether global read-only is enabled.
EnableReadWriteSplitting string
Whether read-write separation is enabled.
InternalDomain string
The internal domain of the RDS instance.
InternalPort string
The interval port of the RDS instance.
PublicDomain string
The public domain of the RDS instance.
PublicPort string
The public port of the RDS instance.
EnableReadOnly string
Whether global read-only is enabled.
EnableReadWriteSplitting string
Whether read-write separation is enabled.
InternalDomain string
The internal domain of the RDS instance.
InternalPort string
The interval port of the RDS instance.
PublicDomain string
The public domain of the RDS instance.
PublicPort string
The public port of the RDS instance.
enableReadOnly String
Whether global read-only is enabled.
enableReadWriteSplitting String
Whether read-write separation is enabled.
internalDomain String
The internal domain of the RDS instance.
internalPort String
The interval port of the RDS instance.
publicDomain String
The public domain of the RDS instance.
publicPort String
The public port of the RDS instance.
enableReadOnly string
Whether global read-only is enabled.
enableReadWriteSplitting string
Whether read-write separation is enabled.
internalDomain string
The internal domain of the RDS instance.
internalPort string
The interval port of the RDS instance.
publicDomain string
The public domain of the RDS instance.
publicPort string
The public port of the RDS instance.
enable_read_only str
Whether global read-only is enabled.
enable_read_write_splitting str
Whether read-write separation is enabled.
internal_domain str
The internal domain of the RDS instance.
internal_port str
The interval port of the RDS instance.
public_domain str
The public domain of the RDS instance.
public_port str
The public port of the RDS instance.
enableReadOnly String
Whether global read-only is enabled.
enableReadWriteSplitting String
Whether read-write separation is enabled.
internalDomain String
The internal domain of the RDS instance.
internalPort String
The interval port of the RDS instance.
publicDomain String
The public domain of the RDS instance.
publicPort String
The public port of the RDS instance.

Import

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

$ pulumi import volcengine:rds/instance:Instance 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.