Alibaba Cloud

v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

getInstances

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.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var dbInstancesDs = Output.Create(AliCloud.Rds.GetInstances.InvokeAsync(new AliCloud.Rds.GetInstancesArgs
        {
            NameRegex = "data-\\d+",
            Status = "Running",
            Tags = 
            {
                { "size", "tiny" },
                { "type", "database" },
            },
        }));
        this.FirstDbInstanceId = dbInstancesDs.Apply(dbInstancesDs => dbInstancesDs.Instances?[0]?.Id);
    }

    [Output("firstDbInstanceId")]
    public Output<string> FirstDbInstanceId { get; set; }
}
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{}{
				"size": "tiny",
				"type": "database",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstDbInstanceId", dbInstancesDs.Instances[0].Id)
		return nil
	})
}
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.actiontrail.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(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

        ctx.export("firstDbInstanceId", dbInstancesDs.applyValue(getInstancesResult -> getInstancesResult.instances()[0].id()));
    }
}
import pulumi
import pulumi_alicloud as alicloud

db_instances_ds = alicloud.rds.get_instances(name_regex="data-\\d+",
    status="Running",
    tags={
        "size": "tiny",
        "type": "database",
    })
pulumi.export("firstDbInstanceId", db_instances_ds.instances[0].id)
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const dbInstancesDs = pulumi.output(alicloud.rds.getInstances({
    nameRegex: "data-\\d+",
    status: "Running",
    tags: {
        size: "tiny",
        type: "database",
    },
}));

export const firstDbInstanceId = dbInstancesDs.instances[0].id;
variables:
  dbInstancesDs:
    Fn::Invoke:
      Function: alicloud:rds:getInstances
      Arguments:
        nameRegex: data-\d+
        status: Running
        tags:
          size: tiny
          type: database
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, Any]] = 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, Any]]] = 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:

ConnectionMode string

Standard for standard access mode and Safe for high security access mode.

DbType string

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

EnableDetails bool

Default to false. Set it to true can output parameter template about resource attributes.

Engine string

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

Ids List<string>

A list of RDS instance IDs.

NameRegex string

A regex string to filter results by instance name.

OutputFile string
PageNumber int
PageSize int
Status string

Status of the instance.

Tags Dictionary<string, object>

A map of tags assigned to the DB instances. Note: Before 1.60.0, the value's format is a json string which including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example "{\"key1\":\"value1\"}"

VpcId string

Used to retrieve instances belong to specified VPC.

VswitchId string

Used to retrieve instances belong to specified vswitch resources.

ConnectionMode string

Standard for standard access mode and Safe for high security access mode.

DbType string

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

EnableDetails bool

Default to false. Set it to true can output parameter template about resource attributes.

Engine string

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

Ids []string

A list of RDS instance IDs.

NameRegex string

A regex string to filter results by instance name.

OutputFile string
PageNumber int
PageSize int
Status string

Status of the instance.

Tags map[string]interface{}

A map of tags assigned to the DB instances. Note: Before 1.60.0, the value's format is a json string which including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example "{\"key1\":\"value1\"}"

VpcId string

Used to retrieve instances belong to specified VPC.

VswitchId string

Used to retrieve instances belong to specified vswitch resources.

connectionMode String

Standard for standard access mode and Safe for high security access mode.

dbType String

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

enableDetails Boolean

Default to false. Set it to true can output parameter template about resource attributes.

engine String

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

ids List<String>

A list of RDS instance IDs.

nameRegex String

A regex string to filter results by instance name.

outputFile String
pageNumber Integer
pageSize Integer
status String

Status of the instance.

tags Map<String,Object>

A map of tags assigned to the DB instances. Note: Before 1.60.0, the value's format is a json string which including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example "{\"key1\":\"value1\"}"

vpcId String

Used to retrieve instances belong to specified VPC.

vswitchId String

Used to retrieve instances belong to specified vswitch resources.

connectionMode string

Standard for standard access mode and Safe for high security access mode.

dbType string

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

enableDetails boolean

Default to false. Set it to true can output parameter template about resource attributes.

