Instance

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. In addition, this parameter is available only when the public key of the CA that issues client certificates is enabled. Valid values:

Whether to renewal a DB instance automatically or not. It is valid when instance_charge_type is PrePaid. Default to false.

Auto-renewal period of an instance, in the unit of the month. It is valid when instance_charge_type is PrePaid. Valid value:1~12, Default to 1.

The upgrade method to use. Valid values:

The configuration of an ApsaraDB RDS for PostgreSQL instance for which Babelfish is enabled. See babelfish_config below.

The TDS port of the instance for which Babelfish is enabled.

Specifies whether to enable the I/O burst feature of general ESSDs. Valid values:

The RDS edition of the instance. If you want to create a serverless instance, you must use this value. Valid values:

The type of the server certificate. This parameter is supported only when the instance runs PostgreSQL or MySQL with standard or enhanced SSDs. If you set the SSLEnabled parameter to 1, the default value of this parameter is aliyun. NOTE: From version 1.231.0, ca_type start support MySQL engine. Value range:

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. If you set the ClientCAEbabled parameter to 1, you must also specify this parameter.

Specifies whether to enable 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. Valid values:

The CRL that contains revoked client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. If you set the ClientCrlEnabled parameter to 1, you must also specify this parameter.

Specifies whether to enable a certificate revocation list (CRL) that contains revoked client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. In addition, this parameter is available only when the public key of the CA that issues client certificates is enabled. Valid values:

RDS database connection string.

The private connection string prefix. If you want to update public connection string prefix, please use resource alicloud.rds.Connection connection_prefix.

(Available since 1.204.1) The creation time of db instance.

The attribute of the IP address whitelist. By default, this parameter is empty.

The name of the IP address whitelist. Default value: Default.

The storage type of the instance. Serverless instance, only cloud_essd can be selected. Valid values:

(Available since 1.197.0) The type of db instance.

Specifies whether table names on the instance are case-sensitive. Valid values: true, false.

Parameter template ID. Only MySQL and PostgreSQL support this parameter. If this parameter is not specified, the default parameter template is used. You can also customize a parameter template and use it here.

The time zone of the instance. This parameter takes effect only when you set the Engine parameter to MySQL or PostgreSQL.

The switch of delete protection. Valid values:

The instance configuration type. Valid values: "Up", "Down", "TempUpgrade", "Serverless"

The method to update the engine version and change. Default value: Immediate. Valid values:

The key id of the KMS. Used for encrypting a disk if not null. Only for PostgreSQL, MySQL and SQLServer. When the instance is PostgreSQL, this parameter can be used to enable, modify, and disable cloud disk encryption.Value range:

Database type. Value options: MySQL, SQLServer, PostgreSQL, MariaDB.

Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

Specifies whether to enable forcible switching. Valid values:

Set it to true to make some parameter efficient when modifying them. Default to false.

The read-only instances to which you want to synchronize the IP address whitelist.

The primary/secondary switchover mode of the instance. Default value: Auto. Valid values:

Valid values are Prepaid, Postpaid, Serverless, Default to Postpaid. Currently, the resource only supports PostPaid to PrePaid. For more information, see Overview.

The name of DB instance. It a string of 2 to 256 characters.

User-defined DB instance storage space. Value range:

DB Instance type. For details, see Instance type table.

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

The time after when you want to enable automatic primary/secondary switchover. At most, you can set this parameter to 23:59:59 seven days later. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

The method that is used to modify the IP address whitelist. Default value: Cover. Valid values:

The monitoring frequency in seconds. Valid values are 5, 10, 60, 300. Defaults to 300.

The globally unique identifier (GUID) of the secondary instance. You can call the DescribeDBInstanceHAConfig operation to query the GUID of the secondary instance.

Write optimization function switch. supported engine type: MySQL. Valid values:

Set of parameters needs to be set after DB instance was launched. Available parameters can refer to the latest docs View database parameter templates . See parameters below.

The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: 1~9, 12, 24, 36.

