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

volcengine.rds.Instance

Explore with Pulumi AI

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

    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",
});

    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")

    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
	})
}

    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",
    });

});

    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());

    }
}

    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

    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 string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
});

    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"),
})

    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());

    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")

    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",
});

    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

    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 string
    Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
    DbEngineVersion string
    Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
    InstanceSpecName 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 string
    Instance type. Value: HA: High availability version.
    StorageSpaceGb int
    The storage space(GB) of the RDS instance.
    StorageType string
    Instance storage type. Value: LocalSSD: Local SSD disk.
    SubnetId string
    Subnet ID. The subnet must belong to the selected Availability Zone.
    VpcId string
    The vpc ID of the RDS instance.
    Zone string
    The available zone of the RDS instance.
    AutoRenew 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 string
    Database type. Value: MySQL (default).
    InstanceName 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 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 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 string
    The region of the RDS instance.
    SuperAccountName 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 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 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 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 string
    Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
    DbEngineVersion string
    Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
    InstanceSpecName 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 string
    Instance type. Value: HA: High availability version.
    StorageSpaceGb int
    The storage space(GB) of the RDS instance.
    StorageType string
    Instance storage type. Value: LocalSSD: Local SSD disk.
    SubnetId string
    Subnet ID. The subnet must belong to the selected Availability Zone.
    VpcId string
    The vpc ID of the RDS instance.
    Zone string
    The available zone of the RDS instance.
    AutoRenew 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 string
    Database type. Value: MySQL (default).
    InstanceName 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 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 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 string
    The region of the RDS instance.
    SuperAccountName 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 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 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 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 String
    Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
    dbEngineVersion String
    Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
    instanceSpecName 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 String
    Instance type. Value: HA: High availability version.
    storageSpaceGb Integer
    The storage space(GB) of the RDS instance.
    storageType String
    Instance storage type. Value: LocalSSD: Local SSD disk.
    subnetId String
    Subnet ID. The subnet must belong to the selected Availability Zone.
    vpcId String
    The vpc ID of the RDS instance.
    zone String
    The available zone of the RDS instance.
    autoRenew 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 String
    Database type. Value: MySQL (default).
    instanceName 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 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 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 String
    The region of the RDS instance.
    superAccountName 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 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 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 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 string
    Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
    dbEngineVersion string
    Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
    instanceSpecName 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 string
    Instance type. Value: HA: High availability version.
    storageSpaceGb number
    The storage space(GB) of the RDS instance.
    storageType string
    Instance storage type. Value: LocalSSD: Local SSD disk.
    subnetId string
    Subnet ID. The subnet must belong to the selected Availability Zone.
    vpcId string
    The vpc ID of the RDS instance.
    zone string
    The available zone of the RDS instance.
    autoRenew 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 string
    Database type. Value: MySQL (default).
    instanceName 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 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 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 string
    The region of the RDS instance.
    superAccountName 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 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 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 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 str
    Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
    db_engine_version str
    Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
    instance_spec_name 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 str
    Instance type. Value: HA: High availability version.
    storage_space_gb int
    The storage space(GB) of the RDS instance.
    storage_type str
    Instance storage type. Value: LocalSSD: Local SSD disk.
    subnet_id str
    Subnet ID. The subnet must belong to the selected Availability Zone.
    vpc_id str
    The vpc ID of the RDS instance.
    zone str
    The available zone of the RDS instance.
    auto_renew 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 str
    Database type. Value: MySQL (default).
    instance_name 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 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 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 str
    The region of the RDS instance.
    super_account_name 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 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 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 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 String
    Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
    dbEngineVersion String
    Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
    instanceSpecName 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 String
    Instance type. Value: HA: High availability version.
    storageSpaceGb Number
    The storage space(GB) of the RDS instance.
    storageType String
    Instance storage type. Value: LocalSSD: Local SSD disk.
    subnetId String
    Subnet ID. The subnet must belong to the selected Availability Zone.
    vpcId String
    The vpc ID of the RDS instance.
    zone String
    The available zone of the RDS instance.
    autoRenew 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 String
    Database type. Value: MySQL (default).
    instanceName 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 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 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 String
    The region of the RDS instance.
    superAccountName 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 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 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 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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoRenew 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 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 string
    Database type. Value: MySQL (default).
    DbEngineVersion string
    Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
    InstanceName 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 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 string
    Instance type. Value: HA: High availability version.
    PrepaidPeriod 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 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 string
    The region of the RDS instance.
    StorageSpaceGb int
    The storage space(GB) of the RDS instance.
    StorageType string
    Instance storage type. Value: LocalSSD: Local SSD disk.
    SubnetId string
    Subnet ID. The subnet must belong to the selected Availability Zone.
    SuperAccountName 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 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 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 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 string
    The vpc ID of the RDS instance.
    Zone string
    The available zone of the RDS instance.
    AutoRenew 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 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 string
    Database type. Value: MySQL (default).
    DbEngineVersion string
    Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
    InstanceName 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 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 string
    Instance type. Value: HA: High availability version.
    PrepaidPeriod 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 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 string
    The region of the RDS instance.
    StorageSpaceGb int
    The storage space(GB) of the RDS instance.
    StorageType string
    Instance storage type. Value: LocalSSD: Local SSD disk.
    SubnetId string
    Subnet ID. The subnet must belong to the selected Availability Zone.
    SuperAccountName 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 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 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 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 string
    The vpc ID of the RDS instance.
    Zone string
    The available zone of the RDS instance.
    autoRenew 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 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 String
    Database type. Value: MySQL (default).
    dbEngineVersion String
    Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
    instanceName 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 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 String
    Instance type. Value: HA: High availability version.
    prepaidPeriod 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 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 String
    The region of the RDS instance.
    storageSpaceGb Integer
    The storage space(GB) of the RDS instance.
    storageType String
    Instance storage type. Value: LocalSSD: Local SSD disk.
    subnetId String
    Subnet ID. The subnet must belong to the selected Availability Zone.
    superAccountName 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 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 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 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 String
    The vpc ID of the RDS instance.
    zone String
    The available zone of the RDS instance.
    autoRenew 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 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 string
    Database type. Value: MySQL (default).
    dbEngineVersion string
    Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
    instanceName 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 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 string
    Instance type. Value: HA: High availability version.
    prepaidPeriod 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 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 string
    The region of the RDS instance.
    storageSpaceGb number
    The storage space(GB) of the RDS instance.
    storageType string
    Instance storage type. Value: LocalSSD: Local SSD disk.
    subnetId string
    Subnet ID. The subnet must belong to the selected Availability Zone.
    superAccountName 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 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 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 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 string
    The vpc ID of the RDS instance.
    zone string
    The available zone of the RDS instance.
    auto_renew 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 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 str
    Database type. Value: MySQL (default).
    db_engine_version str
    Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
    instance_name 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 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 str
    Instance type. Value: HA: High availability version.
    prepaid_period 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 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 str
    The region of the RDS instance.
    storage_space_gb int
    The storage space(GB) of the RDS instance.
    storage_type str
    Instance storage type. Value: LocalSSD: Local SSD disk.
    subnet_id str
    Subnet ID. The subnet must belong to the selected Availability Zone.
    super_account_name 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 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 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 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 str
    The vpc ID of the RDS instance.
    zone str
    The available zone of the RDS instance.
    autoRenew 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 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 String
    Database type. Value: MySQL (default).
    dbEngineVersion String
    Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
    instanceName 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 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 String
    Instance type. Value: HA: High availability version.
    prepaidPeriod 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 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 String
    The region of the RDS instance.
    storageSpaceGb Number
    The storage space(GB) of the RDS instance.
    storageType String
    Instance storage type. Value: LocalSSD: Local SSD disk.
    subnetId String
    Subnet ID. The subnet must belong to the selected Availability Zone.
    superAccountName 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 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 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 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 String
    The vpc ID of the RDS instance.
    zone 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

    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 logo
    Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
    volcengine/pulumi-volcengine