engine string

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

ids string[]

A list of RDS instance IDs.

nameRegex string

A regex string to filter results by instance name.

outputFile string
pageNumber number
pageSize number
status string

Status of the instance.

tags {[key: string]: any}

A map of tags assigned to the DB instances. Note: Before 1.60.0, the value's format is a json string which including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example "{\"key1\":\"value1\"}"

vpcId string

Used to retrieve instances belong to specified VPC.

vswitchId string

Used to retrieve instances belong to specified vswitch resources.

connection_mode str

Standard for standard access mode and Safe for high security access mode.

db_type str

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

enable_details bool

Default to false. Set it to true can output parameter template about resource attributes.

engine str

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. 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
page_number int
page_size int
status str

Status of the instance.

tags Mapping[str, Any]

A map of tags assigned to the DB instances. Note: Before 1.60.0, the value's format is a json string which including TagKey and TagValue. TagKey cannot be null, and TagValue 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.

connectionMode String

Standard for standard access mode and Safe for high security access mode.

dbType String

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

enableDetails Boolean

Default to false. Set it to true can output parameter template about resource attributes.

engine String

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

ids List<String>

A list of RDS instance IDs.

nameRegex String

A regex string to filter results by instance name.

outputFile String
pageNumber Number
pageSize Number
status String

Status of the instance.

tags Map<Any>

A map of tags assigned to the DB instances. Note: Before 1.60.0, the value's format is a json string which including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example "{\"key1\":\"value1\"}"

vpcId String

Used to retrieve instances belong to specified VPC.

vswitchId 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.AliCloud.Rds.Outputs.GetInstancesInstance>

A list of RDS instances. Each element contains the following attributes:

Names List<string>

A list of RDS instance names.

TotalCount int
ConnectionMode string

Standard for standard access mode and Safe for high security access mode.

DbType string

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

EnableDetails bool
Engine string

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

NameRegex string
OutputFile string
PageNumber int
PageSize int
Status string

Status of the instance.

Tags Dictionary<string, object>
VpcId string

ID of the VPC the instance belongs to.

VswitchId 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 []GetInstancesInstance

A list of RDS instances. Each element contains the following attributes:

Names []string

A list of RDS instance names.

TotalCount int
ConnectionMode string

Standard for standard access mode and Safe for high security access mode.

DbType string

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

EnableDetails bool
Engine string

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

NameRegex string
OutputFile string
PageNumber int
PageSize int
Status string

Status of the instance.

Tags map[string]interface{}
VpcId string

ID of the VPC the instance belongs to.

VswitchId 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<GetInstancesInstance>

A list of RDS instances. Each element contains the following attributes:

names List<String>

A list of RDS instance names.

totalCount Integer
connectionMode String

Standard for standard access mode and Safe for high security access mode.

dbType String

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

enableDetails Boolean
engine String

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

nameRegex String
outputFile String
pageNumber Integer
pageSize Integer
status String

Status of the instance.

tags Map<String,Object>
vpcId String

ID of the VPC the instance belongs to.

vswitchId 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 GetInstancesInstance[]

A list of RDS instances. Each element contains the following attributes:

names string[]

A list of RDS instance names.

totalCount number
connectionMode string

Standard for standard access mode and Safe for high security access mode.

dbType string

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

enableDetails boolean
engine string

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

nameRegex string
outputFile string
pageNumber number
pageSize number
status string

Status of the instance.

tags {[key: string]: any}
vpcId string

ID of the VPC the instance belongs to.

vswitchId 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[GetInstancesInstance]

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 and Safe for high security access mode.

db_type str

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

enable_details bool
engine str

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. 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.

tags Mapping[str, Any]
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.

totalCount Number
connectionMode String

Standard for standard access mode and Safe for high security access mode.

dbType String

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

enableDetails Boolean
engine String

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

nameRegex String
outputFile String
pageNumber Number
pageSize Number
status String

Status of the instance.

tags Map<Any>
vpcId String

ID of the VPC the instance belongs to.

vswitchId 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)
AvailabilityZone string