Modify the PgBouncer feature of the RDS PostgreSQL instance. Valid values:

The configuration of AD domain . See pg_hba_conf below.

The private port of the database service. If you want to update public port, please use resource alicloud.rds.Connection port.

The private IP address of the instance. The private IP address must be within the Classless Inter-Domain Routing (CIDR) block of the vSwitch that is specified by the VSwitchId parameter.

Enable the Simple Recovery Model for an RDS SQL Server Instance.The Simple Recovery Model feature is only supported by the Basic Series of RDS SQL Server instances. Once this feature is enabled, it cannot be disabled.Valid values:

The policy based on which ApsaraDB RDS retains archived backup files after the instance is released. Valid values:

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. In addition, this parameter is available only when the public key of the CA that issues client certificates is enabled. Valid values:

The ID of resource group which the DB instance belongs.

The Alibaba Cloud Resource Name (ARN) of the RAM role.

It has been deprecated from 1.69.0 and use security_group_ids instead.

, Available since 1.69.0) The list IDs to join ECS Security Group. At most supports three security groups.

Valid values are normal, safety, Default to normal. support safety switch to high security access mode.

List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is 1,32).

The type of IP address in the IP address whitelist.

The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL or MySQL with standard or enhanced SSDs. If you set the CAType parameter to custom, you must also specify this parameter. NOTE: From version 1.231.0, server_cert start support MySQL engine.

The private key of the server certificate. This parameter is supported only when the instance runs PostgreSQL or MySQL with standard or enhanced SSDs. If you set the CAType parameter to custom, you must also specify this parameter. NOTE: From version 1.231.0, server_key start support MySQL engine.

The settings of the serverless instance. This parameter is required when you create a serverless instance. This parameter takes effect only when you create an ApsaraDB RDS for Serverless instance. See serverless_config below.

The sql collector keep time of the instance. Valid values are 30, 180, 365, 1095, 1825, Default to 30.

The sql collector status of the instance. Valid values are Enabled, Disabled, Default to Disabled.

Actions performed on SSL functions. Valid values: Open: turn on SSL encryption; Close: turn off SSL encryption; Update: update SSL certificate. See more engine and engineVersion limitation.

The internal or public endpoint for which the server certificate needs to be created or updated.

Status of the SSL feature. Yes: SSL is turned on; No: SSL is turned off.

(Available since 1.204.1) The status of db instance.

Automatic storage space expansion switch. Valid values:

The threshold in percentage based on which an automatic storage expansion is triggered. If the available storage reaches the threshold, ApsaraDB RDS increases the storage capacity of the instance. Valid values: 10, 20, 30, 40, 50.

The upper limit of the total storage space for automatic expansion of the storage space, that is, automatic expansion will not cause the total storage space of the instance to exceed this value. Unit: GB. The value must be ≥0.

The specific point in time when you want to perform the update. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. It is valid only when target_minor_version is changed. The time must be in UTC.

A mapping of tags to assign to the resource.

The minor engine version to which you want to update the instance. If you do not specify this parameter, the instance is updated to the latest minor engine version. You must specify the minor engine version in one of the following formats:

The availability check method of the instance. Valid values:

The ID of the custom key.

The TDE(Transparent Data Encryption) status. After TDE is turned on, it cannot be turned off. See more engine and engineVersion limitation.

Whether to upgrade a minor version of the kernel. Valid values:

The method to update the minor engine version. Default value: Immediate. It is valid only when target_minor_version is changed. Valid values:

The VPC ID of the instance.

The virtual switch ID to launch DB instances in one VPC. If there are multiple vswitches, separate them with commas.

The network type of the IP address whitelist. Default value: MIX. Valid values:

The Zone to launch the DB instance. From version 1.8.1, it supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in the one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.

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.

RDS MySQL Cluster series instances support creating 1 to 2 secondary nodes at the same time when establishing a new instance. If you have this requirement, you can use this parameter to specify the availability zone for the second secondary node.