Viewing docs for Volcengine v0.0.46
published on Friday, Feb 27, 2026 by Volcengine
published on Friday, Feb 27, 2026 by Volcengine
Viewing docs for Volcengine v0.0.46
published on Friday, Feb 27, 2026 by Volcengine
published on Friday, Feb 27, 2026 by Volcengine
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Use this data source to query detailed information of rds instances v2
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
const default = volcengine.rds_v2.getRdsInstancesV2({});
import pulumi
import pulumi_volcengine as volcengine
default = volcengine.rds_v2.get_rds_instances_v2()
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds_v2"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds_v2.GetRdsInstancesV2(ctx, nil, nil)
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 @default = Volcengine.Rds_v2.GetRdsInstancesV2.Invoke();
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds_v2.Rds_v2Functions;
import com.pulumi.volcengine.rds_v2.inputs.GetRdsInstancesV2Args;
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 default = Rds_v2Functions.getRdsInstancesV2();
}
}
variables:
default:
fn::invoke:
Function: volcengine:rds_v2:getRdsInstancesV2
Arguments: {}
Using getRdsInstancesV2
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getRdsInstancesV2(args: GetRdsInstancesV2Args, opts?: InvokeOptions): Promise<GetRdsInstancesV2Result>
function getRdsInstancesV2Output(args: GetRdsInstancesV2OutputArgs, opts?: InvokeOptions): Output<GetRdsInstancesV2Result>def get_rds_instances_v2(charge_type: Optional[str] = None,
create_time_end: Optional[str] = None,
create_time_start: Optional[str] = None,
db_engine_version: Optional[str] = None,
instance_id: Optional[str] = None,
instance_name: Optional[str] = None,
instance_status: Optional[str] = None,
instance_type: Optional[str] = None,
name_regex: Optional[str] = None,
output_file: Optional[str] = None,
zone_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetRdsInstancesV2Result
def get_rds_instances_v2_output(charge_type: Optional[pulumi.Input[str]] = None,
create_time_end: Optional[pulumi.Input[str]] = None,
create_time_start: Optional[pulumi.Input[str]] = None,
db_engine_version: Optional[pulumi.Input[str]] = None,
instance_id: Optional[pulumi.Input[str]] = None,
instance_name: Optional[pulumi.Input[str]] = None,
instance_status: Optional[pulumi.Input[str]] = None,
instance_type: Optional[pulumi.Input[str]] = None,
name_regex: Optional[pulumi.Input[str]] = None,
output_file: Optional[pulumi.Input[str]] = None,
zone_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetRdsInstancesV2Result]func GetRdsInstancesV2(ctx *Context, args *GetRdsInstancesV2Args, opts ...InvokeOption) (*GetRdsInstancesV2Result, error)
func GetRdsInstancesV2Output(ctx *Context, args *GetRdsInstancesV2OutputArgs, opts ...InvokeOption) GetRdsInstancesV2ResultOutput> Note: This function is named GetRdsInstancesV2 in the Go SDK.
public static class GetRdsInstancesV2
{
public static Task<GetRdsInstancesV2Result> InvokeAsync(GetRdsInstancesV2Args args, InvokeOptions? opts = null)
public static Output<GetRdsInstancesV2Result> Invoke(GetRdsInstancesV2InvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetRdsInstancesV2Result> getRdsInstancesV2(GetRdsInstancesV2Args args, InvokeOptions options)
public static Output<GetRdsInstancesV2Result> getRdsInstancesV2(GetRdsInstancesV2Args args, InvokeOptions options)
fn::invoke:
function: volcengine:rds_v2/getRdsInstancesV2:getRdsInstancesV2
arguments:
# arguments dictionaryThe following arguments are supported:
- Charge
Type string - The charge type of the RDS instance.
- Create
Time stringEnd - The end time of creating RDS instance.
- Create
Time stringStart - The start time of creating RDS instance.
- Db
Engine stringVersion - The version of the RDS instance, Value: MySQL Community: MySQL_5.7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0 PostgreSQL Community: PostgreSQL_11 - PostgreSQL 11 PostgreSQL_12 - PostgreSQL 12 Microsoft SQL Server: Not available at this time SQLServer_2019 - SQL Server 2019 veDB for MySQL: MySQL_8_0 - MySQL 8.0 veDB for PostgreSQL: PostgreSQL_13 - PostgreSQL 13.
- Instance
Id string - The id of the RDS instance.
- Instance
Name string - The name of the RDS instance.
- Instance
Status string - The status of the RDS instance, Value: Running - running Creating - Creating Deleting - Deleting Restarting - Restarting Restoring - Restoring Updating - changing Upgrading - Upgrading Error - the error.
- Instance
Type string - The type of the RDS instance, Value: Value: RDS for MySQL: HA - high availability version; RDS for PostgreSQL: HA - high availability version; Microsoft SQL Server: Not available at this time Enterprise - Enterprise Edition Standard - Standard Edition Web - Web version veDB for MySQL: Cluster - Cluster Edition veDB for PostgreSQL: Cluster - Cluster Edition MySQL Sharding: HA - high availability version;.
- Name
Regex string - A Name Regex of RDS instance.
- Output
File string - File name where to save data source results.
- Zone
Id string - The available zone of the RDS instance.
- Charge
Type string - The charge type of the RDS instance.
- Create
Time stringEnd - The end time of creating RDS instance.
- Create
Time stringStart - The start time of creating RDS instance.
- Db
Engine stringVersion - The version of the RDS instance, Value: MySQL Community: MySQL_5.7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0 PostgreSQL Community: PostgreSQL_11 - PostgreSQL 11 PostgreSQL_12 - PostgreSQL 12 Microsoft SQL Server: Not available at this time SQLServer_2019 - SQL Server 2019 veDB for MySQL: MySQL_8_0 - MySQL 8.0 veDB for PostgreSQL: PostgreSQL_13 - PostgreSQL 13.
- Instance
Id string - The id of the RDS instance.
- Instance
Name string - The name of the RDS instance.
- Instance
Status string - The status of the RDS instance, Value: Running - running Creating - Creating Deleting - Deleting Restarting - Restarting Restoring - Restoring Updating - changing Upgrading - Upgrading Error - the error.
- Instance
Type string - The type of the RDS instance, Value: Value: RDS for MySQL: HA - high availability version; RDS for PostgreSQL: HA - high availability version; Microsoft SQL Server: Not available at this time Enterprise - Enterprise Edition Standard - Standard Edition Web - Web version veDB for MySQL: Cluster - Cluster Edition veDB for PostgreSQL: Cluster - Cluster Edition MySQL Sharding: HA - high availability version;.
- Name
Regex string - A Name Regex of RDS instance.
- Output
File string - File name where to save data source results.
- Zone
Id string - The available zone of the RDS instance.
- charge
Type String - The charge type of the RDS instance.
- create
Time StringEnd - The end time of creating RDS instance.
- create
Time StringStart - The start time of creating RDS instance.
- db
Engine StringVersion - The version of the RDS instance, Value: MySQL Community: MySQL_5.7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0 PostgreSQL Community: PostgreSQL_11 - PostgreSQL 11 PostgreSQL_12 - PostgreSQL 12 Microsoft SQL Server: Not available at this time SQLServer_2019 - SQL Server 2019 veDB for MySQL: MySQL_8_0 - MySQL 8.0 veDB for PostgreSQL: PostgreSQL_13 - PostgreSQL 13.
- instance
Id String - The id of the RDS instance.
- instance
Name String - The name of the RDS instance.
- instance
Status String - The status of the RDS instance, Value: Running - running Creating - Creating Deleting - Deleting Restarting - Restarting Restoring - Restoring Updating - changing Upgrading - Upgrading Error - the error.
- instance
Type String - The type of the RDS instance, Value: Value: RDS for MySQL: HA - high availability version; RDS for PostgreSQL: HA - high availability version; Microsoft SQL Server: Not available at this time Enterprise - Enterprise Edition Standard - Standard Edition Web - Web version veDB for MySQL: Cluster - Cluster Edition veDB for PostgreSQL: Cluster - Cluster Edition MySQL Sharding: HA - high availability version;.
- name
Regex String - A Name Regex of RDS instance.
- output
File String - File name where to save data source results.
- zone
Id String - The available zone of the RDS instance.
- charge
Type string - The charge type of the RDS instance.
- create
Time stringEnd - The end time of creating RDS instance.
- create
Time stringStart - The start time of creating RDS instance.
- db
Engine stringVersion - The version of the RDS instance, Value: MySQL Community: MySQL_5.7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0 PostgreSQL Community: PostgreSQL_11 - PostgreSQL 11 PostgreSQL_12 - PostgreSQL 12 Microsoft SQL Server: Not available at this time SQLServer_2019 - SQL Server 2019 veDB for MySQL: MySQL_8_0 - MySQL 8.0 veDB for PostgreSQL: PostgreSQL_13 - PostgreSQL 13.
- instance
Id string - The id of the RDS instance.
- instance
Name string - The name of the RDS instance.
- instance
Status string - The status of the RDS instance, Value: Running - running Creating - Creating Deleting - Deleting Restarting - Restarting Restoring - Restoring Updating - changing Upgrading - Upgrading Error - the error.
- instance
Type string - The type of the RDS instance, Value: Value: RDS for MySQL: HA - high availability version; RDS for PostgreSQL: HA - high availability version; Microsoft SQL Server: Not available at this time Enterprise - Enterprise Edition Standard - Standard Edition Web - Web version veDB for MySQL: Cluster - Cluster Edition veDB for PostgreSQL: Cluster - Cluster Edition MySQL Sharding: HA - high availability version;.
- name
Regex string - A Name Regex of RDS instance.
- output
File string - File name where to save data source results.
- zone
Id string - The available zone of the RDS instance.
- charge_
type str - The charge type of the RDS instance.
- create_
time_ strend - The end time of creating RDS instance.
- create_
time_ strstart - The start time of creating RDS instance.
- db_
engine_ strversion - The version of the RDS instance, Value: MySQL Community: MySQL_5.7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0 PostgreSQL Community: PostgreSQL_11 - PostgreSQL 11 PostgreSQL_12 - PostgreSQL 12 Microsoft SQL Server: Not available at this time SQLServer_2019 - SQL Server 2019 veDB for MySQL: MySQL_8_0 - MySQL 8.0 veDB for PostgreSQL: PostgreSQL_13 - PostgreSQL 13.
- instance_
id str - The id of the RDS instance.
- instance_
name str - The name of the RDS instance.
- instance_
status str - The status of the RDS instance, Value: Running - running Creating - Creating Deleting - Deleting Restarting - Restarting Restoring - Restoring Updating - changing Upgrading - Upgrading Error - the error.
- instance_
type str - The type of the RDS instance, Value: Value: RDS for MySQL: HA - high availability version; RDS for PostgreSQL: HA - high availability version; Microsoft SQL Server: Not available at this time Enterprise - Enterprise Edition Standard - Standard Edition Web - Web version veDB for MySQL: Cluster - Cluster Edition veDB for PostgreSQL: Cluster - Cluster Edition MySQL Sharding: HA - high availability version;.
- name_
regex str - A Name Regex of RDS instance.
- output_
file str - File name where to save data source results.
- zone_
id str - The available zone of the RDS instance.
- charge
Type String - The charge type of the RDS instance.
- create
Time StringEnd - The end time of creating RDS instance.
- create
Time StringStart - The start time of creating RDS instance.
- db
Engine StringVersion - The version of the RDS instance, Value: MySQL Community: MySQL_5.7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0 PostgreSQL Community: PostgreSQL_11 - PostgreSQL 11 PostgreSQL_12 - PostgreSQL 12 Microsoft SQL Server: Not available at this time SQLServer_2019 - SQL Server 2019 veDB for MySQL: MySQL_8_0 - MySQL 8.0 veDB for PostgreSQL: PostgreSQL_13 - PostgreSQL 13.
- instance
Id String - The id of the RDS instance.
- instance
Name String - The name of the RDS instance.
- instance
Status String - The status of the RDS instance, Value: Running - running Creating - Creating Deleting - Deleting Restarting - Restarting Restoring - Restoring Updating - changing Upgrading - Upgrading Error - the error.
- instance
Type String - The type of the RDS instance, Value: Value: RDS for MySQL: HA - high availability version; RDS for PostgreSQL: HA - high availability version; Microsoft SQL Server: Not available at this time Enterprise - Enterprise Edition Standard - Standard Edition Web - Web version veDB for MySQL: Cluster - Cluster Edition veDB for PostgreSQL: Cluster - Cluster Edition MySQL Sharding: HA - high availability version;.
- name
Regex String - A Name Regex of RDS instance.
- output
File String - File name where to save data source results.
- zone
Id String - The available zone of the RDS instance.
getRdsInstancesV2 Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Rds
Instances List<GetRds Instances V2Rds Instance> - The collection of RDS instance query.
- Total
Count int - The total count of RDS instance query.
- Charge
Type string - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- Create
Time stringEnd - Create
Time stringStart - Db
Engine stringVersion - The engine version of the RDS instance.
- Instance
Id string - Instance ID.
- Instance
Name string - The name of the RDS instance.
- Instance
Status string - The status of the RDS instance.
- Instance
Type string - The type of the RDS instance.
- Name
Regex string - Output
File string - Zone
Id string - The available zone of the RDS instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Rds
Instances []GetRds Instances V2Rds Instance - The collection of RDS instance query.
- Total
Count int - The total count of RDS instance query.
- Charge
Type string - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- Create
Time stringEnd - Create
Time stringStart - Db
Engine stringVersion - The engine version of the RDS instance.
- Instance
Id string - Instance ID.
- Instance
Name string - The name of the RDS instance.
- Instance
Status string - The status of the RDS instance.
- Instance
Type string - The type of the RDS instance.
- Name
Regex string - Output
File string - Zone
Id string - The available zone of the RDS instance.
- id String
- The provider-assigned unique ID for this managed resource.
- rds
Instances List<GetRds Instances V2Rds Instance> - The collection of RDS instance query.
- total
Count Integer - The total count of RDS instance query.
- charge
Type String - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- create
Time StringEnd - create
Time StringStart - db
Engine StringVersion - The engine version of the RDS instance.
- instance
Id String - Instance ID.
- instance
Name String - The name of the RDS instance.
- instance
Status String - The status of the RDS instance.
- instance
Type String - The type of the RDS instance.
- name
Regex String - output
File String - zone
Id String - The available zone of the RDS instance.
- id string
- The provider-assigned unique ID for this managed resource.
- rds
Instances GetRds Instances V2Rds Instance[] - The collection of RDS instance query.
- total
Count number - The total count of RDS instance query.
- charge
Type string - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- create
Time stringEnd - create
Time stringStart - db
Engine stringVersion - The engine version of the RDS instance.
- instance
Id string - Instance ID.
- instance
Name string - The name of the RDS instance.
- instance
Status string - The status of the RDS instance.
- instance
Type string - The type of the RDS instance.
- name
Regex string - output
File string - zone
Id string - The available zone of the RDS instance.
- id str
- The provider-assigned unique ID for this managed resource.
- rds_
instances Sequence[GetRds Instances V2Rds Instance] - The collection of RDS instance query.
- total_
count int - The total count of RDS instance query.
- charge_
type str - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- create_
time_ strend - create_
time_ strstart - db_
engine_ strversion - The engine version of the RDS instance.
- instance_
id str - Instance ID.
- instance_
name str - The name of the RDS instance.
- instance_
status str - The status of the RDS instance.
- instance_
type str - The type of the RDS instance.
- name_
regex str - output_
file str - zone_
id str - The available zone of the RDS instance.
- id String
- The provider-assigned unique ID for this managed resource.
- rds
Instances List<Property Map> - The collection of RDS instance query.
- total
Count Number - The total count of RDS instance query.
- charge
Type String - Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
- create
Time StringEnd - create
Time StringStart - db
Engine StringVersion - The engine version of the RDS instance.
- instance
Id String - Instance ID.
- instance
Name String - The name of the RDS instance.
- instance
Status String - The status of the RDS instance.
- instance
Type String - The type of the RDS instance.
- name
Regex String - output
File String - zone
Id String - The available zone of the RDS instance.
Supporting Types
GetRdsInstancesV2RdsInstance
- Charge
Detail GetRds Instances V2Rds Instance Charge Detail - Payment methods.
- Connection
Infos List<GetRds Instances V2Rds Instance Connection Info> - The connection info ot the RDS instance.
- Create
Time string - Node creation local time.
- Db
Engine string - The engine of the RDS instance.
- Db
Engine stringVersion - The version of the RDS instance, Value: MySQL Community: MySQL_5.7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0 PostgreSQL Community: PostgreSQL_11 - PostgreSQL 11 PostgreSQL_12 - PostgreSQL 12 Microsoft SQL Server: Not available at this time SQLServer_2019 - SQL Server 2019 veDB for MySQL: MySQL_8_0 - MySQL 8.0 veDB for PostgreSQL: PostgreSQL_13 - PostgreSQL 13.
- Id string
- The ID of the RDS instance.
- Instance
Id string - The id of the RDS instance.
- Instance
Name string - The name of the RDS instance.
- Instance
Status string - The status of the RDS instance, Value: Running - running Creating - Creating Deleting - Deleting Restarting - Restarting Restoring - Restoring Updating - changing Upgrading - Upgrading Error - the error.
- Instance
Type string - The type of the RDS instance, Value: Value: RDS for MySQL: HA - high availability version; RDS for PostgreSQL: HA - high availability version; Microsoft SQL Server: Not available at this time Enterprise - Enterprise Edition Standard - Standard Edition Web - Web version veDB for MySQL: Cluster - Cluster Edition veDB for PostgreSQL: Cluster - Cluster Edition MySQL Sharding: HA - high availability version;.
- Node
Detail List<GetInfos Rds Instances V2Rds Instance Node Detail Info> - Instance node information.
- Node
Number int - The number of nodes.
- Node
Spec string - General instance type, different from Custom instance type.
- Port string
- Instance intranet port.
- Project
Name string - Subordinate to the project.
- Region
Id string - The region of the RDS instance.
- int
- The number of shards.
- Storage
Space int - Total instance storage space. Unit: GB.
- Storage
Type string - Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
- Storage
Use int - The instance has used storage space. Unit: GB.
- Subnet
Id string - The subnet ID of the RDS instance.
- Time
Zone string - Time zone.
- Vpc
Id string - The vpc ID of the RDS instance.
- Zone
Id string - The available zone of the RDS instance.
- Charge
Detail GetRds Instances V2Rds Instance Charge Detail - Payment methods.
- Connection
Infos []GetRds Instances V2Rds Instance Connection Info - The connection info ot the RDS instance.
- Create
Time string - Node creation local time.
- Db
Engine string - The engine of the RDS instance.
- Db
Engine stringVersion - The version of the RDS instance, Value: MySQL Community: MySQL_5.7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0 PostgreSQL Community: PostgreSQL_11 - PostgreSQL 11 PostgreSQL_12 - PostgreSQL 12 Microsoft SQL Server: Not available at this time SQLServer_2019 - SQL Server 2019 veDB for MySQL: MySQL_8_0 - MySQL 8.0 veDB for PostgreSQL: PostgreSQL_13 - PostgreSQL 13.
- Id string
- The ID of the RDS instance.
- Instance
Id string - The id of the RDS instance.
- Instance
Name string - The name of the RDS instance.
- Instance
Status string - The status of the RDS instance, Value: Running - running Creating - Creating Deleting - Deleting Restarting - Restarting Restoring - Restoring Updating - changing Upgrading - Upgrading Error - the error.
- Instance
Type string - The type of the RDS instance, Value: Value: RDS for MySQL: HA - high availability version; RDS for PostgreSQL: HA - high availability version; Microsoft SQL Server: Not available at this time Enterprise - Enterprise Edition Standard - Standard Edition Web - Web version veDB for MySQL: Cluster - Cluster Edition veDB for PostgreSQL: Cluster - Cluster Edition MySQL Sharding: HA - high availability version;.
- Node
Detail []GetInfos Rds Instances V2Rds Instance Node Detail Info - Instance node information.
- Node
Number int - The number of nodes.
- Node
Spec string - General instance type, different from Custom instance type.
- Port string
- Instance intranet port.
- Project
Name string - Subordinate to the project.
- Region
Id string - The region of the RDS instance.
- int
- The number of shards.
- Storage
Space int - Total instance storage space. Unit: GB.
- Storage
Type string - Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
- Storage
Use int - The instance has used storage space. Unit: GB.
- Subnet
Id string - The subnet ID of the RDS instance.
- Time
Zone string - Time zone.
- Vpc
Id string - The vpc ID of the RDS instance.
- Zone
Id string - The available zone of the RDS instance.
- charge
Detail GetRds Instances V2Rds Instance Charge Detail - Payment methods.
- connection
Infos List<GetRds Instances V2Rds Instance Connection Info> - The connection info ot the RDS instance.
- create
Time String - Node creation local time.
- db
Engine String - The engine of the RDS instance.
- db
Engine StringVersion - The version of the RDS instance, Value: MySQL Community: MySQL_5.7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0 PostgreSQL Community: PostgreSQL_11 - PostgreSQL 11 PostgreSQL_12 - PostgreSQL 12 Microsoft SQL Server: Not available at this time SQLServer_2019 - SQL Server 2019 veDB for MySQL: MySQL_8_0 - MySQL 8.0 veDB for PostgreSQL: PostgreSQL_13 - PostgreSQL 13.
- id String
- The ID of the RDS instance.
- instance
Id String - The id of the RDS instance.
- instance
Name String - The name of the RDS instance.
- instance
Status String - The status of the RDS instance, Value: Running - running Creating - Creating Deleting - Deleting Restarting - Restarting Restoring - Restoring Updating - changing Upgrading - Upgrading Error - the error.
- instance
Type String - The type of the RDS instance, Value: Value: RDS for MySQL: HA - high availability version; RDS for PostgreSQL: HA - high availability version; Microsoft SQL Server: Not available at this time Enterprise - Enterprise Edition Standard - Standard Edition Web - Web version veDB for MySQL: Cluster - Cluster Edition veDB for PostgreSQL: Cluster - Cluster Edition MySQL Sharding: HA - high availability version;.
- node
Detail List<GetInfos Rds Instances V2Rds Instance Node Detail Info> - Instance node information.
- node
Number Integer - The number of nodes.
- node
Spec String - General instance type, different from Custom instance type.
- port String
- Instance intranet port.
- project
Name String - Subordinate to the project.
- region
Id String - The region of the RDS instance.
- Integer
- The number of shards.
- storage
Space Integer - Total instance storage space. Unit: GB.
- storage
Type String - Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
- storage
Use Integer - The instance has used storage space. Unit: GB.
- subnet
Id String - The subnet ID of the RDS instance.
- time
Zone String - Time zone.
- vpc
Id String - The vpc ID of the RDS instance.
- zone
Id String - The available zone of the RDS instance.
- charge
Detail GetRds Instances V2Rds Instance Charge Detail - Payment methods.
- connection
Infos GetRds Instances V2Rds Instance Connection Info[] - The connection info ot the RDS instance.
- create
Time string - Node creation local time.
- db
Engine string - The engine of the RDS instance.
- db
Engine stringVersion - The version of the RDS instance, Value: MySQL Community: MySQL_5.7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0 PostgreSQL Community: PostgreSQL_11 - PostgreSQL 11 PostgreSQL_12 - PostgreSQL 12 Microsoft SQL Server: Not available at this time SQLServer_2019 - SQL Server 2019 veDB for MySQL: MySQL_8_0 - MySQL 8.0 veDB for PostgreSQL: PostgreSQL_13 - PostgreSQL 13.
- id string
- The ID of the RDS instance.
- instance
Id string - The id of the RDS instance.
- instance
Name string - The name of the RDS instance.
- instance
Status string - The status of the RDS instance, Value: Running - running Creating - Creating Deleting - Deleting Restarting - Restarting Restoring - Restoring Updating - changing Upgrading - Upgrading Error - the error.
- instance
Type string - The type of the RDS instance, Value: Value: RDS for MySQL: HA - high availability version; RDS for PostgreSQL: HA - high availability version; Microsoft SQL Server: Not available at this time Enterprise - Enterprise Edition Standard - Standard Edition Web - Web version veDB for MySQL: Cluster - Cluster Edition veDB for PostgreSQL: Cluster - Cluster Edition MySQL Sharding: HA - high availability version;.
- node
Detail GetInfos Rds Instances V2Rds Instance Node Detail Info[] - Instance node information.
- node
Number number - The number of nodes.
- node
Spec string - General instance type, different from Custom instance type.
- port string
- Instance intranet port.
- project
Name string - Subordinate to the project.
- region
Id string - The region of the RDS instance.
- number
- The number of shards.
- storage
Space number - Total instance storage space. Unit: GB.
- storage
Type string - Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
- storage
Use number - The instance has used storage space. Unit: GB.
- subnet
Id string - The subnet ID of the RDS instance.
- time
Zone string - Time zone.
- vpc
Id string - The vpc ID of the RDS instance.
- zone
Id string - The available zone of the RDS instance.
- charge_
detail GetRds Instances V2Rds Instance Charge Detail - Payment methods.
- connection_
infos Sequence[GetRds Instances V2Rds Instance Connection Info] - The connection info ot the RDS instance.
- create_
time str - Node creation local time.
- db_
engine str - The engine of the RDS instance.
- db_
engine_ strversion - The version of the RDS instance, Value: MySQL Community: MySQL_5.7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0 PostgreSQL Community: PostgreSQL_11 - PostgreSQL 11 PostgreSQL_12 - PostgreSQL 12 Microsoft SQL Server: Not available at this time SQLServer_2019 - SQL Server 2019 veDB for MySQL: MySQL_8_0 - MySQL 8.0 veDB for PostgreSQL: PostgreSQL_13 - PostgreSQL 13.
- id str
- The ID of the RDS instance.
- instance_
id str - The id of the RDS instance.
- instance_
name str - The name of the RDS instance.
- instance_
status str - The status of the RDS instance, Value: Running - running Creating - Creating Deleting - Deleting Restarting - Restarting Restoring - Restoring Updating - changing Upgrading - Upgrading Error - the error.
- instance_
type str - The type of the RDS instance, Value: Value: RDS for MySQL: HA - high availability version; RDS for PostgreSQL: HA - high availability version; Microsoft SQL Server: Not available at this time Enterprise - Enterprise Edition Standard - Standard Edition Web - Web version veDB for MySQL: Cluster - Cluster Edition veDB for PostgreSQL: Cluster - Cluster Edition MySQL Sharding: HA - high availability version;.
- node_
detail_ Sequence[Getinfos Rds Instances V2Rds Instance Node Detail Info] - Instance node information.
- node_
number int - The number of nodes.
- node_
spec str - General instance type, different from Custom instance type.
- port str
- Instance intranet port.
- project_
name str - Subordinate to the project.
- region_
id str - The region of the RDS instance.
- int
- The number of shards.
- storage_
space int - Total instance storage space. Unit: GB.
- storage_
type str - Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
- storage_
use int - The instance has used storage space. Unit: GB.
- subnet_
id str - The subnet ID of the RDS instance.
- time_
zone str - Time zone.
- vpc_
id str - The vpc ID of the RDS instance.
- zone_
id str - The available zone of the RDS instance.
- charge
Detail Property Map - Payment methods.
- connection
Infos List<Property Map> - The connection info ot the RDS instance.
- create
Time String - Node creation local time.
- db
Engine String - The engine of the RDS instance.
- db
Engine StringVersion - The version of the RDS instance, Value: MySQL Community: MySQL_5.7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0 PostgreSQL Community: PostgreSQL_11 - PostgreSQL 11 PostgreSQL_12 - PostgreSQL 12 Microsoft SQL Server: Not available at this time SQLServer_2019 - SQL Server 2019 veDB for MySQL: MySQL_8_0 - MySQL 8.0 veDB for PostgreSQL: PostgreSQL_13 - PostgreSQL 13.
- id String
- The ID of the RDS instance.
- instance
Id String - The id of the RDS instance.
- instance
Name String - The name of the RDS instance.
- instance
Status String - The status of the RDS instance, Value: Running - running Creating - Creating Deleting - Deleting Restarting - Restarting Restoring - Restoring Updating - changing Upgrading - Upgrading Error - the error.
- instance
Type String - The type of the RDS instance, Value: Value: RDS for MySQL: HA - high availability version; RDS for PostgreSQL: HA - high availability version; Microsoft SQL Server: Not available at this time Enterprise - Enterprise Edition Standard - Standard Edition Web - Web version veDB for MySQL: Cluster - Cluster Edition veDB for PostgreSQL: Cluster - Cluster Edition MySQL Sharding: HA - high availability version;.
- node
Detail List<Property Map>Infos - Instance node information.
- node
Number Number - The number of nodes.
- node
Spec String - General instance type, different from Custom instance type.
- port String
- Instance intranet port.
- project
Name String - Subordinate to the project.
- region
Id String - The region of the RDS instance.
- Number
- The number of shards.
- storage
Space Number - Total instance storage space. Unit: GB.
- storage
Type String - Instance storage type. When the database type is MySQL/PostgreSQL/SQL_Server/MySQL Sharding, the value is: LocalSSD - local SSD disk When the database type is veDB_MySQL/veDB_PostgreSQL, the value is: DistributedStorage - Distributed Storage.
- storage
Use Number - The instance has used storage space. Unit: GB.
- subnet
Id String - The subnet ID of the RDS instance.
- time
Zone String - Time zone.
- vpc
Id String - The vpc ID of the RDS instance.
- zone
Id String - The available zone of the RDS instance.
GetRdsInstancesV2RdsInstanceChargeDetail
- Auto
Renew bool - Whether to automatically renew in prepaid scenarios. Autorenew_Enable Autorenew_Disable (default).
- 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 - The charge type of the RDS instance.
- 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. Autorenew_Enable Autorenew_Disable (default).
- 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 - The charge type of the RDS instance.
- 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. Autorenew_Enable Autorenew_Disable (default).
- 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 - The charge type of the RDS instance.
- 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. Autorenew_Enable Autorenew_Disable (default).
- 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 - The charge type of the RDS instance.
- 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. Autorenew_Enable Autorenew_Disable (default).
- 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 - The charge type of the RDS instance.
- 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. Autorenew_Enable Autorenew_Disable (default).
- 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 - The charge type of the RDS instance.
- 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.
GetRdsInstancesV2RdsInstanceConnectionInfo
- Addresses
List<Get
Rds Instances V2Rds Instance Connection Info 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).
- Read
Only List<GetNode Weights Rds Instances V2Rds Instance Connection Info Read Only 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
[]Get
Rds Instances V2Rds Instance Connection Info 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).
- Read
Only []GetNode Weights Rds Instances V2Rds Instance Connection Info Read Only 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<Get
Rds Instances V2Rds Instance Connection Info 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).
- read
Only List<GetNode Weights Rds Instances V2Rds Instance Connection Info Read Only 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
Get
Rds Instances V2Rds Instance Connection Info 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).
- read
Only GetNode Weights Rds Instances V2Rds Instance Connection Info Read Only 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[Get
Rds Instances V2Rds Instance Connection Info 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).
- read_
only_ Sequence[Getnode_ weights Rds Instances V2Rds Instance Connection Info Read Only 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).
- read
Only List<Property Map>Node Weights - 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).
GetRdsInstancesV2RdsInstanceConnectionInfoAddress
- 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
- Instance intranet port.
- subnet_
id str - The subnet ID of the RDS instance.
GetRdsInstancesV2RdsInstanceConnectionInfoReadOnlyNodeWeight
GetRdsInstancesV2RdsInstanceNodeDetailInfo
- Create
Time string - Node creation local time.
- Instance
Id string - The id of the RDS instance.
- Memory int
- Memory size in GB.
- Node
Id string - Node ID.
- Node
Spec string - General instance type, different from Custom instance type.
- 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 - Node updates local time.
- VCpu int
- CPU size. For example: 1 means 1U.
- Zone
Id string - The available zone of the RDS instance.
- Create
Time string - Node creation local time.
- Instance
Id string - The id of the RDS instance.
- Memory int
- Memory size in GB.
- Node
Id string - Node ID.
- Node
Spec string - General instance type, different from Custom instance type.
- 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 - Node updates local time.
- VCpu int
- CPU size. For example: 1 means 1U.
- Zone
Id string - The available zone of the RDS instance.
- create
Time String - Node creation local time.
- instance
Id String - The id of the RDS instance.
- memory Integer
- Memory size in GB.
- node
Id String - Node ID.
- node
Spec String - General instance type, different from Custom instance type.
- 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 - Node updates local time.
- v
Cpu Integer - CPU size. For example: 1 means 1U.
- zone
Id String - The available zone of the RDS instance.
- create
Time string - Node creation local time.
- instance
Id string - The id of the RDS instance.
- memory number
- Memory size in GB.
- node
Id string - Node ID.
- node
Spec string - General instance type, different from Custom instance type.
- 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 - Node updates local time.
- v
Cpu number - CPU size. For example: 1 means 1U.
- zone
Id string - The available zone of the RDS instance.
- create_
time str - Node creation local time.
- instance_
id str - The id of the RDS instance.
- memory int
- Memory size in GB.
- node_
id str - Node ID.
- node_
spec str - General instance type, different from Custom instance type.
- 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 - Node updates local time.
- v_
cpu int - CPU size. For example: 1 means 1U.
- zone_
id str - The available zone of the RDS instance.
- create
Time String - Node creation local time.
- instance
Id String - The id of the RDS instance.
- memory Number
- Memory size in GB.
- node
Id String - Node ID.
- node
Spec String - General instance type, different from Custom instance type.
- 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 - Node updates local time.
- v
Cpu Number - CPU size. For example: 1 means 1U.
- zone
Id String - The available zone of the RDS instance.
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
volcengineTerraform Provider.
Viewing docs for Volcengine v0.0.46
published on Friday, Feb 27, 2026 by Volcengine
published on Friday, Feb 27, 2026 by Volcengine
