Alibaba Cloud v3.69.0 published on Monday, Dec 9, 2024 by Pulumi
alicloud.rds.getInstances
Explore with Pulumi AI
The alicloud.rds.getInstances
data source provides a collection of RDS instances available in Alibaba Cloud account.
Filters support regular expression for the instance name, searches by tags, and other filters which are listed below.
NOTE: Available since v1.7.0+
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const dbInstancesDs = alicloud.rds.getInstances({
nameRegex: "data-\\d+",
status: "Running",
tags: {
type: "database",
size: "tiny",
},
});
export const firstDbInstanceId = dbInstancesDs.then(dbInstancesDs => dbInstancesDs.instances?.[0]?.id);
import pulumi
import pulumi_alicloud as alicloud
db_instances_ds = alicloud.rds.get_instances(name_regex="data-\\d+",
status="Running",
tags={
"type": "database",
"size": "tiny",
})
pulumi.export("firstDbInstanceId", db_instances_ds.instances[0].id)
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
dbInstancesDs, err := rds.GetInstances(ctx, &rds.GetInstancesArgs{
NameRegex: pulumi.StringRef("data-\\d+"),
Status: pulumi.StringRef("Running"),
Tags: map[string]interface{}{
"type": "database",
"size": "tiny",
},
}, nil)
if err != nil {
return err
}
ctx.Export("firstDbInstanceId", dbInstancesDs.Instances[0].Id)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var dbInstancesDs = AliCloud.Rds.GetInstances.Invoke(new()
{
NameRegex = "data-\\d+",
Status = "Running",
Tags =
{
{ "type", "database" },
{ "size", "tiny" },
},
});
return new Dictionary<string, object?>
{
["firstDbInstanceId"] = dbInstancesDs.Apply(getInstancesResult => getInstancesResult.Instances[0]?.Id),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.rds.RdsFunctions;
import com.pulumi.alicloud.rds.inputs.GetInstancesArgs;
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 dbInstancesDs = RdsFunctions.getInstances(GetInstancesArgs.builder()
.nameRegex("data-\\d+")
.status("Running")
.tags(Map.ofEntries(
Map.entry("type", "database"),
Map.entry("size", "tiny")
))
.build());
ctx.export("firstDbInstanceId", dbInstancesDs.applyValue(getInstancesResult -> getInstancesResult.instances()[0].id()));
}
}
variables:
dbInstancesDs:
fn::invoke:
Function: alicloud:rds:getInstances
Arguments:
nameRegex: data-\d+
status: Running
tags:
type: database
size: tiny
outputs:
firstDbInstanceId: ${dbInstancesDs.instances[0].id}
Using getInstances
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 getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>
function getInstancesOutput(args: GetInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstancesResult>
def get_instances(connection_mode: Optional[str] = None,
db_type: Optional[str] = None,
enable_details: Optional[bool] = None,
engine: Optional[str] = None,
ids: Optional[Sequence[str]] = None,
name_regex: Optional[str] = None,
output_file: Optional[str] = None,
page_number: Optional[int] = None,
page_size: Optional[int] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
vpc_id: Optional[str] = None,
vswitch_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetInstancesResult
def get_instances_output(connection_mode: Optional[pulumi.Input[str]] = None,
db_type: Optional[pulumi.Input[str]] = None,
enable_details: Optional[pulumi.Input[bool]] = None,
engine: Optional[pulumi.Input[str]] = None,
ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
name_regex: Optional[pulumi.Input[str]] = None,
output_file: Optional[pulumi.Input[str]] = None,
page_number: Optional[pulumi.Input[int]] = None,
page_size: Optional[pulumi.Input[int]] = None,
status: Optional[pulumi.Input[str]] = None,
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
vpc_id: Optional[pulumi.Input[str]] = None,
vswitch_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetInstancesResult]
func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
func GetInstancesOutput(ctx *Context, args *GetInstancesOutputArgs, opts ...InvokeOption) GetInstancesResultOutput
> Note: This function is named GetInstances
in the Go SDK.
public static class GetInstances
{
public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
public static Output<GetInstancesResult> Invoke(GetInstancesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: alicloud:rds/getInstances:getInstances
arguments:
# arguments dictionary
The following arguments are supported:
- Connection
Mode string Standard
for standard access mode andSafe
for high security access mode.- Db
Type string Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- Enable
Details bool - Default to
false
. Set it totrue
can output parameter template about resource attributes. - Engine string
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - Ids List<string>
- A list of RDS instance IDs.
- Name
Regex string - A regex string to filter results by instance name.
- Output
File string - File name where to save data source results (after running
pulumi preview
). - Page
Number int - Page
Size int - Status string
- Status of the instance.
- Dictionary<string, string>
- A map of tags assigned to the DB instances.
Note: Before 1.60.0, the value's format is a
json
string which includingTagKey
andTagValue
.TagKey
cannot be null, andTagValue
can be empty. Format example"{\"key1\":\"value1\"}"
- Vpc
Id string - Used to retrieve instances belong to specified VPC.
- Vswitch
Id string - Used to retrieve instances belong to specified
vswitch
resources.
- Connection
Mode string Standard
for standard access mode andSafe
for high security access mode.- Db
Type string Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- Enable
Details bool - Default to
false
. Set it totrue
can output parameter template about resource attributes. - Engine string
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - Ids []string
- A list of RDS instance IDs.
- Name
Regex string - A regex string to filter results by instance name.
- Output
File string - File name where to save data source results (after running
pulumi preview
). - Page
Number int - Page
Size int - Status string
- Status of the instance.
- map[string]string
- A map of tags assigned to the DB instances.
Note: Before 1.60.0, the value's format is a
json
string which includingTagKey
andTagValue
.TagKey
cannot be null, andTagValue
can be empty. Format example"{\"key1\":\"value1\"}"
- Vpc
Id string - Used to retrieve instances belong to specified VPC.
- Vswitch
Id string - Used to retrieve instances belong to specified
vswitch
resources.
- connection
Mode String Standard
for standard access mode andSafe
for high security access mode.- db
Type String Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- enable
Details Boolean - Default to
false
. Set it totrue
can output parameter template about resource attributes. - engine String
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - ids List<String>
- A list of RDS instance IDs.
- name
Regex String - A regex string to filter results by instance name.
- output
File String - File name where to save data source results (after running
pulumi preview
). - page
Number Integer - page
Size Integer - status String
- Status of the instance.
- Map<String,String>
- A map of tags assigned to the DB instances.
Note: Before 1.60.0, the value's format is a
json
string which includingTagKey
andTagValue
.TagKey
cannot be null, andTagValue
can be empty. Format example"{\"key1\":\"value1\"}"
- vpc
Id String - Used to retrieve instances belong to specified VPC.
- vswitch
Id String - Used to retrieve instances belong to specified
vswitch
resources.
- connection
Mode string Standard
for standard access mode andSafe
for high security access mode.- db
Type string Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- enable
Details boolean - Default to
false
. Set it totrue
can output parameter template about resource attributes. - engine string
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - ids string[]
- A list of RDS instance IDs.
- name
Regex string - A regex string to filter results by instance name.
- output
File string - File name where to save data source results (after running
pulumi preview
). - page
Number number - page
Size number - status string
- Status of the instance.
- {[key: string]: string}
- A map of tags assigned to the DB instances.
Note: Before 1.60.0, the value's format is a
json
string which includingTagKey
andTagValue
.TagKey
cannot be null, andTagValue
can be empty. Format example"{\"key1\":\"value1\"}"
- vpc
Id string - Used to retrieve instances belong to specified VPC.
- vswitch
Id string - Used to retrieve instances belong to specified
vswitch
resources.
- connection_
mode str Standard
for standard access mode andSafe
for high security access mode.- db_
type str Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- enable_
details bool - Default to
false
. Set it totrue
can output parameter template about resource attributes. - engine str
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - ids Sequence[str]
- A list of RDS instance IDs.
- name_
regex str - A regex string to filter results by instance name.
- output_
file str - File name where to save data source results (after running
pulumi preview
). - page_
number int - page_
size int - status str
- Status of the instance.
- Mapping[str, str]
- A map of tags assigned to the DB instances.
Note: Before 1.60.0, the value's format is a
json
string which includingTagKey
andTagValue
.TagKey
cannot be null, andTagValue
can be empty. Format example"{\"key1\":\"value1\"}"
- vpc_
id str - Used to retrieve instances belong to specified VPC.
- vswitch_
id str - Used to retrieve instances belong to specified
vswitch
resources.
- connection
Mode String Standard
for standard access mode andSafe
for high security access mode.- db
Type String Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- enable
Details Boolean - Default to
false
. Set it totrue
can output parameter template about resource attributes. - engine String
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - ids List<String>
- A list of RDS instance IDs.
- name
Regex String - A regex string to filter results by instance name.
- output
File String - File name where to save data source results (after running
pulumi preview
). - page
Number Number - page
Size Number - status String
- Status of the instance.
- Map<String>
- A map of tags assigned to the DB instances.
Note: Before 1.60.0, the value's format is a
json
string which includingTagKey
andTagValue
.TagKey
cannot be null, andTagValue
can be empty. Format example"{\"key1\":\"value1\"}"
- vpc
Id String - Used to retrieve instances belong to specified VPC.
- vswitch
Id String - Used to retrieve instances belong to specified
vswitch
resources.
getInstances Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Ids List<string>
- A list of RDS instance IDs.
- Instances
List<Pulumi.
Ali Cloud. Rds. Outputs. Get Instances Instance> - A list of RDS instances. Each element contains the following attributes:
- Names List<string>
- A list of RDS instance names.
- Total
Count int - Connection
Mode string Standard
for standard access mode andSafe
for high security access mode.- Db
Type string Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- Enable
Details bool - Engine string
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - Name
Regex string - Output
File string - Page
Number int - Page
Size int - Status string
- Status of the instance.
- Dictionary<string, string>
- Vpc
Id string - ID of the VPC the instance belongs to.
- Vswitch
Id string - ID of the vSwitch the instance belongs to.
- Id string
- The provider-assigned unique ID for this managed resource.
- Ids []string
- A list of RDS instance IDs.
- Instances
[]Get
Instances Instance - A list of RDS instances. Each element contains the following attributes:
- Names []string
- A list of RDS instance names.
- Total
Count int - Connection
Mode string Standard
for standard access mode andSafe
for high security access mode.- Db
Type string Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- Enable
Details bool - Engine string
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - Name
Regex string - Output
File string - Page
Number int - Page
Size int - Status string
- Status of the instance.
- map[string]string
- Vpc
Id string - ID of the VPC the instance belongs to.
- Vswitch
Id string - ID of the vSwitch the instance belongs to.
- id String
- The provider-assigned unique ID for this managed resource.
- ids List<String>
- A list of RDS instance IDs.
- instances
List<Get
Instances Instance> - A list of RDS instances. Each element contains the following attributes:
- names List<String>
- A list of RDS instance names.
- total
Count Integer - connection
Mode String Standard
for standard access mode andSafe
for high security access mode.- db
Type String Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- enable
Details Boolean - engine String
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - name
Regex String - output
File String - page
Number Integer - page
Size Integer - status String
- Status of the instance.
- Map<String,String>
- vpc
Id String - ID of the VPC the instance belongs to.
- vswitch
Id String - ID of the vSwitch the instance belongs to.
- id string
- The provider-assigned unique ID for this managed resource.
- ids string[]
- A list of RDS instance IDs.
- instances
Get
Instances Instance[] - A list of RDS instances. Each element contains the following attributes:
- names string[]
- A list of RDS instance names.
- total
Count number - connection
Mode string Standard
for standard access mode andSafe
for high security access mode.- db
Type string Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- enable
Details boolean - engine string
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - name
Regex string - output
File string - page
Number number - page
Size number - status string
- Status of the instance.
- {[key: string]: string}
- vpc
Id string - ID of the VPC the instance belongs to.
- vswitch
Id string - ID of the vSwitch the instance belongs to.
- id str
- The provider-assigned unique ID for this managed resource.
- ids Sequence[str]
- A list of RDS instance IDs.
- instances
Sequence[Get
Instances Instance] - A list of RDS instances. Each element contains the following attributes:
- names Sequence[str]
- A list of RDS instance names.
- total_
count int - connection_
mode str Standard
for standard access mode andSafe
for high security access mode.- db_
type str Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- enable_
details bool - engine str
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - name_
regex str - output_
file str - page_
number int - page_
size int - status str
- Status of the instance.
- Mapping[str, str]
- vpc_
id str - ID of the VPC the instance belongs to.
- vswitch_
id str - ID of the vSwitch the instance belongs to.
- id String
- The provider-assigned unique ID for this managed resource.
- ids List<String>
- A list of RDS instance IDs.
- instances List<Property Map>
- A list of RDS instances. Each element contains the following attributes:
- names List<String>
- A list of RDS instance names.
- total
Count Number - connection
Mode String Standard
for standard access mode andSafe
for high security access mode.- db
Type String Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- enable
Details Boolean - engine String
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - name
Regex String - output
File String - page
Number Number - page
Size Number - status String
- Status of the instance.
- Map<String>
- vpc
Id String - ID of the VPC the instance belongs to.
- vswitch
Id String - ID of the vSwitch the instance belongs to.
Supporting Types
GetInstancesInstance
- Acl string
- (Available in 1.124.1+) The method that is used to verify the identities of clients. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- cert
- perfer
- verify-ca
- verify-full (supported only when the instance runs PostgreSQL 12 or later)
- Availability
Zone string - Availability zone.
- Ca
Type string - (Available in 1.124.1+) The type of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- aliyun: a cloud certificate
- custom: a custom certificate
- Charge
Type string - Billing method. Value options:
Postpaid
for Pay-As-You-Go andPrepaid
for subscription. - Client
Ca stringCert - (Available in 1.124.1+) The public key of the CA that issues client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Client
Ca stringCert Expire Time - (Available in 1.124.1+) The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with cloud disks. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. This parameter is not supported now.
- Client
Cert stringRevocation List - (Available in 1.124.1+) The certificate revocation list (CRL) that contains revoked client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Connection
Mode string Standard
for standard access mode andSafe
for high security access mode.- Connection
String string - (Available in 1.70.3+) RDS database connection string.
- Create
Time string - Creation time of the instance.
- Creator string
- (Available in 1.124.3+) The creator of the encryption key.
- Db
Instance stringStorage Type - (Available in 1.70.3+) The storage type of the instance.
- Db
Instance stringType - (Available in 1.197.0+) The type of instance.
- Db
Type string Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- Delete
Date string - (Available in 1.124.3+) The estimated time when the encryption key will be deleted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Deletion
Protection bool - (Available in 1.167.0+) Indicates whether the release protection feature is enabled for the instance. Valid values:
- true: The release protection feature is enabled.
- false: The release protection feature is disabled.
- Description string
- (Available in 1.124.3+) The description of the encryption key.
- Encryption
Key string - (Available in 1.124.3+) The ID of the encryption key.
- Encryption
Key stringStatus - (Available in 1.124.3+) The status of the encryption key. Valid values:
- Enabled
- Disabled
- Engine string
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - Engine
Version string - Database version.
- Expire
Time string - Expiration time. Pay-As-You-Go instances never expire.
- Guard
Instance stringId - If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.
- Ha
Mode string - (Available since v1.209.1) The high availability mode of the instance.
- Host
Instance List<Pulumi.Infos Ali Cloud. Rds. Inputs. Get Instances Instance Host Instance Info> - (Available since v1.209.1) An array that consists of the information of the primary and secondary instances.
- Id string
- The ID of the RDS instance.
- Instance
Storage int - (Available in 1.70.3+) User-defined DB instance storage space.
- Instance
Type string - Sizing of the RDS instance.
- Key
Usage string - (Available in 1.124.3+) The purpose of the encryption key.
- Last
Modify stringStatus - (Available in 1.124.1+) The status of the SSL link. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- success
- setting
- failed
- Master
Instance stringId - ID of the primary instance. If this parameter is not returned, the current instance is a primary instance.
- Master
Zone string - (Available in 1.101.0+) The master zone of the instance.
- Material
Expire stringTime - (Available in 1.124.3+) The time when the encryption key expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Modify
Status stringReason - (Available in 1.124.1+) The reason why the SSL link stays in the current state. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Name string
- The name of the RDS instance.
- Net
Type string Internet
for public network orIntranet
for private network.- Origin string
- (Available in 1.124.3+) The source of the encryption key.
- Parameters
List<Pulumi.
Ali Cloud. Rds. Inputs. Get Instances Instance Parameter> - (Available in 1.135.0+) Parameter list.
- Port string
- (Available in 1.70.3+) RDS database connection port.
- Readonly
Instance List<string>Ids - A list of IDs of read-only instances attached to the primary instance.
- Region
Id string - The region ID of the instance.
- Replication
Acl string - (Available in 1.124.1+) The method that is used to verify the replication permission. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- cert
- perfer
- verify-ca
- verify-full (supported only when the instance runs PostgreSQL 12 or later)
- Require
Update string - (Available in 1.124.1+) Indicates whether the server certificate needs to be updated.
- Valid values for ApsaraDB RDS for MySQL and ApsaraDB RDS for SQL Server:
- No
- Yes
- Valid values for ApsaraDB RDS for PostgreSQL:
- 0: no
- 1: yes
- Require
Update stringItem - (Available in 1.124.1+) The server certificate that needs to be updated. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Require
Update stringReason - (Available in 1.124.1+) The reason why the server certificate needs to be updated. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Server
Ca stringUrl - (Available in 1.124.1+) The URL of the CA that issues the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Server
Cert string - (Available in 1.124.1+) The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Server
Key string - (Available in 1.124.1+) The private key of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Ssl
Create stringTime - (Available in 1.124.1+) The time when the server certificate was created. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. In addition, this parameter is valid only when the CAType parameter is set to aliyun.
- Ssl
Enabled string - (Available in 1.124.1+) Indicates whether SSL encryption is enabled. Valid values:
- on: enabled
- off: disabled
- Ssl
Expire stringTime - (Available in 1.124.1+) The time when the server certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Status string
- Status of the instance.
- Sync
Mode string - (Available since v1.209.1) The data replication mode of the instance.
- Temp
Instance stringId - If a temporary instance is attached to the current instance, the ID of the temporary instance applies.
- Vpc
Id string - Used to retrieve instances belong to specified VPC.
- Vswitch
Id string - Used to retrieve instances belong to specified
vswitch
resources. - Zone
Id stringSlave A - (Available in 1.101.0+) The region ID of the secondary instance if you create a secondary instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.
- Zone
Id stringSlave B - (Available in 1.101.0+) The region ID of the log instance if you create a log instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.
- Acl string
- (Available in 1.124.1+) The method that is used to verify the identities of clients. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- cert
- perfer
- verify-ca
- verify-full (supported only when the instance runs PostgreSQL 12 or later)
- Availability
Zone string - Availability zone.
- Ca
Type string - (Available in 1.124.1+) The type of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- aliyun: a cloud certificate
- custom: a custom certificate
- Charge
Type string - Billing method. Value options:
Postpaid
for Pay-As-You-Go andPrepaid
for subscription. - Client
Ca stringCert - (Available in 1.124.1+) The public key of the CA that issues client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Client
Ca stringCert Expire Time - (Available in 1.124.1+) The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with cloud disks. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. This parameter is not supported now.
- Client
Cert stringRevocation List - (Available in 1.124.1+) The certificate revocation list (CRL) that contains revoked client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Connection
Mode string Standard
for standard access mode andSafe
for high security access mode.- Connection
String string - (Available in 1.70.3+) RDS database connection string.
- Create
Time string - Creation time of the instance.
- Creator string
- (Available in 1.124.3+) The creator of the encryption key.
- Db
Instance stringStorage Type - (Available in 1.70.3+) The storage type of the instance.
- Db
Instance stringType - (Available in 1.197.0+) The type of instance.
- Db
Type string Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- Delete
Date string - (Available in 1.124.3+) The estimated time when the encryption key will be deleted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Deletion
Protection bool - (Available in 1.167.0+) Indicates whether the release protection feature is enabled for the instance. Valid values:
- true: The release protection feature is enabled.
- false: The release protection feature is disabled.
- Description string
- (Available in 1.124.3+) The description of the encryption key.
- Encryption
Key string - (Available in 1.124.3+) The ID of the encryption key.
- Encryption
Key stringStatus - (Available in 1.124.3+) The status of the encryption key. Valid values:
- Enabled
- Disabled
- Engine string
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - Engine
Version string - Database version.
- Expire
Time string - Expiration time. Pay-As-You-Go instances never expire.
- Guard
Instance stringId - If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.
- Ha
Mode string - (Available since v1.209.1) The high availability mode of the instance.
- Host
Instance []GetInfos Instances Instance Host Instance Info - (Available since v1.209.1) An array that consists of the information of the primary and secondary instances.
- Id string
- The ID of the RDS instance.
- Instance
Storage int - (Available in 1.70.3+) User-defined DB instance storage space.
- Instance
Type string - Sizing of the RDS instance.
- Key
Usage string - (Available in 1.124.3+) The purpose of the encryption key.
- Last
Modify stringStatus - (Available in 1.124.1+) The status of the SSL link. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- success
- setting
- failed
- Master
Instance stringId - ID of the primary instance. If this parameter is not returned, the current instance is a primary instance.
- Master
Zone string - (Available in 1.101.0+) The master zone of the instance.
- Material
Expire stringTime - (Available in 1.124.3+) The time when the encryption key expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Modify
Status stringReason - (Available in 1.124.1+) The reason why the SSL link stays in the current state. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Name string
- The name of the RDS instance.
- Net
Type string Internet
for public network orIntranet
for private network.- Origin string
- (Available in 1.124.3+) The source of the encryption key.
- Parameters
[]Get
Instances Instance Parameter - (Available in 1.135.0+) Parameter list.
- Port string
- (Available in 1.70.3+) RDS database connection port.
- Readonly
Instance []stringIds - A list of IDs of read-only instances attached to the primary instance.
- Region
Id string - The region ID of the instance.
- Replication
Acl string - (Available in 1.124.1+) The method that is used to verify the replication permission. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- cert
- perfer
- verify-ca
- verify-full (supported only when the instance runs PostgreSQL 12 or later)
- Require
Update string - (Available in 1.124.1+) Indicates whether the server certificate needs to be updated.
- Valid values for ApsaraDB RDS for MySQL and ApsaraDB RDS for SQL Server:
- No
- Yes
- Valid values for ApsaraDB RDS for PostgreSQL:
- 0: no
- 1: yes
- Require
Update stringItem - (Available in 1.124.1+) The server certificate that needs to be updated. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Require
Update stringReason - (Available in 1.124.1+) The reason why the server certificate needs to be updated. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Server
Ca stringUrl - (Available in 1.124.1+) The URL of the CA that issues the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Server
Cert string - (Available in 1.124.1+) The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Server
Key string - (Available in 1.124.1+) The private key of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- Ssl
Create stringTime - (Available in 1.124.1+) The time when the server certificate was created. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. In addition, this parameter is valid only when the CAType parameter is set to aliyun.
- Ssl
Enabled string - (Available in 1.124.1+) Indicates whether SSL encryption is enabled. Valid values:
- on: enabled
- off: disabled
- Ssl
Expire stringTime - (Available in 1.124.1+) The time when the server certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Status string
- Status of the instance.
- Sync
Mode string - (Available since v1.209.1) The data replication mode of the instance.
- Temp
Instance stringId - If a temporary instance is attached to the current instance, the ID of the temporary instance applies.
- Vpc
Id string - Used to retrieve instances belong to specified VPC.
- Vswitch
Id string - Used to retrieve instances belong to specified
vswitch
resources. - Zone
Id stringSlave A - (Available in 1.101.0+) The region ID of the secondary instance if you create a secondary instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.
- Zone
Id stringSlave B - (Available in 1.101.0+) The region ID of the log instance if you create a log instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.
- acl String
- (Available in 1.124.1+) The method that is used to verify the identities of clients. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- cert
- perfer
- verify-ca
- verify-full (supported only when the instance runs PostgreSQL 12 or later)
- availability
Zone String - Availability zone.
- ca
Type String - (Available in 1.124.1+) The type of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- aliyun: a cloud certificate
- custom: a custom certificate
- charge
Type String - Billing method. Value options:
Postpaid
for Pay-As-You-Go andPrepaid
for subscription. - client
Ca StringCert - (Available in 1.124.1+) The public key of the CA that issues client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- client
Ca StringCert Expire Time - (Available in 1.124.1+) The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with cloud disks. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. This parameter is not supported now.
- client
Cert StringRevocation List - (Available in 1.124.1+) The certificate revocation list (CRL) that contains revoked client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- connection
Mode String Standard
for standard access mode andSafe
for high security access mode.- connection
String String - (Available in 1.70.3+) RDS database connection string.
- create
Time String - Creation time of the instance.
- creator String
- (Available in 1.124.3+) The creator of the encryption key.
- db
Instance StringStorage Type - (Available in 1.70.3+) The storage type of the instance.
- db
Instance StringType - (Available in 1.197.0+) The type of instance.
- db
Type String Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- delete
Date String - (Available in 1.124.3+) The estimated time when the encryption key will be deleted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- deletion
Protection Boolean - (Available in 1.167.0+) Indicates whether the release protection feature is enabled for the instance. Valid values:
- true: The release protection feature is enabled.
- false: The release protection feature is disabled.
- description String
- (Available in 1.124.3+) The description of the encryption key.
- encryption
Key String - (Available in 1.124.3+) The ID of the encryption key.
- encryption
Key StringStatus - (Available in 1.124.3+) The status of the encryption key. Valid values:
- Enabled
- Disabled
- engine String
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - engine
Version String - Database version.
- expire
Time String - Expiration time. Pay-As-You-Go instances never expire.
- guard
Instance StringId - If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.
- ha
Mode String - (Available since v1.209.1) The high availability mode of the instance.
- host
Instance List<GetInfos Instances Instance Host Instance Info> - (Available since v1.209.1) An array that consists of the information of the primary and secondary instances.
- id String
- The ID of the RDS instance.
- instance
Storage Integer - (Available in 1.70.3+) User-defined DB instance storage space.
- instance
Type String - Sizing of the RDS instance.
- key
Usage String - (Available in 1.124.3+) The purpose of the encryption key.
- last
Modify StringStatus - (Available in 1.124.1+) The status of the SSL link. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- success
- setting
- failed
- master
Instance StringId - ID of the primary instance. If this parameter is not returned, the current instance is a primary instance.
- master
Zone String - (Available in 1.101.0+) The master zone of the instance.
- material
Expire StringTime - (Available in 1.124.3+) The time when the encryption key expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- modify
Status StringReason - (Available in 1.124.1+) The reason why the SSL link stays in the current state. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- name String
- The name of the RDS instance.
- net
Type String Internet
for public network orIntranet
for private network.- origin String
- (Available in 1.124.3+) The source of the encryption key.
- parameters
List<Get
Instances Instance Parameter> - (Available in 1.135.0+) Parameter list.
- port String
- (Available in 1.70.3+) RDS database connection port.
- readonly
Instance List<String>Ids - A list of IDs of read-only instances attached to the primary instance.
- region
Id String - The region ID of the instance.
- replication
Acl String - (Available in 1.124.1+) The method that is used to verify the replication permission. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- cert
- perfer
- verify-ca
- verify-full (supported only when the instance runs PostgreSQL 12 or later)
- require
Update String - (Available in 1.124.1+) Indicates whether the server certificate needs to be updated.
- Valid values for ApsaraDB RDS for MySQL and ApsaraDB RDS for SQL Server:
- No
- Yes
- Valid values for ApsaraDB RDS for PostgreSQL:
- 0: no
- 1: yes
- require
Update StringItem - (Available in 1.124.1+) The server certificate that needs to be updated. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- require
Update StringReason - (Available in 1.124.1+) The reason why the server certificate needs to be updated. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- server
Ca StringUrl - (Available in 1.124.1+) The URL of the CA that issues the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- server
Cert String - (Available in 1.124.1+) The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- server
Key String - (Available in 1.124.1+) The private key of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- ssl
Create StringTime - (Available in 1.124.1+) The time when the server certificate was created. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. In addition, this parameter is valid only when the CAType parameter is set to aliyun.
- ssl
Enabled String - (Available in 1.124.1+) Indicates whether SSL encryption is enabled. Valid values:
- on: enabled
- off: disabled
- ssl
Expire StringTime - (Available in 1.124.1+) The time when the server certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- status String
- Status of the instance.
- sync
Mode String - (Available since v1.209.1) The data replication mode of the instance.
- temp
Instance StringId - If a temporary instance is attached to the current instance, the ID of the temporary instance applies.
- vpc
Id String - Used to retrieve instances belong to specified VPC.
- vswitch
Id String - Used to retrieve instances belong to specified
vswitch
resources. - zone
Id StringSlave A - (Available in 1.101.0+) The region ID of the secondary instance if you create a secondary instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.
- zone
Id StringSlave B - (Available in 1.101.0+) The region ID of the log instance if you create a log instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.
- acl string
- (Available in 1.124.1+) The method that is used to verify the identities of clients. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- cert
- perfer
- verify-ca
- verify-full (supported only when the instance runs PostgreSQL 12 or later)
- availability
Zone string - Availability zone.
- ca
Type string - (Available in 1.124.1+) The type of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- aliyun: a cloud certificate
- custom: a custom certificate
- charge
Type string - Billing method. Value options:
Postpaid
for Pay-As-You-Go andPrepaid
for subscription. - client
Ca stringCert - (Available in 1.124.1+) The public key of the CA that issues client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- client
Ca stringCert Expire Time - (Available in 1.124.1+) The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with cloud disks. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. This parameter is not supported now.
- client
Cert stringRevocation List - (Available in 1.124.1+) The certificate revocation list (CRL) that contains revoked client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- connection
Mode string Standard
for standard access mode andSafe
for high security access mode.- connection
String string - (Available in 1.70.3+) RDS database connection string.
- create
Time string - Creation time of the instance.
- creator string
- (Available in 1.124.3+) The creator of the encryption key.
- db
Instance stringStorage Type - (Available in 1.70.3+) The storage type of the instance.
- db
Instance stringType - (Available in 1.197.0+) The type of instance.
- db
Type string Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- delete
Date string - (Available in 1.124.3+) The estimated time when the encryption key will be deleted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- deletion
Protection boolean - (Available in 1.167.0+) Indicates whether the release protection feature is enabled for the instance. Valid values:
- true: The release protection feature is enabled.
- false: The release protection feature is disabled.
- description string
- (Available in 1.124.3+) The description of the encryption key.
- encryption
Key string - (Available in 1.124.3+) The ID of the encryption key.
- encryption
Key stringStatus - (Available in 1.124.3+) The status of the encryption key. Valid values:
- Enabled
- Disabled
- engine string
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - engine
Version string - Database version.
- expire
Time string - Expiration time. Pay-As-You-Go instances never expire.
- guard
Instance stringId - If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.
- ha
Mode string - (Available since v1.209.1) The high availability mode of the instance.
- host
Instance GetInfos Instances Instance Host Instance Info[] - (Available since v1.209.1) An array that consists of the information of the primary and secondary instances.
- id string
- The ID of the RDS instance.
- instance
Storage number - (Available in 1.70.3+) User-defined DB instance storage space.
- instance
Type string - Sizing of the RDS instance.
- key
Usage string - (Available in 1.124.3+) The purpose of the encryption key.
- last
Modify stringStatus - (Available in 1.124.1+) The status of the SSL link. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- success
- setting
- failed
- master
Instance stringId - ID of the primary instance. If this parameter is not returned, the current instance is a primary instance.
- master
Zone string - (Available in 1.101.0+) The master zone of the instance.
- material
Expire stringTime - (Available in 1.124.3+) The time when the encryption key expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- modify
Status stringReason - (Available in 1.124.1+) The reason why the SSL link stays in the current state. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- name string
- The name of the RDS instance.
- net
Type string Internet
for public network orIntranet
for private network.- origin string
- (Available in 1.124.3+) The source of the encryption key.
- parameters
Get
Instances Instance Parameter[] - (Available in 1.135.0+) Parameter list.
- port string
- (Available in 1.70.3+) RDS database connection port.
- readonly
Instance string[]Ids - A list of IDs of read-only instances attached to the primary instance.
- region
Id string - The region ID of the instance.
- replication
Acl string - (Available in 1.124.1+) The method that is used to verify the replication permission. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- cert
- perfer
- verify-ca
- verify-full (supported only when the instance runs PostgreSQL 12 or later)
- require
Update string - (Available in 1.124.1+) Indicates whether the server certificate needs to be updated.
- Valid values for ApsaraDB RDS for MySQL and ApsaraDB RDS for SQL Server:
- No
- Yes
- Valid values for ApsaraDB RDS for PostgreSQL:
- 0: no
- 1: yes
- require
Update stringItem - (Available in 1.124.1+) The server certificate that needs to be updated. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- require
Update stringReason - (Available in 1.124.1+) The reason why the server certificate needs to be updated. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- server
Ca stringUrl - (Available in 1.124.1+) The URL of the CA that issues the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- server
Cert string - (Available in 1.124.1+) The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- server
Key string - (Available in 1.124.1+) The private key of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- ssl
Create stringTime - (Available in 1.124.1+) The time when the server certificate was created. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. In addition, this parameter is valid only when the CAType parameter is set to aliyun.
- ssl
Enabled string - (Available in 1.124.1+) Indicates whether SSL encryption is enabled. Valid values:
- on: enabled
- off: disabled
- ssl
Expire stringTime - (Available in 1.124.1+) The time when the server certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- status string
- Status of the instance.
- sync
Mode string - (Available since v1.209.1) The data replication mode of the instance.
- temp
Instance stringId - If a temporary instance is attached to the current instance, the ID of the temporary instance applies.
- vpc
Id string - Used to retrieve instances belong to specified VPC.
- vswitch
Id string - Used to retrieve instances belong to specified
vswitch
resources. - zone
Id stringSlave A - (Available in 1.101.0+) The region ID of the secondary instance if you create a secondary instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.
- zone
Id stringSlave B - (Available in 1.101.0+) The region ID of the log instance if you create a log instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.
- acl str
- (Available in 1.124.1+) The method that is used to verify the identities of clients. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- cert
- perfer
- verify-ca
- verify-full (supported only when the instance runs PostgreSQL 12 or later)
- availability_
zone str - Availability zone.
- ca_
type str - (Available in 1.124.1+) The type of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- aliyun: a cloud certificate
- custom: a custom certificate
- charge_
type str - Billing method. Value options:
Postpaid
for Pay-As-You-Go andPrepaid
for subscription. - client_
ca_ strcert - (Available in 1.124.1+) The public key of the CA that issues client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- client_
ca_ strcert_ expire_ time - (Available in 1.124.1+) The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with cloud disks. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. This parameter is not supported now.
- client_
cert_ strrevocation_ list - (Available in 1.124.1+) The certificate revocation list (CRL) that contains revoked client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- connection_
mode str Standard
for standard access mode andSafe
for high security access mode.- connection_
string str - (Available in 1.70.3+) RDS database connection string.
- create_
time str - Creation time of the instance.
- creator str
- (Available in 1.124.3+) The creator of the encryption key.
- db_
instance_ strstorage_ type - (Available in 1.70.3+) The storage type of the instance.
- db_
instance_ strtype - (Available in 1.197.0+) The type of instance.
- db_
type str Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- delete_
date str - (Available in 1.124.3+) The estimated time when the encryption key will be deleted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- deletion_
protection bool - (Available in 1.167.0+) Indicates whether the release protection feature is enabled for the instance. Valid values:
- true: The release protection feature is enabled.
- false: The release protection feature is disabled.
- description str
- (Available in 1.124.3+) The description of the encryption key.
- encryption_
key str - (Available in 1.124.3+) The ID of the encryption key.
- encryption_
key_ strstatus - (Available in 1.124.3+) The status of the encryption key. Valid values:
- Enabled
- Disabled
- engine str
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - engine_
version str - Database version.
- expire_
time str - Expiration time. Pay-As-You-Go instances never expire.
- guard_
instance_ strid - If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.
- ha_
mode str - (Available since v1.209.1) The high availability mode of the instance.
- host_
instance_ Sequence[Getinfos Instances Instance Host Instance Info] - (Available since v1.209.1) An array that consists of the information of the primary and secondary instances.
- id str
- The ID of the RDS instance.
- instance_
storage int - (Available in 1.70.3+) User-defined DB instance storage space.
- instance_
type str - Sizing of the RDS instance.
- key_
usage str - (Available in 1.124.3+) The purpose of the encryption key.
- last_
modify_ strstatus - (Available in 1.124.1+) The status of the SSL link. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- success
- setting
- failed
- master_
instance_ strid - ID of the primary instance. If this parameter is not returned, the current instance is a primary instance.
- master_
zone str - (Available in 1.101.0+) The master zone of the instance.
- material_
expire_ strtime - (Available in 1.124.3+) The time when the encryption key expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- modify_
status_ strreason - (Available in 1.124.1+) The reason why the SSL link stays in the current state. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- name str
- The name of the RDS instance.
- net_
type str Internet
for public network orIntranet
for private network.- origin str
- (Available in 1.124.3+) The source of the encryption key.
- parameters
Sequence[Get
Instances Instance Parameter] - (Available in 1.135.0+) Parameter list.
- port str
- (Available in 1.70.3+) RDS database connection port.
- readonly_
instance_ Sequence[str]ids - A list of IDs of read-only instances attached to the primary instance.
- region_
id str - The region ID of the instance.
- replication_
acl str - (Available in 1.124.1+) The method that is used to verify the replication permission. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- cert
- perfer
- verify-ca
- verify-full (supported only when the instance runs PostgreSQL 12 or later)
- require_
update str - (Available in 1.124.1+) Indicates whether the server certificate needs to be updated.
- Valid values for ApsaraDB RDS for MySQL and ApsaraDB RDS for SQL Server:
- No
- Yes
- Valid values for ApsaraDB RDS for PostgreSQL:
- 0: no
- 1: yes
- require_
update_ stritem - (Available in 1.124.1+) The server certificate that needs to be updated. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- require_
update_ strreason - (Available in 1.124.1+) The reason why the server certificate needs to be updated. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- server_
ca_ strurl - (Available in 1.124.1+) The URL of the CA that issues the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- server_
cert str - (Available in 1.124.1+) The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- server_
key str - (Available in 1.124.1+) The private key of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- ssl_
create_ strtime - (Available in 1.124.1+) The time when the server certificate was created. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. In addition, this parameter is valid only when the CAType parameter is set to aliyun.
- ssl_
enabled str - (Available in 1.124.1+) Indicates whether SSL encryption is enabled. Valid values:
- on: enabled
- off: disabled
- ssl_
expire_ strtime - (Available in 1.124.1+) The time when the server certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- status str
- Status of the instance.
- sync_
mode str - (Available since v1.209.1) The data replication mode of the instance.
- temp_
instance_ strid - If a temporary instance is attached to the current instance, the ID of the temporary instance applies.
- vpc_
id str - Used to retrieve instances belong to specified VPC.
- vswitch_
id str - Used to retrieve instances belong to specified
vswitch
resources. - zone_
id_ strslave_ a - (Available in 1.101.0+) The region ID of the secondary instance if you create a secondary instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.
- zone_
id_ strslave_ b - (Available in 1.101.0+) The region ID of the log instance if you create a log instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.
- acl String
- (Available in 1.124.1+) The method that is used to verify the identities of clients. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- cert
- perfer
- verify-ca
- verify-full (supported only when the instance runs PostgreSQL 12 or later)
- availability
Zone String - Availability zone.
- ca
Type String - (Available in 1.124.1+) The type of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- aliyun: a cloud certificate
- custom: a custom certificate
- charge
Type String - Billing method. Value options:
Postpaid
for Pay-As-You-Go andPrepaid
for subscription. - client
Ca StringCert - (Available in 1.124.1+) The public key of the CA that issues client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- client
Ca StringCert Expire Time - (Available in 1.124.1+) The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with cloud disks. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. This parameter is not supported now.
- client
Cert StringRevocation List - (Available in 1.124.1+) The certificate revocation list (CRL) that contains revoked client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- connection
Mode String Standard
for standard access mode andSafe
for high security access mode.- connection
String String - (Available in 1.70.3+) RDS database connection string.
- create
Time String - Creation time of the instance.
- creator String
- (Available in 1.124.3+) The creator of the encryption key.
- db
Instance StringStorage Type - (Available in 1.70.3+) The storage type of the instance.
- db
Instance StringType - (Available in 1.197.0+) The type of instance.
- db
Type String Primary
for primary instance,Readonly
for read-only instance,Guard
for disaster recovery instance, andTemp
for temporary instance.- delete
Date String - (Available in 1.124.3+) The estimated time when the encryption key will be deleted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- deletion
Protection Boolean - (Available in 1.167.0+) Indicates whether the release protection feature is enabled for the instance. Valid values:
- true: The release protection feature is enabled.
- false: The release protection feature is disabled.
- description String
- (Available in 1.124.3+) The description of the encryption key.
- encryption
Key String - (Available in 1.124.3+) The ID of the encryption key.
- encryption
Key StringStatus - (Available in 1.124.3+) The status of the encryption key. Valid values:
- Enabled
- Disabled
- engine String
- Database type. Options are
MySQL
,SQLServer
,PostgreSQL
,MariaDB
. If no value is specified, all types are returned. - engine
Version String - Database version.
- expire
Time String - Expiration time. Pay-As-You-Go instances never expire.
- guard
Instance StringId - If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.
- ha
Mode String - (Available since v1.209.1) The high availability mode of the instance.
- host
Instance List<Property Map>Infos - (Available since v1.209.1) An array that consists of the information of the primary and secondary instances.
- id String
- The ID of the RDS instance.
- instance
Storage Number - (Available in 1.70.3+) User-defined DB instance storage space.
- instance
Type String - Sizing of the RDS instance.
- key
Usage String - (Available in 1.124.3+) The purpose of the encryption key.
- last
Modify StringStatus - (Available in 1.124.1+) The status of the SSL link. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- success
- setting
- failed
- master
Instance StringId - ID of the primary instance. If this parameter is not returned, the current instance is a primary instance.
- master
Zone String - (Available in 1.101.0+) The master zone of the instance.
- material
Expire StringTime - (Available in 1.124.3+) The time when the encryption key expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- modify
Status StringReason - (Available in 1.124.1+) The reason why the SSL link stays in the current state. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- name String
- The name of the RDS instance.
- net
Type String Internet
for public network orIntranet
for private network.- origin String
- (Available in 1.124.3+) The source of the encryption key.
- parameters List<Property Map>
- (Available in 1.135.0+) Parameter list.
- port String
- (Available in 1.70.3+) RDS database connection port.
- readonly
Instance List<String>Ids - A list of IDs of read-only instances attached to the primary instance.
- region
Id String - The region ID of the instance.
- replication
Acl String - (Available in 1.124.1+) The method that is used to verify the replication permission. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:
- cert
- perfer
- verify-ca
- verify-full (supported only when the instance runs PostgreSQL 12 or later)
- require
Update String - (Available in 1.124.1+) Indicates whether the server certificate needs to be updated.
- Valid values for ApsaraDB RDS for MySQL and ApsaraDB RDS for SQL Server:
- No
- Yes
- Valid values for ApsaraDB RDS for PostgreSQL:
- 0: no
- 1: yes
- require
Update StringItem - (Available in 1.124.1+) The server certificate that needs to be updated. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- require
Update StringReason - (Available in 1.124.1+) The reason why the server certificate needs to be updated. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- server
Ca StringUrl - (Available in 1.124.1+) The URL of the CA that issues the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- server
Cert String - (Available in 1.124.1+) The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- server
Key String - (Available in 1.124.1+) The private key of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs.
- ssl
Create StringTime - (Available in 1.124.1+) The time when the server certificate was created. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. In addition, this parameter is valid only when the CAType parameter is set to aliyun.
- ssl
Enabled String - (Available in 1.124.1+) Indicates whether SSL encryption is enabled. Valid values:
- on: enabled
- off: disabled
- ssl
Expire StringTime - (Available in 1.124.1+) The time when the server certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- status String
- Status of the instance.
- sync
Mode String - (Available since v1.209.1) The data replication mode of the instance.
- temp
Instance StringId - If a temporary instance is attached to the current instance, the ID of the temporary instance applies.
- vpc
Id String - Used to retrieve instances belong to specified VPC.
- vswitch
Id String - Used to retrieve instances belong to specified
vswitch
resources. - zone
Id StringSlave A - (Available in 1.101.0+) The region ID of the secondary instance if you create a secondary instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.
- zone
Id StringSlave B - (Available in 1.101.0+) The region ID of the log instance if you create a log instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.
GetInstancesInstanceHostInstanceInfo
- Data
Sync stringTime - The time when the secondary instance completed the synchronization of data from the primary instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Log
Sync stringTime - The time when the secondary instance received logs from the primary instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Node
Id string - The ID of the instance.
- Node
Type string - The type of the node.
- Region
Id string - The region ID of the instance.
- Sync
Status string - The synchronization status.
- Zone
Id string - The ID of the zone.
- Data
Sync stringTime - The time when the secondary instance completed the synchronization of data from the primary instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Log
Sync stringTime - The time when the secondary instance received logs from the primary instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Node
Id string - The ID of the instance.
- Node
Type string - The type of the node.
- Region
Id string - The region ID of the instance.
- Sync
Status string - The synchronization status.
- Zone
Id string - The ID of the zone.
- data
Sync StringTime - The time when the secondary instance completed the synchronization of data from the primary instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- log
Sync StringTime - The time when the secondary instance received logs from the primary instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- node
Id String - The ID of the instance.
- node
Type String - The type of the node.
- region
Id String - The region ID of the instance.
- sync
Status String - The synchronization status.
- zone
Id String - The ID of the zone.
- data
Sync stringTime - The time when the secondary instance completed the synchronization of data from the primary instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- log
Sync stringTime - The time when the secondary instance received logs from the primary instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- node
Id string - The ID of the instance.
- node
Type string - The type of the node.
- region
Id string - The region ID of the instance.
- sync
Status string - The synchronization status.
- zone
Id string - The ID of the zone.
- data_
sync_ strtime - The time when the secondary instance completed the synchronization of data from the primary instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- log_
sync_ strtime - The time when the secondary instance received logs from the primary instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- node_
id str - The ID of the instance.
- node_
type str - The type of the node.
- region_
id str - The region ID of the instance.
- sync_
status str - The synchronization status.
- zone_
id str - The ID of the zone.
- data
Sync StringTime - The time when the secondary instance completed the synchronization of data from the primary instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- log
Sync StringTime - The time when the secondary instance received logs from the primary instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- node
Id String - The ID of the instance.
- node
Type String - The type of the node.
- region
Id String - The region ID of the instance.
- sync
Status String - The synchronization status.
- zone
Id String - The ID of the zone.
GetInstancesInstanceParameter
- Checking
Code string - The value range of the parameter.
- Force
Modify string - Indicates whether the parameter can be modified. Valid values: true | false
- Force
Restart string - Indicates whether the modified parameter takes effect only after a database restart. Valid values: true | false
- Parameter
Description string - The description of the parameter.
- Parameter
Name string - The name of the parameter.
- Parameter
Value string - The default value of the parameter.
- Checking
Code string - The value range of the parameter.
- Force
Modify string - Indicates whether the parameter can be modified. Valid values: true | false
- Force
Restart string - Indicates whether the modified parameter takes effect only after a database restart. Valid values: true | false
- Parameter
Description string - The description of the parameter.
- Parameter
Name string - The name of the parameter.
- Parameter
Value string - The default value of the parameter.
- checking
Code String - The value range of the parameter.
- force
Modify String - Indicates whether the parameter can be modified. Valid values: true | false
- force
Restart String - Indicates whether the modified parameter takes effect only after a database restart. Valid values: true | false
- parameter
Description String - The description of the parameter.
- parameter
Name String - The name of the parameter.
- parameter
Value String - The default value of the parameter.
- checking
Code string - The value range of the parameter.
- force
Modify string - Indicates whether the parameter can be modified. Valid values: true | false
- force
Restart string - Indicates whether the modified parameter takes effect only after a database restart. Valid values: true | false
- parameter
Description string - The description of the parameter.
- parameter
Name string - The name of the parameter.
- parameter
Value string - The default value of the parameter.
- checking_
code str - The value range of the parameter.
- force_
modify str - Indicates whether the parameter can be modified. Valid values: true | false
- force_
restart str - Indicates whether the modified parameter takes effect only after a database restart. Valid values: true | false
- parameter_
description str - The description of the parameter.
- parameter_
name str - The name of the parameter.
- parameter_
value str - The default value of the parameter.
- checking
Code String - The value range of the parameter.
- force
Modify String - Indicates whether the parameter can be modified. Valid values: true | false
- force
Restart String - Indicates whether the modified parameter takes effect only after a database restart. Valid values: true | false
- parameter
Description String - The description of the parameter.
- parameter
Name String - The name of the parameter.
- parameter
Value String - The default value of the parameter.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloud
Terraform Provider.