Availability zone.

CaType 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
ChargeType string

Billing method. Value options: Postpaid for Pay-As-You-Go and Prepaid for subscription.

ClientCaCert string

(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.

ClientCaCertExpireTime string
ClientCertRevocationList string

(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.

ConnectionMode string

Standard for standard access mode and Safe for high security access mode.

ConnectionString string

(Available in 1.70.3+) RDS database connection string.

CreateTime string

Creation time of the instance.

Creator string

(Available in 1.124.3+) The creator of the encryption key.

DbInstanceStorageType string

(Available in 1.70.3+) The storage type of the instance.

DbType string

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

DeleteDate 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.

DeletionProtection 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.

EncryptionKey string

(Available in 1.124.3+) The ID of the encryption key.

EncryptionKeyStatus string

(Available in 1.124.3+) The status of the encryption key. Valid values:

  • Enabled
  • Disabled
Engine string

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

EngineVersion string

Database version.

ExpireTime string

Expiration time. Pay-As-You-Go instances never expire.

GuardInstanceId string

If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.

Id string

The ID of the RDS instance.

InstanceStorage int

(Available in 1.70.3+) User-defined DB instance storage space.

InstanceType string

Sizing of the RDS instance.

KeyUsage string

(Available in 1.124.3+) The purpose of the encryption key.

LastModifyStatus string

(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
MasterInstanceId string

ID of the primary instance. If this parameter is not returned, the current instance is a primary instance.

MasterZone string

(Available in 1.101.0+) The master zone of the instance.

MaterialExpireTime string

(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.

ModifyStatusReason string

(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.

NetType string

Internet for public network or Intranet for private network.

Origin string

(Available in 1.124.3+) The source of the encryption key.

Parameters List<Pulumi.AliCloud.Rds.Inputs.GetInstancesInstanceParameter>

(Available in 1.135.0+) Parameter list.

Port string

(Available in 1.70.3+) RDS database connection port.

ReadonlyInstanceIds List<string>

A list of IDs of read-only instances attached to the primary instance.

RegionId string

Region ID the instance belongs to.

ReplicationAcl 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)
RequireUpdate 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
RequireUpdateItem string

(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.

RequireUpdateReason string

(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.

ServerCaUrl string

(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.

ServerCert 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.

ServerKey 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.

SslCreateTime string

(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.

SslEnabled string

(Available in 1.124.1+) Indicates whether SSL encryption is enabled. Valid values:

  • on: enabled
  • off: disabled
SslExpireTime string

(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.

TempInstanceId string

If a temporary instance is attached to the current instance, the ID of the temporary instance applies.

VpcId string

Used to retrieve instances belong to specified VPC.

VswitchId string

Used to retrieve instances belong to specified vswitch resources.

ZoneIdSlaveA string

(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.

ZoneIdSlaveB string

(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)
AvailabilityZone string

Availability zone.

CaType 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
ChargeType string

Billing method. Value options: Postpaid for Pay-As-You-Go and Prepaid for subscription.

ClientCaCert string

(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.

ClientCaCertExpireTime string
ClientCertRevocationList string

(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.

ConnectionMode string

Standard for standard access mode and Safe for high security access mode.

ConnectionString string

(Available in 1.70.3+) RDS database connection string.

CreateTime string

Creation time of the instance.

Creator string

(Available in 1.124.3+) The creator of the encryption key.

DbInstanceStorageType string

(Available in 1.70.3+) The storage type of the instance.

DbType string

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

DeleteDate 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.

DeletionProtection 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.

EncryptionKey string

(Available in 1.124.3+) The ID of the encryption key.

EncryptionKeyStatus string

(Available in 1.124.3+) The status of the encryption key. Valid values:

  • Enabled
  • Disabled
Engine string

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

EngineVersion string

Database version.

ExpireTime string

Expiration time. Pay-As-You-Go instances never expire.

GuardInstanceId string

If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.

Id string

The ID of the RDS instance.

InstanceStorage int

(Available in 1.70.3+) User-defined DB instance storage space.

InstanceType string

Sizing of the RDS instance.

KeyUsage string

(Available in 1.124.3+) The purpose of the encryption key.

LastModifyStatus string

(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
MasterInstanceId string

ID of the primary instance. If this parameter is not returned, the current instance is a primary instance.

MasterZone string

(Available in 1.101.0+) The master zone of the instance.

MaterialExpireTime string

(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.

ModifyStatusReason string

(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.

NetType string

Internet for public network or Intranet for private network.

Origin string

(Available in 1.124.3+) The source of the encryption key.

Parameters []GetInstancesInstanceParameter

(Available in 1.135.0+) Parameter list.

Port string

(Available in 1.70.3+) RDS database connection port.

ReadonlyInstanceIds []string

A list of IDs of read-only instances attached to the primary instance.

RegionId string

Region ID the instance belongs to.

ReplicationAcl 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)
RequireUpdate 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
RequireUpdateItem string

(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.

RequireUpdateReason string

(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.

ServerCaUrl string

(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.

ServerCert 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.

ServerKey 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.

SslCreateTime string

(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.

SslEnabled string

(Available in 1.124.1+) Indicates whether SSL encryption is enabled. Valid values:

  • on: enabled
  • off: disabled
SslExpireTime string

(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.

TempInstanceId string

If a temporary instance is attached to the current instance, the ID of the temporary instance applies.

VpcId string

Used to retrieve instances belong to specified VPC.

VswitchId string

Used to retrieve instances belong to specified vswitch resources.

ZoneIdSlaveA string

(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.

ZoneIdSlaveB string

(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)
availabilityZone String

Availability zone.

caType 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
chargeType String

Billing method. Value options: Postpaid for Pay-As-You-Go and Prepaid for subscription.

clientCaCert String

(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.

clientCaCertExpireTime String
clientCertRevocationList String

(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.

connectionMode String

Standard for standard access mode and Safe for high security access mode.

connectionString String

(Available in 1.70.3+) RDS database connection string.

createTime String

Creation time of the instance.

creator String

(Available in 1.124.3+) The creator of the encryption key.

dbInstanceStorageType String

(Available in 1.70.3+) The storage type of the instance.

dbType String

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

deleteDate 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.

deletionProtection 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.

encryptionKey String

(Available in 1.124.3+) The ID of the encryption key.

encryptionKeyStatus String

(Available in 1.124.3+) The status of the encryption key. Valid values:

  • Enabled
  • Disabled
engine String

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

engineVersion String

Database version.

expireTime String

Expiration time. Pay-As-You-Go instances never expire.

guardInstanceId String

If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.

id String

The ID of the RDS instance.

instanceStorage Integer

(Available in 1.70.3+) User-defined DB instance storage space.

instanceType String

Sizing of the RDS instance.

keyUsage String

(Available in 1.124.3+) The purpose of the encryption key.

lastModifyStatus String

(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
masterInstanceId String

ID of the primary instance. If this parameter is not returned, the current instance is a primary instance.

masterZone String

(Available in 1.101.0+) The master zone of the instance.

materialExpireTime String

(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.

modifyStatusReason String

(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.

netType String

Internet for public network or Intranet for private network.

origin String

(Available in 1.124.3+) The source of the encryption key.

parameters List<GetInstancesInstanceParameter>

(Available in 1.135.0+) Parameter list.

port String

(Available in 1.70.3+) RDS database connection port.

readonlyInstanceIds List<String>

A list of IDs of read-only instances attached to the primary instance.

regionId String

Region ID the instance belongs to.

replicationAcl 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)
requireUpdate 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
requireUpdateItem String

(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.

requireUpdateReason String

(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.

serverCaUrl String

(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.

serverCert 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.

serverKey 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.

sslCreateTime String

(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.

sslEnabled String

(Available in 1.124.1+) Indicates whether SSL encryption is enabled. Valid values:

  • on: enabled
  • off: disabled
sslExpireTime String

(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.

tempInstanceId String

If a temporary instance is attached to the current instance, the ID of the temporary instance applies.

vpcId String

Used to retrieve instances belong to specified VPC.

vswitchId String

Used to retrieve instances belong to specified vswitch resources.

zoneIdSlaveA String

(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.

zoneIdSlaveB String

(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)
availabilityZone string

Availability zone.

caType 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
chargeType string

Billing method. Value options: Postpaid for Pay-As-You-Go and Prepaid for subscription.

clientCaCert string

(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.

clientCaCertExpireTime string
clientCertRevocationList string

(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.

connectionMode string

Standard for standard access mode and Safe for high security access mode.

connectionString string

(Available in 1.70.3+) RDS database connection string.

createTime string

Creation time of the instance.

creator string

(Available in 1.124.3+) The creator of the encryption key.

dbInstanceStorageType string

(Available in 1.70.3+) The storage type of the instance.

dbType string

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

deleteDate 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.

deletionProtection 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.

encryptionKey string

(Available in 1.124.3+) The ID of the encryption key.

encryptionKeyStatus string

(Available in 1.124.3+) The status of the encryption key. Valid values:

  • Enabled
  • Disabled
engine string

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

engineVersion string

Database version.

expireTime string

Expiration time. Pay-As-You-Go instances never expire.

guardInstanceId string

If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.

id string

The ID of the RDS instance.

instanceStorage number

(Available in 1.70.3+) User-defined DB instance storage space.

instanceType string

Sizing of the RDS instance.

keyUsage string

(Available in 1.124.3+) The purpose of the encryption key.

lastModifyStatus string

(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
masterInstanceId string

ID of the primary instance. If this parameter is not returned, the current instance is a primary instance.

masterZone string

(Available in 1.101.0+) The master zone of the instance.

materialExpireTime string

(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.

modifyStatusReason string

(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.

netType string

Internet for public network or Intranet for private network.

origin string

(Available in 1.124.3+) The source of the encryption key.

parameters GetInstancesInstanceParameter[]

(Available in 1.135.0+) Parameter list.

port string

(Available in 1.70.3+) RDS database connection port.

readonlyInstanceIds string[]

A list of IDs of read-only instances attached to the primary instance.

regionId string

Region ID the instance belongs to.

replicationAcl 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)
requireUpdate 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
requireUpdateItem string

(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.

requireUpdateReason string

(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.

serverCaUrl string

(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.

serverCert 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.

serverKey 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.

sslCreateTime string

(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.

sslEnabled string

(Available in 1.124.1+) Indicates whether SSL encryption is enabled. Valid values:

  • on: enabled
  • off: disabled
sslExpireTime string

(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.

tempInstanceId string

If a temporary instance is attached to the current instance, the ID of the temporary instance applies.

vpcId string

Used to retrieve instances belong to specified VPC.

vswitchId string

Used to retrieve instances belong to specified vswitch resources.

zoneIdSlaveA string

(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.

zoneIdSlaveB string

(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 and Prepaid for subscription.

client_ca_cert str

(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_cert_expire_time str
client_cert_revocation_list str

(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 and Safe 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_storage_type str

(Available in 1.70.3+) The storage type of the instance.

db_type str

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp 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_status str

(Available in 1.124.3+) The status of the encryption key. Valid values:

  • Enabled
  • Disabled
engine str

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. 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_id str

If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.

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_status str

(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_id str

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_time str

(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_reason str

(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 or Intranet for private network.

origin str

(Available in 1.124.3+) The source of the encryption key.

parameters Sequence[GetInstancesInstanceParameter]

(Available in 1.135.0+) Parameter list.

port str

(Available in 1.70.3+) RDS database connection port.

readonly_instance_ids Sequence[str]

A list of IDs of read-only instances attached to the primary instance.

region_id str

Region ID the instance belongs to.

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_item str

(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_reason str

(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_url str

(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_time str

(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_time str

(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.

temp_instance_id str

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_slave_a str

(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_slave_b str

(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)
availabilityZone String

Availability zone.

caType 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
chargeType String

Billing method. Value options: Postpaid for Pay-As-You-Go and Prepaid for subscription.

clientCaCert String

(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.

clientCaCertExpireTime String
clientCertRevocationList String

(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.

connectionMode String

Standard for standard access mode and Safe for high security access mode.

connectionString String

(Available in 1.70.3+) RDS database connection string.

createTime String

Creation time of the instance.

creator String

(Available in 1.124.3+) The creator of the encryption key.

dbInstanceStorageType String

(Available in 1.70.3+) The storage type of the instance.

dbType String

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

deleteDate 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.

deletionProtection 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.

encryptionKey String

(Available in 1.124.3+) The ID of the encryption key.

encryptionKeyStatus String

(Available in 1.124.3+) The status of the encryption key. Valid values:

  • Enabled
  • Disabled
engine String

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

engineVersion String

Database version.

expireTime String

Expiration time. Pay-As-You-Go instances never expire.

guardInstanceId String

If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.

id String

The ID of the RDS instance.

instanceStorage Number

(Available in 1.70.3+) User-defined DB instance storage space.

instanceType String

Sizing of the RDS instance.

keyUsage String

(Available in 1.124.3+) The purpose of the encryption key.

lastModifyStatus String

(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
masterInstanceId String

ID of the primary instance. If this parameter is not returned, the current instance is a primary instance.

masterZone String

(Available in 1.101.0+) The master zone of the instance.

materialExpireTime String

(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.

modifyStatusReason String

(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.

netType String

Internet for public network or Intranet 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.

readonlyInstanceIds List<String>

A list of IDs of read-only instances attached to the primary instance.

regionId String

Region ID the instance belongs to.

replicationAcl 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)
requireUpdate 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
requireUpdateItem String

(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.

requireUpdateReason String

(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.

serverCaUrl String

(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.

serverCert 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.

serverKey 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.

sslCreateTime String

(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.

sslEnabled String

(Available in 1.124.1+) Indicates whether SSL encryption is enabled. Valid values:

  • on: enabled
  • off: disabled
sslExpireTime String

(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.

tempInstanceId String

If a temporary instance is attached to the current instance, the ID of the temporary instance applies.

vpcId String

Used to retrieve instances belong to specified VPC.

vswitchId String

Used to retrieve instances belong to specified vswitch resources.

zoneIdSlaveA String

(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.

zoneIdSlaveB String

(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.

GetInstancesInstanceParameter

CheckingCode string

The value range of the parameter.

ForceModify string

Indicates whether the parameter can be modified. Valid values: true | false

ForceRestart string

Indicates whether the modified parameter takes effect only after a database restart. Valid values: true | false

ParameterDescription string

The description of the parameter.

ParameterName string

The name of the parameter.

ParameterValue string

The default value of the parameter.

CheckingCode string

The value range of the parameter.

ForceModify string

Indicates whether the parameter can be modified. Valid values: true | false

ForceRestart string

Indicates whether the modified parameter takes effect only after a database restart. Valid values: true | false

ParameterDescription string

The description of the parameter.

ParameterName string

The name of the parameter.

ParameterValue string

The default value of the parameter.

checkingCode String

The value range of the parameter.

forceModify String

Indicates whether the parameter can be modified. Valid values: true | false

forceRestart String

Indicates whether the modified parameter takes effect only after a database restart. Valid values: true | false

parameterDescription String

The description of the parameter.

parameterName String

The name of the parameter.

parameterValue String

The default value of the parameter.

checkingCode string

The value range of the parameter.

forceModify string

Indicates whether the parameter can be modified. Valid values: true | false

forceRestart string

Indicates whether the modified parameter takes effect only after a database restart. Valid values: true | false

parameterDescription string

The description of the parameter.

parameterName string

The name of the parameter.

parameterValue 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.

checkingCode String

The value range of the parameter.

forceModify String

Indicates whether the parameter can be modified. Valid values: true | false

forceRestart String

Indicates whether the modified parameter takes effect only after a database restart. Valid values: true | false

parameterDescription String

The description of the parameter.

parameterName String

The name of the parameter.

parameterValue String

The default value of the parameter.

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.