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",
});
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
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",
});
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:
- Charge
Type This property is required. Changes to this property will trigger replacement.
- 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.
- Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
- Instance
Spec Name This property is required. Changes to this property will trigger replacement.
- 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.
- Instance type. Value: HA: High availability version.
- Storage
Space Gb This property is required. Changes to this property will trigger replacement.
- The storage space(GB) of the RDS instance.
- Storage
Type This property is required. Changes to this property will trigger replacement.
- Instance storage type. Value: LocalSSD: Local SSD disk.
- Subnet
Id This property is required. Changes to this property will trigger replacement.
- Subnet ID. The subnet must belong to the selected Availability Zone.
- Vpc
Id This property is required. Changes to this property will trigger replacement.
- The vpc ID of the RDS instance.
- Zone
This property is required. Changes to this property will trigger replacement.
- The available zone of the RDS instance.
- Auto
Renew Changes to this property will trigger replacement.
- 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.
- Database type. Value: MySQL (default).
- Instance
Name Changes to this property will trigger replacement.
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.
- 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.
- 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.
- The region of the RDS instance.
- Super
Account Name Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- Used
Time Changes to this property will trigger replacement.
- 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.
- 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.
- Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
- Instance
Spec Name This property is required. Changes to this property will trigger replacement.
- 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.
- Instance type. Value: HA: High availability version.
- Storage
Space Gb This property is required. Changes to this property will trigger replacement.
- The storage space(GB) of the RDS instance.
- Storage
Type This property is required. Changes to this property will trigger replacement.
- Instance storage type. Value: LocalSSD: Local SSD disk.
- Subnet
Id This property is required. Changes to this property will trigger replacement.
- Subnet ID. The subnet must belong to the selected Availability Zone.
- Vpc
Id This property is required. Changes to this property will trigger replacement.
- The vpc ID of the RDS instance.
- Zone
This property is required. Changes to this property will trigger replacement.
- The available zone of the RDS instance.
- Auto
Renew Changes to this property will trigger replacement.
- 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.
- Database type. Value: MySQL (default).
- Instance
Name Changes to this property will trigger replacement.
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.
- 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.
- 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.
- The region of the RDS instance.
- Super
Account Name Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- Used
Time Changes to this property will trigger replacement.
- 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.
- 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.
- Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
- instance
Spec Name This property is required. Changes to this property will trigger replacement.
- 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.
- Instance type. Value: HA: High availability version.
- storage
Space Gb This property is required. Changes to this property will trigger replacement.
- The storage space(GB) of the RDS instance.
- storage
Type This property is required. Changes to this property will trigger replacement.
- Instance storage type. Value: LocalSSD: Local SSD disk.
- subnet
Id This property is required. Changes to this property will trigger replacement.
- Subnet ID. The subnet must belong to the selected Availability Zone.
- vpc
Id This property is required. Changes to this property will trigger replacement.
- The vpc ID of the RDS instance.
- zone
This property is required. Changes to this property will trigger replacement.
- The available zone of the RDS instance.
- auto
Renew Changes to this property will trigger replacement.
- 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.
- Database type. Value: MySQL (default).
- instance
Name Changes to this property will trigger replacement.
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.
- 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.
- 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.
- The region of the RDS instance.
- super
Account Name Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- used
Time Changes to this property will trigger replacement.
- 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.
- 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.
- Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
- instance
Spec Name This property is required. Changes to this property will trigger replacement.
- 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.
- Instance type. Value: HA: High availability version.
- storage
Space Gb This property is required. Changes to this property will trigger replacement.
- The storage space(GB) of the RDS instance.
- storage
Type This property is required. Changes to this property will trigger replacement.
- Instance storage type. Value: LocalSSD: Local SSD disk.
- subnet
Id This property is required. Changes to this property will trigger replacement.
- Subnet ID. The subnet must belong to the selected Availability Zone.
- vpc
Id This property is required. Changes to this property will trigger replacement.
- The vpc ID of the RDS instance.
- zone
This property is required. Changes to this property will trigger replacement.
- The available zone of the RDS instance.
- auto
Renew Changes to this property will trigger replacement.
- 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.
- Database type. Value: MySQL (default).
- instance
Name Changes to this property will trigger replacement.
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.
- 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.
- 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.
- The region of the RDS instance.
- super
Account Name Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- used
Time Changes to this property will trigger replacement.
- 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.
- 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.
- Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
- instance_
spec_ name This property is required. Changes to this property will trigger replacement.
- 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.
- Instance type. Value: HA: High availability version.
- storage_
space_ gb This property is required. Changes to this property will trigger replacement.
- The storage space(GB) of the RDS instance.
- storage_
type This property is required. Changes to this property will trigger replacement.
- Instance storage type. Value: LocalSSD: Local SSD disk.
- subnet_
id This property is required. Changes to this property will trigger replacement.
- Subnet ID. The subnet must belong to the selected Availability Zone.
- vpc_
id This property is required. Changes to this property will trigger replacement.
- The vpc ID of the RDS instance.
- zone
This property is required. Changes to this property will trigger replacement.
- The available zone of the RDS instance.
- auto_
renew Changes to this property will trigger replacement.
- 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.
- Database type. Value: MySQL (default).
- instance_
name Changes to this property will trigger replacement.
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.
- 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.
- 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.
- The region of the RDS instance.
- super_
account_ name Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- used_
time Changes to this property will trigger replacement.
- 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.
- 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.
- Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
- instance
Spec Name This property is required. Changes to this property will trigger replacement.
- 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.
- Instance type. Value: HA: High availability version.
- storage
Space Gb This property is required. Changes to this property will trigger replacement.
- The storage space(GB) of the RDS instance.
- storage
Type This property is required. Changes to this property will trigger replacement.
- Instance storage type. Value: LocalSSD: Local SSD disk.
- subnet
Id This property is required. Changes to this property will trigger replacement.
- Subnet ID. The subnet must belong to the selected Availability Zone.
- vpc
Id This property is required. Changes to this property will trigger replacement.
- The vpc ID of the RDS instance.
- zone
This property is required. Changes to this property will trigger replacement.
- The available zone of the RDS instance.
- auto
Renew Changes to this property will trigger replacement.
- 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.
- Database type. Value: MySQL (default).
- instance
Name Changes to this property will trigger replacement.
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.
- 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.
- 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.
- The region of the RDS instance.
- super
Account Name Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- used
Time Changes to this property will trigger replacement.
- 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:
- Connection
Info InstanceConnection Info - The connection info ot the RDS instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Connection
Info InstanceConnection Info - The connection info ot the RDS instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- connection
Info InstanceConnection Info - The connection info ot the RDS instance.
- id String
- The provider-assigned unique ID for this managed resource.
- connection
Info InstanceConnection Info - The connection info ot the RDS instance.
- id string
- The provider-assigned unique ID for this managed resource.
- connection_
info InstanceConnection Info - The connection info ot the RDS instance.
- id str
- The provider-assigned unique ID for this managed resource.
- connection
Info 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.
- Auto
Renew Changes to this property will trigger replacement.
- 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.
- Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
- Connection
Info InstanceConnection Info - The connection info ot the RDS instance.
- Db
Engine Changes to this property will trigger replacement.
- Database type. Value: MySQL (default).
- Db
Engine Version Changes to this property will trigger replacement.
- Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
- Instance
Name Changes to this property will trigger replacement.
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.
- 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.
- Instance type. Value: HA: High availability version.
- Prepaid
Period Changes to this property will trigger replacement.
- 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.
- 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.
- The region of the RDS instance.
- Storage
Space Gb Changes to this property will trigger replacement.
- The storage space(GB) of the RDS instance.
- Storage
Type Changes to this property will trigger replacement.
- Instance storage type. Value: LocalSSD: Local SSD disk.
- Subnet
Id Changes to this property will trigger replacement.
- Subnet ID. The subnet must belong to the selected Availability Zone.
- Super
Account Name Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- Used
Time Changes to this property will trigger replacement.
- 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.
- The vpc ID of the RDS instance.
- Zone
Changes to this property will trigger replacement.
- The available zone of the RDS instance.
- Auto
Renew Changes to this property will trigger replacement.
- 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.
- Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
- Connection
Info InstanceConnection Info Args - The connection info ot the RDS instance.
- Db
Engine Changes to this property will trigger replacement.
- Database type. Value: MySQL (default).
- Db
Engine Version Changes to this property will trigger replacement.
- Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
- Instance
Name Changes to this property will trigger replacement.
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.
- 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.
- Instance type. Value: HA: High availability version.
- Prepaid
Period Changes to this property will trigger replacement.
- 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.
- 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.
- The region of the RDS instance.
- Storage
Space Gb Changes to this property will trigger replacement.
- The storage space(GB) of the RDS instance.
- Storage
Type Changes to this property will trigger replacement.
- Instance storage type. Value: LocalSSD: Local SSD disk.
- Subnet
Id Changes to this property will trigger replacement.
- Subnet ID. The subnet must belong to the selected Availability Zone.
- Super
Account Name Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- Used
Time Changes to this property will trigger replacement.
- 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.
- The vpc ID of the RDS instance.
- Zone
Changes to this property will trigger replacement.
- The available zone of the RDS instance.
- auto
Renew Changes to this property will trigger replacement.
- 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.
- Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
- connection
Info InstanceConnection Info - The connection info ot the RDS instance.
- db
Engine Changes to this property will trigger replacement.
- Database type. Value: MySQL (default).
- db
Engine Version Changes to this property will trigger replacement.
- Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
- instance
Name Changes to this property will trigger replacement.
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.
- 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.
- Instance type. Value: HA: High availability version.
- prepaid
Period Changes to this property will trigger replacement.
- 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.
- 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.
- The region of the RDS instance.
- storage
Space Gb Changes to this property will trigger replacement.
- The storage space(GB) of the RDS instance.
- storage
Type Changes to this property will trigger replacement.
- Instance storage type. Value: LocalSSD: Local SSD disk.
- subnet
Id Changes to this property will trigger replacement.
- Subnet ID. The subnet must belong to the selected Availability Zone.
- super
Account Name Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- used
Time Changes to this property will trigger replacement.
- 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.
- The vpc ID of the RDS instance.
- zone
Changes to this property will trigger replacement.
- The available zone of the RDS instance.
- auto
Renew Changes to this property will trigger replacement.
- 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.
- Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
- connection
Info InstanceConnection Info - The connection info ot the RDS instance.
- db
Engine Changes to this property will trigger replacement.
- Database type. Value: MySQL (default).
- db
Engine Version Changes to this property will trigger replacement.
- Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
- instance
Name Changes to this property will trigger replacement.
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.
- 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.
- Instance type. Value: HA: High availability version.
- prepaid
Period Changes to this property will trigger replacement.
- 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.
- 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.
- The region of the RDS instance.
- storage
Space Gb Changes to this property will trigger replacement.
- The storage space(GB) of the RDS instance.
- storage
Type Changes to this property will trigger replacement.
- Instance storage type. Value: LocalSSD: Local SSD disk.
- subnet
Id Changes to this property will trigger replacement.
- Subnet ID. The subnet must belong to the selected Availability Zone.
- super
Account Name Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- used
Time Changes to this property will trigger replacement.
- 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.
- The vpc ID of the RDS instance.
- zone
Changes to this property will trigger replacement.
- The available zone of the RDS instance.
- auto_
renew Changes to this property will trigger replacement.
- 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.
- Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
- connection_
info InstanceConnection Info Args - The connection info ot the RDS instance.
- db_
engine Changes to this property will trigger replacement.
- Database type. Value: MySQL (default).
- db_
engine_ version Changes to this property will trigger replacement.
- Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
- instance_
name Changes to this property will trigger replacement.
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.
- 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.
- Instance type. Value: HA: High availability version.
- prepaid_
period Changes to this property will trigger replacement.
- 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.
- 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.
- The region of the RDS instance.
- storage_
space_ gb Changes to this property will trigger replacement.
- The storage space(GB) of the RDS instance.
- storage_
type Changes to this property will trigger replacement.
- Instance storage type. Value: LocalSSD: Local SSD disk.
- subnet_
id Changes to this property will trigger replacement.
- Subnet ID. The subnet must belong to the selected Availability Zone.
- super_
account_ name Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- used_
time Changes to this property will trigger replacement.
- 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.
- The vpc ID of the RDS instance.
- zone
Changes to this property will trigger replacement.
- The available zone of the RDS instance.
- auto
Renew Changes to this property will trigger replacement.
- 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.
- Billing type. Value: PostPaid: Postpaid (pay-as-you-go). Prepaid: Prepaid (yearly and monthly).
- connection
Info Property Map - The connection info ot the RDS instance.
- db
Engine Changes to this property will trigger replacement.
- Database type. Value: MySQL (default).
- db
Engine Version Changes to this property will trigger replacement.
- Instance type. Value: MySQL_Community_5_7 MySQL_8_0.
- instance
Name Changes to this property will trigger replacement.
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.
- 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.
- Instance type. Value: HA: High availability version.
- prepaid
Period Changes to this property will trigger replacement.
- 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.
- 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.
- The region of the RDS instance.
- storage
Space Gb Changes to this property will trigger replacement.
- The storage space(GB) of the RDS instance.
- storage
Type Changes to this property will trigger replacement.
- Instance storage type. Value: LocalSSD: Local SSD disk.
- subnet
Id Changes to this property will trigger replacement.
- Subnet ID. The subnet must belong to the selected Availability Zone.
- super
Account Name Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- used
Time Changes to this property will trigger replacement.
- 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.
- The vpc ID of the RDS instance.
- zone
Changes to this property will trigger replacement.
- The available zone of the RDS instance.
Supporting Types
InstanceConnectionInfo, InstanceConnectionInfoArgs
- Enable
Read stringOnly - Whether global read-only is enabled.
- Enable
Read stringWrite Splitting - Whether read-write separation is enabled.
- Internal
Domain string - The internal domain of the RDS instance.
- Internal
Port string - The interval port of the RDS instance.
- Public
Domain string - The public domain of the RDS instance.
- Public
Port string - The public port of the RDS instance.
- Enable
Read stringOnly - Whether global read-only is enabled.
- Enable
Read stringWrite Splitting - Whether read-write separation is enabled.
- Internal
Domain string - The internal domain of the RDS instance.
- Internal
Port string - The interval port of the RDS instance.
- Public
Domain string - The public domain of the RDS instance.
- Public
Port string - The public port of the RDS instance.
- enable
Read StringOnly - Whether global read-only is enabled.
- enable
Read StringWrite Splitting - Whether read-write separation is enabled.
- internal
Domain String - The internal domain of the RDS instance.
- internal
Port String - The interval port of the RDS instance.
- public
Domain String - The public domain of the RDS instance.
- public
Port String - The public port of the RDS instance.
- enable
Read stringOnly - Whether global read-only is enabled.
- enable
Read stringWrite Splitting - Whether read-write separation is enabled.
- internal
Domain string - The internal domain of the RDS instance.
- internal
Port string - The interval port of the RDS instance.
- public
Domain string - The public domain of the RDS instance.
- public
Port string - The public port of the RDS instance.
- enable_
read_ stronly - Whether global read-only is enabled.
- enable_
read_ strwrite_ splitting - 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.
- enable
Read StringOnly - Whether global read-only is enabled.
- enable
Read StringWrite Splitting - Whether read-write separation is enabled.
- internal
Domain String - The internal domain of the RDS instance.
- internal
Port String - The interval port of the RDS instance.
- public
Domain String - The public domain of the RDS instance.
- public
Port 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.