volcengine.rds_mysql.Instance
Explore with Pulumi AI
Provides a resource to manage rds mysql instance
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var fooZones = Volcengine.Ecs.Zones.Invoke();
var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
{
VpcName = "acc-test-project1",
CidrBlock = "172.16.0.0/16",
});
var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
{
SubnetName = "acc-subnet-test-2",
CidrBlock = "172.16.0.0/24",
ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
VpcId = fooVpc.Id,
});
var fooInstance = new Volcengine.Rds_mysql.Instance("fooInstance", new()
{
DbEngineVersion = "MySQL_5_7",
NodeSpec = "rds.mysql.1c2g",
PrimaryZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
SecondaryZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
StorageSpace = 80,
SubnetId = fooSubnet.Id,
InstanceName = "acc-test",
LowerCaseTableNames = "1",
ChargeInfo = new Volcengine.Rds_mysql.Inputs.InstanceChargeInfoArgs
{
ChargeType = "PostPaid",
},
Parameters = new[]
{
new Volcengine.Rds_mysql.Inputs.InstanceParameterArgs
{
ParameterName = "auto_increment_increment",
ParameterValue = "2",
},
new Volcengine.Rds_mysql.Inputs.InstanceParameterArgs
{
ParameterName = "auto_increment_offset",
ParameterValue = "4",
},
},
ProjectName = "default",
Tags = new[]
{
new Volcengine.Rds_mysql.Inputs.InstanceTagArgs
{
Key = "k1",
Value = "v1",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds_mysql"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
fooZones, err := ecs.Zones(ctx, nil, nil)
if err != nil {
return err
}
fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
VpcName: pulumi.String("acc-test-project1"),
CidrBlock: pulumi.String("172.16.0.0/16"),
})
if err != nil {
return err
}
fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
SubnetName: pulumi.String("acc-subnet-test-2"),
CidrBlock: pulumi.String("172.16.0.0/24"),
ZoneId: *pulumi.String(fooZones.Zones[0].Id),
VpcId: fooVpc.ID(),
})
if err != nil {
return err
}
_, err = rds_mysql.NewInstance(ctx, "fooInstance", &rds_mysql.InstanceArgs{
DbEngineVersion: pulumi.String("MySQL_5_7"),
NodeSpec: pulumi.String("rds.mysql.1c2g"),
PrimaryZoneId: *pulumi.String(fooZones.Zones[0].Id),
SecondaryZoneId: *pulumi.String(fooZones.Zones[0].Id),
StorageSpace: pulumi.Int(80),
SubnetId: fooSubnet.ID(),
InstanceName: pulumi.String("acc-test"),
LowerCaseTableNames: pulumi.String("1"),
ChargeInfo: &rds_mysql.InstanceChargeInfoArgs{
ChargeType: pulumi.String("PostPaid"),
},
Parameters: rds_mysql.InstanceParameterArray{
&rds_mysql.InstanceParameterArgs{
ParameterName: pulumi.String("auto_increment_increment"),
ParameterValue: pulumi.String("2"),
},
&rds_mysql.InstanceParameterArgs{
ParameterName: pulumi.String("auto_increment_offset"),
ParameterValue: pulumi.String("4"),
},
},
ProjectName: pulumi.String("default"),
Tags: rds_mysql.InstanceTagArray{
&rds_mysql.InstanceTagArgs{
Key: pulumi.String("k1"),
Value: pulumi.String("v1"),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.rds_mysql.Instance;
import com.pulumi.volcengine.rds_mysql.InstanceArgs;
import com.pulumi.volcengine.rds_mysql.inputs.InstanceChargeInfoArgs;
import com.pulumi.volcengine.rds_mysql.inputs.InstanceParameterArgs;
import com.pulumi.volcengine.rds_mysql.inputs.InstanceTagArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var fooZones = EcsFunctions.Zones();
var fooVpc = new Vpc("fooVpc", VpcArgs.builder()
.vpcName("acc-test-project1")
.cidrBlock("172.16.0.0/16")
.build());
var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()
.subnetName("acc-subnet-test-2")
.cidrBlock("172.16.0.0/24")
.zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
.vpcId(fooVpc.id())
.build());
var fooInstance = new Instance("fooInstance", InstanceArgs.builder()
.dbEngineVersion("MySQL_5_7")
.nodeSpec("rds.mysql.1c2g")
.primaryZoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
.secondaryZoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
.storageSpace(80)
.subnetId(fooSubnet.id())
.instanceName("acc-test")
.lowerCaseTableNames("1")
.chargeInfo(InstanceChargeInfoArgs.builder()
.chargeType("PostPaid")
.build())
.parameters(
InstanceParameterArgs.builder()
.parameterName("auto_increment_increment")
.parameterValue("2")
.build(),
InstanceParameterArgs.builder()
.parameterName("auto_increment_offset")
.parameterValue("4")
.build())
.projectName("default")
.tags(InstanceTagArgs.builder()
.key("k1")
.value("v1")
.build())
.build());
}
}
import pulumi
import pulumi_volcengine as volcengine
foo_zones = volcengine.ecs.zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
vpc_name="acc-test-project1",
cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
subnet_name="acc-subnet-test-2",
cidr_block="172.16.0.0/24",
zone_id=foo_zones.zones[0].id,
vpc_id=foo_vpc.id)
foo_instance = volcengine.rds_mysql.Instance("fooInstance",
db_engine_version="MySQL_5_7",
node_spec="rds.mysql.1c2g",
primary_zone_id=foo_zones.zones[0].id,
secondary_zone_id=foo_zones.zones[0].id,
storage_space=80,
subnet_id=foo_subnet.id,
instance_name="acc-test",
lower_case_table_names="1",
charge_info=volcengine.rds_mysql.InstanceChargeInfoArgs(
charge_type="PostPaid",
),
parameters=[
volcengine.rds_mysql.InstanceParameterArgs(
parameter_name="auto_increment_increment",
parameter_value="2",
),
volcengine.rds_mysql.InstanceParameterArgs(
parameter_name="auto_increment_offset",
parameter_value="4",
),
],
project_name="default",
tags=[volcengine.rds_mysql.InstanceTagArgs(
key="k1",
value="v1",
)])
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
import * as volcengine from "@volcengine/pulumi";
const fooZones = volcengine.ecs.Zones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
vpcName: "acc-test-project1",
cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
subnetName: "acc-subnet-test-2",
cidrBlock: "172.16.0.0/24",
zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
vpcId: fooVpc.id,
});
const fooInstance = new volcengine.rds_mysql.Instance("fooInstance", {
dbEngineVersion: "MySQL_5_7",
nodeSpec: "rds.mysql.1c2g",
primaryZoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
secondaryZoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
storageSpace: 80,
subnetId: fooSubnet.id,
instanceName: "acc-test",
lowerCaseTableNames: "1",
chargeInfo: {
chargeType: "PostPaid",
},
parameters: [
{
parameterName: "auto_increment_increment",
parameterValue: "2",
},
{
parameterName: "auto_increment_offset",
parameterValue: "4",
},
],
projectName: "default",
tags: [{
key: "k1",
value: "v1",
}],
});
resources:
fooVpc:
type: volcengine:vpc:Vpc
properties:
vpcName: acc-test-project1
cidrBlock: 172.16.0.0/16
fooSubnet:
type: volcengine:vpc:Subnet
properties:
subnetName: acc-subnet-test-2
cidrBlock: 172.16.0.0/24
zoneId: ${fooZones.zones[0].id}
vpcId: ${fooVpc.id}
fooInstance:
type: volcengine:rds_mysql:Instance
properties:
dbEngineVersion: MySQL_5_7
nodeSpec: rds.mysql.1c2g
primaryZoneId: ${fooZones.zones[0].id}
secondaryZoneId: ${fooZones.zones[0].id}
storageSpace: 80
subnetId: ${fooSubnet.id}
instanceName: acc-test
lowerCaseTableNames: '1'
chargeInfo:
chargeType: PostPaid
parameters:
- parameterName: auto_increment_increment
parameterValue: '2'
- parameterName: auto_increment_offset
parameterValue: '4'
projectName: default
tags:
- key: k1
value: v1
variables:
fooZones:
fn::invoke:
Function: volcengine:ecs:Zones
Arguments: {}
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,
node_spec: Optional[str] = None,
charge_info: Optional[InstanceChargeInfoArgs] = None,
db_engine_version: Optional[str] = None,
subnet_id: Optional[str] = None,
secondary_zone_id: Optional[str] = None,
primary_zone_id: Optional[str] = None,
db_time_zone: Optional[str] = None,
parameters: Optional[Sequence[InstanceParameterArgs]] = None,
lower_case_table_names: Optional[str] = None,
project_name: Optional[str] = None,
instance_name: Optional[str] = None,
storage_space: Optional[int] = None,
allow_list_ids: Optional[Sequence[str]] = None,
tags: Optional[Sequence[InstanceTagArgs]] = 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_mysql: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 exampleinstanceResourceResourceFromRds_mysqlinstance = new Volcengine.Rds_mysql.Instance("exampleinstanceResourceResourceFromRds_mysqlinstance", new()
{
NodeSpec = "string",
ChargeInfo = new Volcengine.Rds_mysql.Inputs.InstanceChargeInfoArgs
{
ChargeType = "string",
AutoRenew = false,
Period = 0,
PeriodUnit = "string",
},
DbEngineVersion = "string",
SubnetId = "string",
SecondaryZoneId = "string",
PrimaryZoneId = "string",
DbTimeZone = "string",
Parameters = new[]
{
new Volcengine.Rds_mysql.Inputs.InstanceParameterArgs
{
ParameterName = "string",
ParameterValue = "string",
},
},
LowerCaseTableNames = "string",
ProjectName = "string",
InstanceName = "string",
StorageSpace = 0,
AllowListIds = new[]
{
"string",
},
Tags = new[]
{
new Volcengine.Rds_mysql.Inputs.InstanceTagArgs
{
Key = "string",
Value = "string",
},
},
});
example, err := rds_mysql.NewInstance(ctx, "exampleinstanceResourceResourceFromRds_mysqlinstance", &rds_mysql.InstanceArgs{
NodeSpec: pulumi.String("string"),
ChargeInfo: &rds_mysql.InstanceChargeInfoArgs{
ChargeType: pulumi.String("string"),
AutoRenew: pulumi.Bool(false),
Period: pulumi.Int(0),
PeriodUnit: pulumi.String("string"),
},
DbEngineVersion: pulumi.String("string"),
SubnetId: pulumi.String("string"),
SecondaryZoneId: pulumi.String("string"),
PrimaryZoneId: pulumi.String("string"),
DbTimeZone: pulumi.String("string"),
Parameters: rds_mysql.InstanceParameterArray{
&rds_mysql.InstanceParameterArgs{
ParameterName: pulumi.String("string"),
ParameterValue: pulumi.String("string"),
},
},
LowerCaseTableNames: pulumi.String("string"),
ProjectName: pulumi.String("string"),
InstanceName: pulumi.String("string"),
StorageSpace: pulumi.Int(0),
AllowListIds: pulumi.StringArray{
pulumi.String("string"),
},
Tags: rds_mysql.InstanceTagArray{
&rds_mysql.InstanceTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
})
var exampleinstanceResourceResourceFromRds_mysqlinstance = new Instance("exampleinstanceResourceResourceFromRds_mysqlinstance", InstanceArgs.builder()
.nodeSpec("string")
.chargeInfo(InstanceChargeInfoArgs.builder()
.chargeType("string")
.autoRenew(false)
.period(0)
.periodUnit("string")
.build())
.dbEngineVersion("string")
.subnetId("string")
.secondaryZoneId("string")
.primaryZoneId("string")
.dbTimeZone("string")
.parameters(InstanceParameterArgs.builder()
.parameterName("string")
.parameterValue("string")
.build())
.lowerCaseTableNames("string")
.projectName("string")
.instanceName("string")
.storageSpace(0)
.allowListIds("string")
.tags(InstanceTagArgs.builder()
.key("string")
.value("string")
.build())
.build());
exampleinstance_resource_resource_from_rds_mysqlinstance = volcengine.rds_mysql.Instance("exampleinstanceResourceResourceFromRds_mysqlinstance",
node_spec="string",
charge_info={
"charge_type": "string",
"auto_renew": False,
"period": 0,
"period_unit": "string",
},
db_engine_version="string",
subnet_id="string",
secondary_zone_id="string",
primary_zone_id="string",
db_time_zone="string",
parameters=[{
"parameter_name": "string",
"parameter_value": "string",
}],
lower_case_table_names="string",
project_name="string",
instance_name="string",
storage_space=0,
allow_list_ids=["string"],
tags=[{
"key": "string",
"value": "string",
}])
const exampleinstanceResourceResourceFromRds_mysqlinstance = new volcengine.rds_mysql.Instance("exampleinstanceResourceResourceFromRds_mysqlinstance", {
nodeSpec: "string",
chargeInfo: {
chargeType: "string",
autoRenew: false,
period: 0,
periodUnit: "string",
},
dbEngineVersion: "string",
subnetId: "string",
secondaryZoneId: "string",
primaryZoneId: "string",
dbTimeZone: "string",
parameters: [{
parameterName: "string",
parameterValue: "string",
}],
lowerCaseTableNames: "string",
projectName: "string",
instanceName: "string",
storageSpace: 0,
allowListIds: ["string"],
tags: [{
key: "string",
value: "string",
}],
});
type: volcengine:rds_mysql:Instance
properties:
allowListIds:
- string
chargeInfo:
autoRenew: false
chargeType: string
period: 0
periodUnit: string
dbEngineVersion: string
dbTimeZone: string
instanceName: string
lowerCaseTableNames: string
nodeSpec: string
parameters:
- parameterName: string
parameterValue: string
primaryZoneId: string
projectName: string
secondaryZoneId: string
storageSpace: 0
subnetId: string
tags:
- key: string
value: 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
Info InstanceCharge Info - Payment methods.
- Db
Engine stringVersion - Instance type. Value: MySQL_5_7 MySQL_8_0.
- Node
Spec string - The specification of primary node and secondary node.
- Primary
Zone stringId - The available zone of primary node.
- Secondary
Zone stringId - The available zone of secondary node.
- Subnet
Id string - Subnet ID of the RDS instance.
- Allow
List List<string>Ids - Allow list Ids of the RDS instance.
- Db
Time stringZone - Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
- Instance
Name string - Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
- Lower
Case stringTable Names - Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
- Parameters
List<Instance
Parameter> - Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid.
- Project
Name string - The project name of the RDS instance.
- Storage
Space int - Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
- List<Instance
Tag> - Tags.
- Charge
Info InstanceCharge Info Args - Payment methods.
- Db
Engine stringVersion - Instance type. Value: MySQL_5_7 MySQL_8_0.
- Node
Spec string - The specification of primary node and secondary node.
- Primary
Zone stringId - The available zone of primary node.
- Secondary
Zone stringId - The available zone of secondary node.
- Subnet
Id string - Subnet ID of the RDS instance.
- Allow
List []stringIds - Allow list Ids of the RDS instance.
- Db
Time stringZone - Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
- Instance
Name string - Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
- Lower
Case stringTable Names - Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
- Parameters
[]Instance
Parameter Args - Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid.
- Project
Name string - The project name of the RDS instance.
- Storage
Space int - Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
- []Instance
Tag Args - Tags.
- charge
Info InstanceCharge Info - Payment methods.
- db
Engine StringVersion - Instance type. Value: MySQL_5_7 MySQL_8_0.
- node
Spec String - The specification of primary node and secondary node.
- primary
Zone StringId - The available zone of primary node.
- secondary
Zone StringId - The available zone of secondary node.
- subnet
Id String - Subnet ID of the RDS instance.
- allow
List List<String>Ids - Allow list Ids of the RDS instance.
- db
Time StringZone - Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
- instance
Name String - Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
- lower
Case StringTable Names - Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
- parameters
List<Instance
Parameter> - Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid.
- project
Name String - The project name of the RDS instance.
- storage
Space Integer - Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
- List<Instance
Tag> - Tags.
- charge
Info InstanceCharge Info - Payment methods.
- db
Engine stringVersion - Instance type. Value: MySQL_5_7 MySQL_8_0.
- node
Spec string - The specification of primary node and secondary node.
- primary
Zone stringId - The available zone of primary node.
- secondary
Zone stringId - The available zone of secondary node.
- subnet
Id string - Subnet ID of the RDS instance.
- allow
List string[]Ids - Allow list Ids of the RDS instance.
- db
Time stringZone - Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
- instance
Name string - Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
- lower
Case stringTable Names - Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
- parameters
Instance
Parameter[] - Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid.
- project
Name string - The project name of the RDS instance.
- storage
Space number - Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
- Instance
Tag[] - Tags.
- charge_
info InstanceCharge Info Args - Payment methods.
- db_
engine_ strversion - Instance type. Value: MySQL_5_7 MySQL_8_0.
- node_
spec str - The specification of primary node and secondary node.
- primary_
zone_ strid - The available zone of primary node.
- secondary_
zone_ strid - The available zone of secondary node.
- subnet_
id str - Subnet ID of the RDS instance.
- allow_
list_ Sequence[str]ids - Allow list Ids of the RDS instance.
- db_
time_ strzone - Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
- instance_
name str - Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
- lower_
case_ strtable_ names - Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
- parameters
Sequence[Instance
Parameter Args] - Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid.
- project_
name str - The project name of the RDS instance.
- storage_
space int - Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
- Sequence[Instance
Tag Args] - Tags.
- charge
Info Property Map - Payment methods.
- db
Engine StringVersion - Instance type. Value: MySQL_5_7 MySQL_8_0.
- node
Spec String - The specification of primary node and secondary node.
- primary
Zone StringId - The available zone of primary node.
- secondary
Zone StringId - The available zone of secondary node.
- subnet
Id String - Subnet ID of the RDS instance.
- allow
List List<String>Ids - Allow list Ids of the RDS instance.
- db
Time StringZone - Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
- instance
Name String - Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
- lower
Case StringTable Names - Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
- parameters List<Property Map>
- Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid.
- project
Name String - The project name of the RDS instance.
- storage
Space Number - Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
- List<Property Map>
- Tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:
- Allow
List stringVersion - The version of allow list.
- Backup
Use int - The instance has used backup space. Unit: GB.
- Charge
Details List<InstanceCharge Detail> - Payment methods.
- Create
Time string - Node creation local time.
- Data
Sync stringMode - Data synchronization mode.
- Endpoints
List<Instance
Endpoint> - The endpoint info of the RDS instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Id string - Instance ID.
- Instance
Status string - The status of the RDS instance.
- Maintenance
Windows List<InstanceMaintenance Window> - Maintenance Window.
- Memory int
- Memory size in GB.
- Node
Number int - The number of nodes.
- Nodes
List<Instance
Node> - Instance node information.
- Region
Id string - The region of the RDS instance.
- Storage
Type string - Instance storage type.
- Storage
Use int - The instance has used storage space. Unit: GB.
- Time
Zone string - Time zone.
- Update
Time string - The update time of the RDS instance.
- VCpu int
- CPU size.
- Vpc
Id string - The vpc ID of the RDS instance.
- Zone
Id string - The available zone of the RDS instance.
- Allow
List stringVersion - The version of allow list.
- Backup
Use int - The instance has used backup space. Unit: GB.
- Charge
Details []InstanceCharge Detail - Payment methods.
- Create
Time string - Node creation local time.
- Data
Sync stringMode - Data synchronization mode.
- Endpoints
[]Instance
Endpoint - The endpoint info of the RDS instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Id string - Instance ID.
- Instance
Status string - The status of the RDS instance.
- Maintenance
Windows []InstanceMaintenance Window - Maintenance Window.
- Memory int
- Memory size in GB.
- Node
Number int - The number of nodes.
- Nodes
[]Instance
Node - Instance node information.
- Region
Id string - The region of the RDS instance.
- Storage
Type string - Instance storage type.
- Storage
Use int - The instance has used storage space. Unit: GB.
- Time
Zone string - Time zone.
- Update
Time string - The update time of the RDS instance.
- VCpu int
- CPU size.
- Vpc
Id string - The vpc ID of the RDS instance.
- Zone
Id string - The available zone of the RDS instance.
- allow
List StringVersion - The version of allow list.
- backup
Use Integer - The instance has used backup space. Unit: GB.
- charge
Details List<InstanceCharge Detail> - Payment methods.
- create
Time String - Node creation local time.
- data
Sync StringMode - Data synchronization mode.
- endpoints
List<Instance
Endpoint> - The endpoint info of the RDS instance.
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Id String - Instance ID.
- instance
Status String - The status of the RDS instance.
- maintenance
Windows List<InstanceMaintenance Window> - Maintenance Window.
- memory Integer
- Memory size in GB.
- node
Number Integer - The number of nodes.
- nodes
List<Instance
Node> - Instance node information.
- region
Id String - The region of the RDS instance.
- storage
Type String - Instance storage type.
- storage
Use Integer - The instance has used storage space. Unit: GB.
- time
Zone String - Time zone.
- update
Time String - The update time of the RDS instance.
- v
Cpu Integer - CPU size.
- vpc
Id String - The vpc ID of the RDS instance.
- zone
Id String - The available zone of the RDS instance.
- allow
List stringVersion - The version of allow list.
- backup
Use number - The instance has used backup space. Unit: GB.
- charge
Details InstanceCharge Detail[] - Payment methods.
- create
Time string - Node creation local time.
- data
Sync stringMode - Data synchronization mode.
- endpoints
Instance
Endpoint[] - The endpoint info of the RDS instance.
- id string
- The provider-assigned unique ID for this managed resource.
- instance
Id string - Instance ID.
- instance
Status string - The status of the RDS instance.
- maintenance
Windows InstanceMaintenance Window[] - Maintenance Window.
- memory number
- Memory size in GB.
- node
Number number - The number of nodes.
- nodes
Instance
Node[] - Instance node information.
- region
Id string - The region of the RDS instance.
- storage
Type string - Instance storage type.
- storage
Use number - The instance has used storage space. Unit: GB.
- time
Zone string - Time zone.
- update
Time string - The update time of the RDS instance.
- v
Cpu number - CPU size.
- vpc
Id string - The vpc ID of the RDS instance.
- zone
Id string - The available zone of the RDS instance.
- allow_
list_ strversion - The version of allow list.
- backup_
use int - The instance has used backup space. Unit: GB.
- charge_
details Sequence[InstanceCharge Detail] - Payment methods.
- create_
time str - Node creation local time.
- data_
sync_ strmode - Data synchronization mode.
- endpoints
Sequence[Instance
Endpoint] - The endpoint info of the RDS instance.
- id str
- The provider-assigned unique ID for this managed resource.
- instance_
id str - Instance ID.
- instance_
status str - The status of the RDS instance.
- maintenance_
windows Sequence[InstanceMaintenance Window] - Maintenance Window.
- memory int
- Memory size in GB.
- node_
number int - The number of nodes.
- nodes
Sequence[Instance
Node] - Instance node information.
- region_
id str - The region of the RDS instance.
- storage_
type str - Instance storage type.
- storage_
use int - The instance has used storage space. Unit: GB.
- time_
zone str - Time zone.
- update_
time str - The update time of the RDS instance.
- v_
cpu int - CPU size.
- vpc_
id str - The vpc ID of the RDS instance.
- zone_
id str - The available zone of the RDS instance.
- allow
List StringVersion - The version of allow list.
- backup
Use Number - The instance has used backup space. Unit: GB.
- charge
Details List<Property Map> - Payment methods.
- create
Time String - Node creation local time.
- data
Sync StringMode - Data synchronization mode.
- endpoints List<Property Map>
- The endpoint info of the RDS instance.
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Id String - Instance ID.
- instance
Status String - The status of the RDS instance.
- maintenance
Windows List<Property Map> - Maintenance Window.
- memory Number
- Memory size in GB.
- node
Number Number - The number of nodes.
- nodes List<Property Map>
- Instance node information.
- region
Id String - The region of the RDS instance.
- storage
Type String - Instance storage type.
- storage
Use Number - The instance has used storage space. Unit: GB.
- time
Zone String - Time zone.
- update
Time String - The update time of the RDS instance.
- v
Cpu Number - CPU size.
- vpc
Id String - The vpc ID of the RDS instance.
- zone
Id String - The available zone of the RDS instance.
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,
allow_list_ids: Optional[Sequence[str]] = None,
allow_list_version: Optional[str] = None,
backup_use: Optional[int] = None,
charge_details: Optional[Sequence[InstanceChargeDetailArgs]] = None,
charge_info: Optional[InstanceChargeInfoArgs] = None,
create_time: Optional[str] = None,
data_sync_mode: Optional[str] = None,
db_engine_version: Optional[str] = None,
db_time_zone: Optional[str] = None,
endpoints: Optional[Sequence[InstanceEndpointArgs]] = None,
instance_id: Optional[str] = None,
instance_name: Optional[str] = None,
instance_status: Optional[str] = None,
lower_case_table_names: Optional[str] = None,
maintenance_windows: Optional[Sequence[InstanceMaintenanceWindowArgs]] = None,
memory: Optional[int] = None,
node_number: Optional[int] = None,
node_spec: Optional[str] = None,
nodes: Optional[Sequence[InstanceNodeArgs]] = None,
parameters: Optional[Sequence[InstanceParameterArgs]] = None,
primary_zone_id: Optional[str] = None,
project_name: Optional[str] = None,
region_id: Optional[str] = None,
secondary_zone_id: Optional[str] = None,
storage_space: Optional[int] = None,
storage_type: Optional[str] = None,
storage_use: Optional[int] = None,
subnet_id: Optional[str] = None,
tags: Optional[Sequence[InstanceTagArgs]] = None,
time_zone: Optional[str] = None,
update_time: Optional[str] = None,
v_cpu: Optional[int] = None,
vpc_id: Optional[str] = None,
zone_id: 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)
Resource lookup is not supported in YAML
- 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.
- Allow
List List<string>Ids - Allow list Ids of the RDS instance.
- Allow
List stringVersion - The version of allow list.
- Backup
Use int - The instance has used backup space. Unit: GB.
- Charge
Details List<InstanceCharge Detail> - Payment methods.
- Charge
Info InstanceCharge Info - Payment methods.
- Create
Time string - Node creation local time.
- Data
Sync stringMode - Data synchronization mode.
- Db
Engine stringVersion - Instance type. Value: MySQL_5_7 MySQL_8_0.
- Db
Time stringZone - Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
- Endpoints
List<Instance
Endpoint> - The endpoint info of the RDS instance.
- Instance
Id string - Instance ID.
- Instance
Name string - Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
- Instance
Status string - The status of the RDS instance.
- Lower
Case stringTable Names - Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
- Maintenance
Windows List<InstanceMaintenance Window> - Maintenance Window.
- Memory int
- Memory size in GB.
- Node
Number int - The number of nodes.
- Node
Spec string - The specification of primary node and secondary node.
- Nodes
List<Instance
Node> - Instance node information.
- Parameters
List<Instance
Parameter> - Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid.
- Primary
Zone stringId - The available zone of primary node.
- Project
Name string - The project name of the RDS instance.
- Region
Id string - The region of the RDS instance.
- Secondary
Zone stringId - The available zone of secondary node.
- Storage
Space int - Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
- Storage
Type string - Instance storage type.
- Storage
Use int - The instance has used storage space. Unit: GB.
- Subnet
Id string - Subnet ID of the RDS instance.
- List<Instance
Tag> - Tags.
- Time
Zone string - Time zone.
- Update
Time string - The update time of the RDS instance.
- VCpu int
- CPU size.
- Vpc
Id string - The vpc ID of the RDS instance.
- Zone
Id string - The available zone of the RDS instance.
- Allow
List []stringIds - Allow list Ids of the RDS instance.
- Allow
List stringVersion - The version of allow list.
- Backup
Use int - The instance has used backup space. Unit: GB.
- Charge
Details []InstanceCharge Detail Args - Payment methods.
- Charge
Info InstanceCharge Info Args - Payment methods.
- Create
Time string - Node creation local time.
- Data
Sync stringMode - Data synchronization mode.
- Db
Engine stringVersion - Instance type. Value: MySQL_5_7 MySQL_8_0.
- Db
Time stringZone - Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
- Endpoints
[]Instance
Endpoint Args - The endpoint info of the RDS instance.
- Instance
Id string - Instance ID.
- Instance
Name string - Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
- Instance
Status string - The status of the RDS instance.
- Lower
Case stringTable Names - Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
- Maintenance
Windows []InstanceMaintenance Window Args - Maintenance Window.
- Memory int
- Memory size in GB.
- Node
Number int - The number of nodes.
- Node
Spec string - The specification of primary node and secondary node.
- Nodes
[]Instance
Node Args - Instance node information.
- Parameters
[]Instance
Parameter Args - Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid.
- Primary
Zone stringId - The available zone of primary node.
- Project
Name string - The project name of the RDS instance.
- Region
Id string - The region of the RDS instance.
- Secondary
Zone stringId - The available zone of secondary node.
- Storage
Space int - Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
- Storage
Type string - Instance storage type.
- Storage
Use int - The instance has used storage space. Unit: GB.
- Subnet
Id string - Subnet ID of the RDS instance.
- []Instance
Tag Args - Tags.
- Time
Zone string - Time zone.
- Update
Time string - The update time of the RDS instance.
- VCpu int
- CPU size.
- Vpc
Id string - The vpc ID of the RDS instance.
- Zone
Id string - The available zone of the RDS instance.
- allow
List List<String>Ids - Allow list Ids of the RDS instance.
- allow
List StringVersion - The version of allow list.
- backup
Use Integer - The instance has used backup space. Unit: GB.
- charge
Details List<InstanceCharge Detail> - Payment methods.
- charge
Info InstanceCharge Info - Payment methods.
- create
Time String - Node creation local time.
- data
Sync StringMode - Data synchronization mode.
- db
Engine StringVersion - Instance type. Value: MySQL_5_7 MySQL_8_0.
- db
Time StringZone - Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
- endpoints
List<Instance
Endpoint> - The endpoint info of the RDS instance.
- instance
Id String - Instance ID.
- instance
Name String - Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
- instance
Status String - The status of the RDS instance.
- lower
Case StringTable Names - Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
- maintenance
Windows List<InstanceMaintenance Window> - Maintenance Window.
- memory Integer
- Memory size in GB.
- node
Number Integer - The number of nodes.
- node
Spec String - The specification of primary node and secondary node.
- nodes
List<Instance
Node> - Instance node information.
- parameters
List<Instance
Parameter> - Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid.
- primary
Zone StringId - The available zone of primary node.
- project
Name String - The project name of the RDS instance.
- region
Id String - The region of the RDS instance.
- secondary
Zone StringId - The available zone of secondary node.
- storage
Space Integer - Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
- storage
Type String - Instance storage type.
- storage
Use Integer - The instance has used storage space. Unit: GB.
- subnet
Id String - Subnet ID of the RDS instance.
- List<Instance
Tag> - Tags.
- time
Zone String - Time zone.
- update
Time String - The update time of the RDS instance.
- v
Cpu Integer - CPU size.
- vpc
Id String - The vpc ID of the RDS instance.
- zone
Id String - The available zone of the RDS instance.
- allow
List string[]Ids - Allow list Ids of the RDS instance.
- allow
List stringVersion - The version of allow list.
- backup
Use number - The instance has used backup space. Unit: GB.
- charge
Details InstanceCharge Detail[] - Payment methods.
- charge
Info InstanceCharge Info - Payment methods.
- create
Time string - Node creation local time.
- data
Sync stringMode - Data synchronization mode.
- db
Engine stringVersion - Instance type. Value: MySQL_5_7 MySQL_8_0.
- db
Time stringZone - Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
- endpoints
Instance
Endpoint[] - The endpoint info of the RDS instance.
- instance
Id string - Instance ID.
- instance
Name string - Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
- instance
Status string - The status of the RDS instance.
- lower
Case stringTable Names - Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
- maintenance
Windows InstanceMaintenance Window[] - Maintenance Window.
- memory number
- Memory size in GB.
- node
Number number - The number of nodes.
- node
Spec string - The specification of primary node and secondary node.
- nodes
Instance
Node[] - Instance node information.
- parameters
Instance
Parameter[] - Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid.
- primary
Zone stringId - The available zone of primary node.
- project
Name string - The project name of the RDS instance.
- region
Id string - The region of the RDS instance.
- secondary
Zone stringId - The available zone of secondary node.
- storage
Space number - Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
- storage
Type string - Instance storage type.
- storage
Use number - The instance has used storage space. Unit: GB.
- subnet
Id string - Subnet ID of the RDS instance.
- Instance
Tag[] - Tags.
- time
Zone string - Time zone.
- update
Time string - The update time of the RDS instance.
- v
Cpu number - CPU size.
- vpc
Id string - The vpc ID of the RDS instance.
- zone
Id string - The available zone of the RDS instance.
- allow_
list_ Sequence[str]ids - Allow list Ids of the RDS instance.
- allow_
list_ strversion - The version of allow list.
- backup_
use int - The instance has used backup space. Unit: GB.
- charge_
details Sequence[InstanceCharge Detail Args] - Payment methods.
- charge_
info InstanceCharge Info Args - Payment methods.
- create_
time str - Node creation local time.
- data_
sync_ strmode - Data synchronization mode.
- db_
engine_ strversion - Instance type. Value: MySQL_5_7 MySQL_8_0.
- db_
time_ strzone - Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
- endpoints
Sequence[Instance
Endpoint Args] - The endpoint info of the RDS instance.
- instance_
id str - Instance ID.
- instance_
name str - Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
- instance_
status str - The status of the RDS instance.
- lower_
case_ strtable_ names - Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
- maintenance_
windows Sequence[InstanceMaintenance Window Args] - Maintenance Window.
- memory int
- Memory size in GB.
- node_
number int - The number of nodes.
- node_
spec str - The specification of primary node and secondary node.
- nodes
Sequence[Instance
Node Args] - Instance node information.
- parameters
Sequence[Instance
Parameter Args] - Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid.
- primary_
zone_ strid - The available zone of primary node.
- project_
name str - The project name of the RDS instance.
- region_
id str - The region of the RDS instance.
- secondary_
zone_ strid - The available zone of secondary node.
- storage_
space int - Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
- storage_
type str - Instance storage type.
- storage_
use int - The instance has used storage space. Unit: GB.
- subnet_
id str - Subnet ID of the RDS instance.
- Sequence[Instance
Tag Args] - Tags.
- time_
zone str - Time zone.
- update_
time str - The update time of the RDS instance.
- v_
cpu int - CPU size.
- vpc_
id str - The vpc ID of the RDS instance.
- zone_
id str - The available zone of the RDS instance.
- allow
List List<String>Ids - Allow list Ids of the RDS instance.
- allow
List StringVersion - The version of allow list.
- backup
Use Number - The instance has used backup space. Unit: GB.
- charge
Details List<Property Map> - Payment methods.
- charge
Info Property Map - Payment methods.
- create
Time String - Node creation local time.
- data
Sync StringMode - Data synchronization mode.
- db
Engine StringVersion - Instance type. Value: MySQL_5_7 MySQL_8_0.
- db
Time StringZone - Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
- endpoints List<Property Map>
- The endpoint info of the RDS instance.
- instance
Id String - Instance ID.
- instance
Name String - Instance name. Cannot start with a number or a dash Can only contain Chinese characters, letters, numbers, underscores and dashes The length is limited between 1 ~ 128.
- instance
Status String - The status of the RDS instance.
- lower
Case StringTable Names - Whether the table name is case sensitive, the default value is 1. Ranges: 0: Table names are stored as fixed and table names are case-sensitive. 1: Table names will be stored in lowercase and table names are not case sensitive.
- maintenance
Windows List<Property Map> - Maintenance Window.
- memory Number
- Memory size in GB.
- node
Number Number - The number of nodes.
- node
Spec String - The specification of primary node and secondary node.
- nodes List<Property Map>
- Instance node information.
- parameters List<Property Map>
- Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid.
- primary
Zone StringId - The available zone of primary node.
- project
Name String - The project name of the RDS instance.
- region
Id String - The region of the RDS instance.
- secondary
Zone StringId - The available zone of secondary node.
- storage
Space Number - Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
- storage
Type String - Instance storage type.
- storage
Use Number - The instance has used storage space. Unit: GB.
- subnet
Id String - Subnet ID of the RDS instance.
- List<Property Map>
- Tags.
- time
Zone String - Time zone.
- update
Time String - The update time of the RDS instance.
- v
Cpu Number - CPU size.
- vpc
Id String - The vpc ID of the RDS instance.
- zone
Id String - The available zone of the RDS instance.
Supporting Types
InstanceChargeDetail, InstanceChargeDetailArgs
- Auto
Renew bool - Whether to automatically renew in prepaid scenarios.
- Charge
End stringTime - Billing expiry time (yearly and monthly only).
- Charge
Start stringTime - Billing start time (pay-as-you-go & monthly subscription).
- Charge
Status string - Pay status. Value: normal - normal overdue - overdue .
- Charge
Type string - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- Overdue
Reclaim stringTime - Estimated release time when arrears are closed (pay-as-you-go & monthly subscription).
- Overdue
Time string - Shutdown time in arrears (pay-as-you-go & monthly subscription).
- Period int
- Purchase duration in prepaid scenarios. Default: 1.
- Period
Unit string - The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
- Auto
Renew bool - Whether to automatically renew in prepaid scenarios.
- Charge
End stringTime - Billing expiry time (yearly and monthly only).
- Charge
Start stringTime - Billing start time (pay-as-you-go & monthly subscription).
- Charge
Status string - Pay status. Value: normal - normal overdue - overdue .
- Charge
Type string - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- Overdue
Reclaim stringTime - Estimated release time when arrears are closed (pay-as-you-go & monthly subscription).
- Overdue
Time string - Shutdown time in arrears (pay-as-you-go & monthly subscription).
- Period int
- Purchase duration in prepaid scenarios. Default: 1.
- Period
Unit string - The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
- auto
Renew Boolean - Whether to automatically renew in prepaid scenarios.
- charge
End StringTime - Billing expiry time (yearly and monthly only).
- charge
Start StringTime - Billing start time (pay-as-you-go & monthly subscription).
- charge
Status String - Pay status. Value: normal - normal overdue - overdue .
- charge
Type String - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- overdue
Reclaim StringTime - Estimated release time when arrears are closed (pay-as-you-go & monthly subscription).
- overdue
Time String - Shutdown time in arrears (pay-as-you-go & monthly subscription).
- period Integer
- Purchase duration in prepaid scenarios. Default: 1.
- period
Unit String - The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
- auto
Renew boolean - Whether to automatically renew in prepaid scenarios.
- charge
End stringTime - Billing expiry time (yearly and monthly only).
- charge
Start stringTime - Billing start time (pay-as-you-go & monthly subscription).
- charge
Status string - Pay status. Value: normal - normal overdue - overdue .
- charge
Type string - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- overdue
Reclaim stringTime - Estimated release time when arrears are closed (pay-as-you-go & monthly subscription).
- overdue
Time string - Shutdown time in arrears (pay-as-you-go & monthly subscription).
- period number
- Purchase duration in prepaid scenarios. Default: 1.
- period
Unit string - The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
- auto_
renew bool - Whether to automatically renew in prepaid scenarios.
- charge_
end_ strtime - Billing expiry time (yearly and monthly only).
- charge_
start_ strtime - Billing start time (pay-as-you-go & monthly subscription).
- charge_
status str - Pay status. Value: normal - normal overdue - overdue .
- charge_
type str - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- overdue_
reclaim_ strtime - Estimated release time when arrears are closed (pay-as-you-go & monthly subscription).
- overdue_
time str - Shutdown time in arrears (pay-as-you-go & monthly subscription).
- period int
- Purchase duration in prepaid scenarios. Default: 1.
- period_
unit str - The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
- auto
Renew Boolean - Whether to automatically renew in prepaid scenarios.
- charge
End StringTime - Billing expiry time (yearly and monthly only).
- charge
Start StringTime - Billing start time (pay-as-you-go & monthly subscription).
- charge
Status String - Pay status. Value: normal - normal overdue - overdue .
- charge
Type String - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- overdue
Reclaim StringTime - Estimated release time when arrears are closed (pay-as-you-go & monthly subscription).
- overdue
Time String - Shutdown time in arrears (pay-as-you-go & monthly subscription).
- period Number
- Purchase duration in prepaid scenarios. Default: 1.
- period
Unit String - The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
InstanceChargeInfo, InstanceChargeInfoArgs
- Charge
Type string - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- Auto
Renew bool - Whether to automatically renew in prepaid scenarios.
- Period int
- Purchase duration in prepaid scenarios. Default: 1.
- Period
Unit string - The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
- Charge
Type string - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- Auto
Renew bool - Whether to automatically renew in prepaid scenarios.
- Period int
- Purchase duration in prepaid scenarios. Default: 1.
- Period
Unit string - The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
- charge
Type String - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- auto
Renew Boolean - Whether to automatically renew in prepaid scenarios.
- period Integer
- Purchase duration in prepaid scenarios. Default: 1.
- period
Unit String - The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
- charge
Type string - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- auto
Renew boolean - Whether to automatically renew in prepaid scenarios.
- period number
- Purchase duration in prepaid scenarios. Default: 1.
- period
Unit string - The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
- charge_
type str - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- auto_
renew bool - Whether to automatically renew in prepaid scenarios.
- period int
- Purchase duration in prepaid scenarios. Default: 1.
- period_
unit str - The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
- charge
Type String - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- auto
Renew Boolean - Whether to automatically renew in prepaid scenarios.
- period Number
- Purchase duration in prepaid scenarios. Default: 1.
- period
Unit String - The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
InstanceEndpoint, InstanceEndpointArgs
- Addresses
List<Instance
Endpoint Address> - Address list.
- Auto
Add stringNew Nodes - When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
- Description string
- Address description.
- Enable
Read stringOnly - Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
- Enable
Read stringWrite Splitting - Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
- Endpoint
Id string - Instance connection terminal ID.
- Endpoint
Name string - The instance connection terminal name.
- Endpoint
Type string - Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
- Node
Weights List<InstanceEndpoint Node Weight> - The list of nodes configured by the connection terminal and the corresponding read-only weights.
- Read
Write stringMode - Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
- Addresses
[]Instance
Endpoint Address - Address list.
- Auto
Add stringNew Nodes - When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
- Description string
- Address description.
- Enable
Read stringOnly - Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
- Enable
Read stringWrite Splitting - Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
- Endpoint
Id string - Instance connection terminal ID.
- Endpoint
Name string - The instance connection terminal name.
- Endpoint
Type string - Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
- Node
Weights []InstanceEndpoint Node Weight - The list of nodes configured by the connection terminal and the corresponding read-only weights.
- Read
Write stringMode - Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
- addresses
List<Instance
Endpoint Address> - Address list.
- auto
Add StringNew Nodes - When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
- description String
- Address description.
- enable
Read StringOnly - Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
- enable
Read StringWrite Splitting - Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
- endpoint
Id String - Instance connection terminal ID.
- endpoint
Name String - The instance connection terminal name.
- endpoint
Type String - Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
- node
Weights List<InstanceEndpoint Node Weight> - The list of nodes configured by the connection terminal and the corresponding read-only weights.
- read
Write StringMode - Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
- addresses
Instance
Endpoint Address[] - Address list.
- auto
Add stringNew Nodes - When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
- description string
- Address description.
- enable
Read stringOnly - Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
- enable
Read stringWrite Splitting - Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
- endpoint
Id string - Instance connection terminal ID.
- endpoint
Name string - The instance connection terminal name.
- endpoint
Type string - Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
- node
Weights InstanceEndpoint Node Weight[] - The list of nodes configured by the connection terminal and the corresponding read-only weights.
- read
Write stringMode - Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
- addresses
Sequence[Instance
Endpoint Address] - Address list.
- auto_
add_ strnew_ nodes - When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
- description str
- Address description.
- enable_
read_ stronly - Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
- enable_
read_ strwrite_ splitting - Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
- endpoint_
id str - Instance connection terminal ID.
- endpoint_
name str - The instance connection terminal name.
- endpoint_
type str - Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
- node_
weights Sequence[InstanceEndpoint Node Weight] - The list of nodes configured by the connection terminal and the corresponding read-only weights.
- read_
write_ strmode - Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
- addresses List<Property Map>
- Address list.
- auto
Add StringNew Nodes - When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
- description String
- Address description.
- enable
Read StringOnly - Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
- enable
Read StringWrite Splitting - Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
- endpoint
Id String - Instance connection terminal ID.
- endpoint
Name String - The instance connection terminal name.
- endpoint
Type String - Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
- node
Weights List<Property Map> - The list of nodes configured by the connection terminal and the corresponding read-only weights.
- read
Write StringMode - Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
InstanceEndpointAddress, InstanceEndpointAddressArgs
- Dns
Visibility bool - DNS Visibility.
- Domain string
- Connect domain name.
- Eip
Id string - The ID of the EIP, only valid for Public addresses.
- Ip
Address string - The IP Address.
- Network
Type string - Network address type, temporarily Private, Public, PublicService.
- Port string
- The Port.
- Subnet
Id string - Subnet ID of the RDS instance.
- Dns
Visibility bool - DNS Visibility.
- Domain string
- Connect domain name.
- Eip
Id string - The ID of the EIP, only valid for Public addresses.
- Ip
Address string - The IP Address.
- Network
Type string - Network address type, temporarily Private, Public, PublicService.
- Port string
- The Port.
- Subnet
Id string - Subnet ID of the RDS instance.
- dns
Visibility Boolean - DNS Visibility.
- domain String
- Connect domain name.
- eip
Id String - The ID of the EIP, only valid for Public addresses.
- ip
Address String - The IP Address.
- network
Type String - Network address type, temporarily Private, Public, PublicService.
- port String
- The Port.
- subnet
Id String - Subnet ID of the RDS instance.
- dns
Visibility boolean - DNS Visibility.
- domain string
- Connect domain name.
- eip
Id string - The ID of the EIP, only valid for Public addresses.
- ip
Address string - The IP Address.
- network
Type string - Network address type, temporarily Private, Public, PublicService.
- port string
- The Port.
- subnet
Id string - Subnet ID of the RDS instance.
- dns_
visibility bool - DNS Visibility.
- domain str
- Connect domain name.
- eip_
id str - The ID of the EIP, only valid for Public addresses.
- ip_
address str - The IP Address.
- network_
type str - Network address type, temporarily Private, Public, PublicService.
- port str
- The Port.
- subnet_
id str - Subnet ID of the RDS instance.
- dns
Visibility Boolean - DNS Visibility.
- domain String
- Connect domain name.
- eip
Id String - The ID of the EIP, only valid for Public addresses.
- ip
Address String - The IP Address.
- network
Type String - Network address type, temporarily Private, Public, PublicService.
- port String
- The Port.
- subnet
Id String - Subnet ID of the RDS instance.
InstanceEndpointNodeWeight, InstanceEndpointNodeWeightArgs
InstanceMaintenanceWindow, InstanceMaintenanceWindowArgs
- Day
Kind string - DayKind of maintainable window. Value: Week. Month.
- Day
Of List<int>Months - Days of maintainable window of the month.
- Day
Of List<string>Weeks - Days of maintainable window of the week.
- Maintenance
Time string - The maintainable time of the RDS instance.
- Day
Kind string - DayKind of maintainable window. Value: Week. Month.
- Day
Of []intMonths - Days of maintainable window of the month.
- Day
Of []stringWeeks - Days of maintainable window of the week.
- Maintenance
Time string - The maintainable time of the RDS instance.
- day
Kind String - DayKind of maintainable window. Value: Week. Month.
- day
Of List<Integer>Months - Days of maintainable window of the month.
- day
Of List<String>Weeks - Days of maintainable window of the week.
- maintenance
Time String - The maintainable time of the RDS instance.
- day
Kind string - DayKind of maintainable window. Value: Week. Month.
- day
Of number[]Months - Days of maintainable window of the month.
- day
Of string[]Weeks - Days of maintainable window of the week.
- maintenance
Time string - The maintainable time of the RDS instance.
- day_
kind str - DayKind of maintainable window. Value: Week. Month.
- day_
of_ Sequence[int]months - Days of maintainable window of the month.
- day_
of_ Sequence[str]weeks - Days of maintainable window of the week.
- maintenance_
time str - The maintainable time of the RDS instance.
- day
Kind String - DayKind of maintainable window. Value: Week. Month.
- day
Of List<Number>Months - Days of maintainable window of the month.
- day
Of List<String>Weeks - Days of maintainable window of the week.
- maintenance
Time String - The maintainable time of the RDS instance.
InstanceNode, InstanceNodeArgs
- Create
Time string - Node creation local time.
- Instance
Id string - Instance ID.
- Memory int
- Memory size in GB.
- Node
Id string - Node ID.
- Node
Spec string - The specification of primary node and secondary node.
- Node
Status string - Node state, value: aligned with instance state.
- Node
Type string - Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
- Region
Id string - The region of the RDS instance.
- Update
Time string - The update time of the RDS instance.
- VCpu int
- CPU size.
- Zone
Id string - The available zone of the RDS instance.
- Create
Time string - Node creation local time.
- Instance
Id string - Instance ID.
- Memory int
- Memory size in GB.
- Node
Id string - Node ID.
- Node
Spec string - The specification of primary node and secondary node.
- Node
Status string - Node state, value: aligned with instance state.
- Node
Type string - Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
- Region
Id string - The region of the RDS instance.
- Update
Time string - The update time of the RDS instance.
- VCpu int
- CPU size.
- Zone
Id string - The available zone of the RDS instance.
- create
Time String - Node creation local time.
- instance
Id String - Instance ID.
- memory Integer
- Memory size in GB.
- node
Id String - Node ID.
- node
Spec String - The specification of primary node and secondary node.
- node
Status String - Node state, value: aligned with instance state.
- node
Type String - Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
- region
Id String - The region of the RDS instance.
- update
Time String - The update time of the RDS instance.
- v
Cpu Integer - CPU size.
- zone
Id String - The available zone of the RDS instance.
- create
Time string - Node creation local time.
- instance
Id string - Instance ID.
- memory number
- Memory size in GB.
- node
Id string - Node ID.
- node
Spec string - The specification of primary node and secondary node.
- node
Status string - Node state, value: aligned with instance state.
- node
Type string - Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
- region
Id string - The region of the RDS instance.
- update
Time string - The update time of the RDS instance.
- v
Cpu number - CPU size.
- zone
Id string - The available zone of the RDS instance.
- create_
time str - Node creation local time.
- instance_
id str - Instance ID.
- memory int
- Memory size in GB.
- node_
id str - Node ID.
- node_
spec str - The specification of primary node and secondary node.
- node_
status str - Node state, value: aligned with instance state.
- node_
type str - Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
- region_
id str - The region of the RDS instance.
- update_
time str - The update time of the RDS instance.
- v_
cpu int - CPU size.
- zone_
id str - The available zone of the RDS instance.
- create
Time String - Node creation local time.
- instance
Id String - Instance ID.
- memory Number
- Memory size in GB.
- node
Id String - Node ID.
- node
Spec String - The specification of primary node and secondary node.
- node
Status String - Node state, value: aligned with instance state.
- node
Type String - Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
- region
Id String - The region of the RDS instance.
- update
Time String - The update time of the RDS instance.
- v
Cpu Number - CPU size.
- zone
Id String - The available zone of the RDS instance.
InstanceParameter, InstanceParameterArgs
- Parameter
Name string - Parameter name.
- Parameter
Value string - Parameter value.
- Parameter
Name string - Parameter name.
- Parameter
Value string - Parameter value.
- parameter
Name String - Parameter name.
- parameter
Value String - Parameter value.
- parameter
Name string - Parameter name.
- parameter
Value string - Parameter value.
- parameter_
name str - Parameter name.
- parameter_
value str - Parameter value.
- parameter
Name String - Parameter name.
- parameter
Value String - Parameter value.
InstanceTag, InstanceTagArgs
Import
Rds Mysql Instance can be imported using the id, e.g.
$ pulumi import volcengine:rds_mysql/instance:Instance default mysql-72da4258c2c7
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.