alicloud.rds.Instance

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

NOTE: When the 'engine_version' changes, it can be used as the target database version for the large version upgrade of RDS for MySQL instance.

• MySQL: [ 5.5、5.6、5.7、8.0 ]
• SQLServer: [ 2008r2、08r2_ent_ha、2012、2012_ent_ha、2012_std_ha、2012_web、2014_std_ha、2016_ent_ha、2016_std_ha、2016_web、2017_std_ha、2017_ent、2019_std_ha、2019_ent ]
• PostgreSQL: [ 10.0、11.0、12.0、13.0、14.0、15.0 ]
• MariaDB: [ 10.3 ]
• Serverless

• MySQL: [ 5.7、8.0 ]
• SQLServer: [ 2016_std_sl、2017_std_sl、2019_std_sl ]
• PostgreSQL: [ 14.0 ]
• MariaDB does not support creating serverless instances.

• [5, 2000] for MySQL/PostgreSQL HA dual node edition;
• [20,1000] for MySQL 5.7 basic single node edition;
• [10, 2000] for SQL Server 2008R2;
• [20,2000] for SQL Server 2012 basic single node edition Increase progressively at a rate of 5 GB. For details, see Instance type table. Note: There is extra 5 GB storage for SQL Server Instance, and it is not in specified instance_storage.

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

• To create a serverless instance, please pass the following values:
• MySQL basic: mysql.n2.serverless.1c
• MySQL high availability: mysql.n2.serverless.2c
• SQLServer high availability: mssql.mem2.serverless.s2
• PostgreSQL basic: pg.n2.serverless.1c

NOTE: When storage_auto_scale="Enable", do not perform instance_storage check. when storage_auto_scale="Disable", if the instance itself instance_storagehas changed. You need to manually revise the instance_storage in the template value. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

• cert
• perfer
• verify-ca
• verify-full (supported only when the instance runs PostgreSQL 12 or later)

The upgrade method to use. Valid values:

• Auto: Instances are automatically upgraded to a higher minor version.
• Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.

See more details and limitation.

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

NOTE: This parameter takes effect only when you create an ApsaraDB RDS for PostgreSQL instance. For more information, see Introduction to Babelfish.

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

NOTE: This parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see Introduction to Babelfish.

• aliyun: a cloud certificate
• custom: a custom certificate

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

• Basic: Basic Edition.
• HighAvailability: High-availability Edition.
• AlwaysOn: Cluster Edition.
• Finance: Enterprise Edition.
• cluster: MySQL Cluster Edition. (Available since 1.202.0)
• serverless_basic: RDS Serverless Basic Edition. This edition is available only for instances that run MySQL and PostgreSQL. (Available since 1.200.0)
• serverless_standard: RDS Serverless Basic Edition. This edition is available only for instances that run MySQL and PostgreSQL. (Available since 1.204.0)
• serverless_ha: RDS Serverless High-availability Edition for SQL Server. (Available since 1.204.0)

NOTE: zone_id_slave_a and zone_id_slave_b can specify slave zone ids when creating the high-availability or enterprise edition instances. Meanwhile, vswitch_id needs to pass in the corresponding vswitch id to the slave zone by order (If the vswitch_id is not specified, the classic network version will be created). For example, zone_id = "zone-a" and zone_id_slave_a = "zone-c", zone_id_slave_b = "zone-b", then the vswitch_id must be "vsw-zone-a,vsw-zone-c,vsw-zone-b". Of course, you can also choose automatic allocation , for example, zone_id = "zone-a" and zone_id_slave_a = "Auto",zone_id_slave_b = "Auto", then the vswitch_id must be "vsw-zone-a,Auto,Auto". The list contains up to 2 slave zone ids , separated by commas.

• 1: enables the public key
• 0: disables the public key

• 1: enables the CRL
• 0: disables the CRL

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

NOTE: The prefix must be 8 to 64 characters in length and can contain letters, digits, and hyphens (-). It cannot contain Chinese characters and special characters ~!#%^&*=+|{};:'",<>/?

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

NOTE: The IP address whitelists that have the hidden attribute are not displayed in the ApsaraDB RDS console. These IP address whitelists are used to access Alibaba Cloud services, such as Data Transmission Service (DTS).

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

NOTE: A maximum of 200 IP address whitelists can be configured for each instance.

• local_ssd: specifies to use local SSDs. This value is recommended.
• cloud_ssd: specifies to use standard SSDs.
• cloud_essd: specifies to use enhanced SSDs (ESSDs).
• cloud_essd2: specifies to use enhanced SSDs (ESSDs).
• cloud_essd3: specifies to use enhanced SSDs (ESSDs).
• general_essd: general essd.

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

• If you set the Engine parameter to MySQL.
• This time zone of the instance is in UTC. Valid values: -12:59 to +13:00.
• You can specify this parameter when the instance is equipped with local SSDs. For example, you can specify the time zone to Asia/Hong_Kong. For more information about time zones, see Time zones.
• If you set the Engine parameter to PostgreSQL.
• This time zone of the instance is not in UTC. For more information about time zones, see Time zones.
• You can specify this parameter only when the instance is equipped with standard SSDs or ESSDs.

NOTE: You can specify the time zone when you create a primary instance. You cannot specify the time zone when you create a read-only instance. Read-only instances inherit the time zone of their primary instance. If you do not specify this parameter, the system assigns the default time zone of the region where the instance resides.

The switch of delete protection. Valid values:

• true: delete protect.
• false: no delete protect.

NOTE: deletion_protection is valid only when attribute instance_charge_type is set to Postpaid or Serverless, supported engine type: MySQL, PostgreSQL, MariaDB, MSSQL.

• Immediate: The change immediately takes effect.
• MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.

• Yes
• No

• If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
• If the instance is not attached with a read-only instance, this parameter is empty.

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

• Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
• Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.

NOTE: If you set this parameter to Manual, you must specify the ManualHATime parameter.

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.

NOTE: This parameter only takes effect when the HAConfig parameter is set to Manual.

• Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
• Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
• Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.

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.

NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

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

• None: No archived backup files are retained.
• Lastest: Only the last archived backup file is retained.
• All: All the archived backup files are retained.

NOTE: This parameter is supported only when the instance runs the MySQL database engine.

• cert
• perfer
• verify-ca
• verify-full (supported only when the instance runs PostgreSQL 12 or later)

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

NOTE: This parameter is not required when you create an instance that runs MySQL, PostgreSQL, or SQL Server. You need to only specify the RoleARN parameter to create an instance that has cloud disk encryption enabled by using the obtained key ID. You can configure RAM authorization to require a RAM user to enable cloud disk encryption when the RAM user is used to create an instance. If cloud disk encryption is disabled during the instance creation, the creation operation fails. To complete the configuration, you can attach the following policy to the RAM user: {"Version":"1","Statement":[{"Effect":"Deny","Action":"rds:CreateDBInstance","Resource":"*","Condition":{"StringEquals":{"rds:DiskEncryptionRequired":"false"}}}]}

Deprecated: Attribute security_group_id has been deprecated from 1.69.0 and use security_group_ids instead.

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.

NOTE: The attribute ssl_action will be ignored when setting instance_charge_type = "Serverless" for SQLServer, PostgreSQL or MariaDB.

Automatic storage space expansion switch. Valid values:

• Enable
• Disable

NOTE: This parameter only takes effect when the StorageAutoScale parameter is set to Enable.

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

NOTE: This parameter only takes effect when the StorageAutoScale parameter is set to Enable. The value must be greater than or equal to the total size of the current storage space of the instance.

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.

NOTE: Because of data backup and migration, change DB instance type and storage would cost 15~20 minutes. Please make full preparation before changing them.

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.

NOTE: This parameter takes effect only when you set the UpgradeTime parameter to SpecifyTime.

A mapping of tags to assign to the resource.

• Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
• Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

Note: From 1.63.0, the tag key and value are case sensitive. Before that, they are not case sensitive.

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:

• PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
• MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
• rds: The instance runs RDS Basic or High-availability Edition.
• xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
• xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
• SQLServer: . Example: 15.0.4073.23.

NOTE: For more information about minor engine versions, see Release notes of minor AliPG versions, Release notes of minor AliSQL versions, and Release notes of minor engine versions of ApsaraDB RDS for SQL Server.

• SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
• LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.

• true: upgrade
• false: not to upgrade

Deprecated: Attribute upgrade_db_instance_kernel_version has been deprecated from 1.198.0 and use target_minor_version instead.

• Immediate: The minor engine version is immediately updated.
• MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
• SpecifyTime: The minor engine version is updated at the point in time you specify.

The VPC ID of the instance.

NOTE: This parameter applies only to ApsaraDB RDS for MySQL instances. For more information about Upgrade the major engine version of an ApsaraDB RDS for MySQL instance, see Upgrade the major engine version of an RDS instance in the ApsaraDB RDS console.

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

• Classic: classic network in enhanced whitelist mode
• VPC: virtual private cloud (VPC) in enhanced whitelist mode
• MIX: standard whitelist mode

NOTE: In standard whitelist mode, IP addresses and CIDR blocks can be added only to the default IP address whitelist. In enhanced whitelist mode, IP addresses and CIDR blocks can be added to both IP address whitelists of the classic network type and those of the VPC network type.

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

NOTE: When the 'engine_version' changes, it can be used as the target database version for the large version upgrade of RDS for MySQL instance.

• MySQL: [ 5.5、5.6、5.7、8.0 ]
• SQLServer: [ 2008r2、08r2_ent_ha、2012、2012_ent_ha、2012_std_ha、2012_web、2014_std_ha、2016_ent_ha、2016_std_ha、2016_web、2017_std_ha、2017_ent、2019_std_ha、2019_ent ]
• PostgreSQL: [ 10.0、11.0、12.0、13.0、14.0、15.0 ]
• MariaDB: [ 10.3 ]
• Serverless

• MySQL: [ 5.7、8.0 ]
• SQLServer: [ 2016_std_sl、2017_std_sl、2019_std_sl ]
• PostgreSQL: [ 14.0 ]
• MariaDB does not support creating serverless instances.

• [5, 2000] for MySQL/PostgreSQL HA dual node edition;
• [20,1000] for MySQL 5.7 basic single node edition;
• [10, 2000] for SQL Server 2008R2;
• [20,2000] for SQL Server 2012 basic single node edition Increase progressively at a rate of 5 GB. For details, see Instance type table. Note: There is extra 5 GB storage for SQL Server Instance, and it is not in specified instance_storage.

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

• To create a serverless instance, please pass the following values:
• MySQL basic: mysql.n2.serverless.1c
• MySQL high availability: mysql.n2.serverless.2c
• SQLServer high availability: mssql.mem2.serverless.s2
• PostgreSQL basic: pg.n2.serverless.1c

NOTE: When storage_auto_scale="Enable", do not perform instance_storage check. when storage_auto_scale="Disable", if the instance itself instance_storagehas changed. You need to manually revise the instance_storage in the template value. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

• cert
• perfer
• verify-ca
• verify-full (supported only when the instance runs PostgreSQL 12 or later)

The upgrade method to use. Valid values:

• Auto: Instances are automatically upgraded to a higher minor version.
• Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.

See more details and limitation.

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

NOTE: This parameter takes effect only when you create an ApsaraDB RDS for PostgreSQL instance. For more information, see Introduction to Babelfish.

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

NOTE: This parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see Introduction to Babelfish.

• aliyun: a cloud certificate
• custom: a custom certificate

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

• Basic: Basic Edition.
• HighAvailability: High-availability Edition.
• AlwaysOn: Cluster Edition.
• Finance: Enterprise Edition.
• cluster: MySQL Cluster Edition. (Available since 1.202.0)
• serverless_basic: RDS Serverless Basic Edition. This edition is available only for instances that run MySQL and PostgreSQL. (Available since 1.200.0)
• serverless_standard: RDS Serverless Basic Edition. This edition is available only for instances that run MySQL and PostgreSQL. (Available since 1.204.0)
• serverless_ha: RDS Serverless High-availability Edition for SQL Server. (Available since 1.204.0)

NOTE: zone_id_slave_a and zone_id_slave_b can specify slave zone ids when creating the high-availability or enterprise edition instances. Meanwhile, vswitch_id needs to pass in the corresponding vswitch id to the slave zone by order (If the vswitch_id is not specified, the classic network version will be created). For example, zone_id = "zone-a" and zone_id_slave_a = "zone-c", zone_id_slave_b = "zone-b", then the vswitch_id must be "vsw-zone-a,vsw-zone-c,vsw-zone-b". Of course, you can also choose automatic allocation , for example, zone_id = "zone-a" and zone_id_slave_a = "Auto",zone_id_slave_b = "Auto", then the vswitch_id must be "vsw-zone-a,Auto,Auto". The list contains up to 2 slave zone ids , separated by commas.

• 1: enables the public key
• 0: disables the public key

• 1: enables the CRL
• 0: disables the CRL

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

NOTE: The prefix must be 8 to 64 characters in length and can contain letters, digits, and hyphens (-). It cannot contain Chinese characters and special characters ~!#%^&*=+|{};:'",<>/?

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

NOTE: The IP address whitelists that have the hidden attribute are not displayed in the ApsaraDB RDS console. These IP address whitelists are used to access Alibaba Cloud services, such as Data Transmission Service (DTS).

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

NOTE: A maximum of 200 IP address whitelists can be configured for each instance.

• local_ssd: specifies to use local SSDs. This value is recommended.
• cloud_ssd: specifies to use standard SSDs.
• cloud_essd: specifies to use enhanced SSDs (ESSDs).
• cloud_essd2: specifies to use enhanced SSDs (ESSDs).
• cloud_essd3: specifies to use enhanced SSDs (ESSDs).
• general_essd: general essd.

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

• If you set the Engine parameter to MySQL.
• This time zone of the instance is in UTC. Valid values: -12:59 to +13:00.
• You can specify this parameter when the instance is equipped with local SSDs. For example, you can specify the time zone to Asia/Hong_Kong. For more information about time zones, see Time zones.
• If you set the Engine parameter to PostgreSQL.
• This time zone of the instance is not in UTC. For more information about time zones, see Time zones.
• You can specify this parameter only when the instance is equipped with standard SSDs or ESSDs.

NOTE: You can specify the time zone when you create a primary instance. You cannot specify the time zone when you create a read-only instance. Read-only instances inherit the time zone of their primary instance. If you do not specify this parameter, the system assigns the default time zone of the region where the instance resides.

The switch of delete protection. Valid values:

• true: delete protect.
• false: no delete protect.

NOTE: deletion_protection is valid only when attribute instance_charge_type is set to Postpaid or Serverless, supported engine type: MySQL, PostgreSQL, MariaDB, MSSQL.

• Immediate: The change immediately takes effect.
• MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.

• Yes
• No

• If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
• If the instance is not attached with a read-only instance, this parameter is empty.

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

• Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
• Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.

NOTE: If you set this parameter to Manual, you must specify the ManualHATime parameter.

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.

NOTE: This parameter only takes effect when the HAConfig parameter is set to Manual.

• Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
• Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
• Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.

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.

NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

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

• None: No archived backup files are retained.
• Lastest: Only the last archived backup file is retained.
• All: All the archived backup files are retained.

NOTE: This parameter is supported only when the instance runs the MySQL database engine.

• cert
• perfer
• verify-ca
• verify-full (supported only when the instance runs PostgreSQL 12 or later)

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

NOTE: This parameter is not required when you create an instance that runs MySQL, PostgreSQL, or SQL Server. You need to only specify the RoleARN parameter to create an instance that has cloud disk encryption enabled by using the obtained key ID. You can configure RAM authorization to require a RAM user to enable cloud disk encryption when the RAM user is used to create an instance. If cloud disk encryption is disabled during the instance creation, the creation operation fails. To complete the configuration, you can attach the following policy to the RAM user: {"Version":"1","Statement":[{"Effect":"Deny","Action":"rds:CreateDBInstance","Resource":"*","Condition":{"StringEquals":{"rds:DiskEncryptionRequired":"false"}}}]}

Deprecated: Attribute security_group_id has been deprecated from 1.69.0 and use security_group_ids instead.

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.

NOTE: The attribute ssl_action will be ignored when setting instance_charge_type = "Serverless" for SQLServer, PostgreSQL or MariaDB.

Automatic storage space expansion switch. Valid values:

• Enable
• Disable

NOTE: This parameter only takes effect when the StorageAutoScale parameter is set to Enable.

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

NOTE: This parameter only takes effect when the StorageAutoScale parameter is set to Enable. The value must be greater than or equal to the total size of the current storage space of the instance.

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.

NOTE: Because of data backup and migration, change DB instance type and storage would cost 15~20 minutes. Please make full preparation before changing them.

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.

NOTE: This parameter takes effect only when you set the UpgradeTime parameter to SpecifyTime.

A mapping of tags to assign to the resource.

• Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
• Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

Note: From 1.63.0, the tag key and value are case sensitive. Before that, they are not case sensitive.

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:

• PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
• MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
• rds: The instance runs RDS Basic or High-availability Edition.
• xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
• xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
• SQLServer: . Example: 15.0.4073.23.

NOTE: For more information about minor engine versions, see Release notes of minor AliPG versions, Release notes of minor AliSQL versions, and Release notes of minor engine versions of ApsaraDB RDS for SQL Server.

• SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
• LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.

• true: upgrade
• false: not to upgrade

Deprecated: Attribute upgrade_db_instance_kernel_version has been deprecated from 1.198.0 and use target_minor_version instead.

• Immediate: The minor engine version is immediately updated.
• MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
• SpecifyTime: The minor engine version is updated at the point in time you specify.

The VPC ID of the instance.

NOTE: This parameter applies only to ApsaraDB RDS for MySQL instances. For more information about Upgrade the major engine version of an ApsaraDB RDS for MySQL instance, see Upgrade the major engine version of an RDS instance in the ApsaraDB RDS console.

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

• Classic: classic network in enhanced whitelist mode
• VPC: virtual private cloud (VPC) in enhanced whitelist mode
• MIX: standard whitelist mode

NOTE: In standard whitelist mode, IP addresses and CIDR blocks can be added only to the default IP address whitelist. In enhanced whitelist mode, IP addresses and CIDR blocks can be added to both IP address whitelists of the classic network type and those of the VPC network type.

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

NOTE: When the 'engine_version' changes, it can be used as the target database version for the large version upgrade of RDS for MySQL instance.

• MySQL: [ 5.5、5.6、5.7、8.0 ]
• SQLServer: [ 2008r2、08r2_ent_ha、2012、2012_ent_ha、2012_std_ha、2012_web、2014_std_ha、2016_ent_ha、2016_std_ha、2016_web、2017_std_ha、2017_ent、2019_std_ha、2019_ent ]
• PostgreSQL: [ 10.0、11.0、12.0、13.0、14.0、15.0 ]
• MariaDB: [ 10.3 ]
• Serverless

• MySQL: [ 5.7、8.0 ]
• SQLServer: [ 2016_std_sl、2017_std_sl、2019_std_sl ]
• PostgreSQL: [ 14.0 ]
• MariaDB does not support creating serverless instances.

• [5, 2000] for MySQL/PostgreSQL HA dual node edition;
• [20,1000] for MySQL 5.7 basic single node edition;
• [10, 2000] for SQL Server 2008R2;
• [20,2000] for SQL Server 2012 basic single node edition Increase progressively at a rate of 5 GB. For details, see Instance type table. Note: There is extra 5 GB storage for SQL Server Instance, and it is not in specified instance_storage.

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

• To create a serverless instance, please pass the following values:
• MySQL basic: mysql.n2.serverless.1c
• MySQL high availability: mysql.n2.serverless.2c
• SQLServer high availability: mssql.mem2.serverless.s2
• PostgreSQL basic: pg.n2.serverless.1c

NOTE: When storage_auto_scale="Enable", do not perform instance_storage check. when storage_auto_scale="Disable", if the instance itself instance_storagehas changed. You need to manually revise the instance_storage in the template value. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

• cert
• perfer
• verify-ca
• verify-full (supported only when the instance runs PostgreSQL 12 or later)

The upgrade method to use. Valid values:

• Auto: Instances are automatically upgraded to a higher minor version.
• Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.

See more details and limitation.

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

NOTE: This parameter takes effect only when you create an ApsaraDB RDS for PostgreSQL instance. For more information, see Introduction to Babelfish.

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

NOTE: This parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see Introduction to Babelfish.

• aliyun: a cloud certificate
• custom: a custom certificate

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

• Basic: Basic Edition.
• HighAvailability: High-availability Edition.
• AlwaysOn: Cluster Edition.
• Finance: Enterprise Edition.
• cluster: MySQL Cluster Edition. (Available since 1.202.0)
• serverless_basic: RDS Serverless Basic Edition. This edition is available only for instances that run MySQL and PostgreSQL. (Available since 1.200.0)
• serverless_standard: RDS Serverless Basic Edition. This edition is available only for instances that run MySQL and PostgreSQL. (Available since 1.204.0)
• serverless_ha: RDS Serverless High-availability Edition for SQL Server. (Available since 1.204.0)

NOTE: zone_id_slave_a and zone_id_slave_b can specify slave zone ids when creating the high-availability or enterprise edition instances. Meanwhile, vswitch_id needs to pass in the corresponding vswitch id to the slave zone by order (If the vswitch_id is not specified, the classic network version will be created). For example, zone_id = "zone-a" and zone_id_slave_a = "zone-c", zone_id_slave_b = "zone-b", then the vswitch_id must be "vsw-zone-a,vsw-zone-c,vsw-zone-b". Of course, you can also choose automatic allocation , for example, zone_id = "zone-a" and zone_id_slave_a = "Auto",zone_id_slave_b = "Auto", then the vswitch_id must be "vsw-zone-a,Auto,Auto". The list contains up to 2 slave zone ids , separated by commas.

• 1: enables the public key
• 0: disables the public key

• 1: enables the CRL
• 0: disables the CRL

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

NOTE: The prefix must be 8 to 64 characters in length and can contain letters, digits, and hyphens (-). It cannot contain Chinese characters and special characters ~!#%^&*=+|{};:'",<>/?

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

NOTE: The IP address whitelists that have the hidden attribute are not displayed in the ApsaraDB RDS console. These IP address whitelists are used to access Alibaba Cloud services, such as Data Transmission Service (DTS).

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

NOTE: A maximum of 200 IP address whitelists can be configured for each instance.

• local_ssd: specifies to use local SSDs. This value is recommended.
• cloud_ssd: specifies to use standard SSDs.
• cloud_essd: specifies to use enhanced SSDs (ESSDs).
• cloud_essd2: specifies to use enhanced SSDs (ESSDs).
• cloud_essd3: specifies to use enhanced SSDs (ESSDs).
• general_essd: general essd.

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

• If you set the Engine parameter to MySQL.
• This time zone of the instance is in UTC. Valid values: -12:59 to +13:00.
• You can specify this parameter when the instance is equipped with local SSDs. For example, you can specify the time zone to Asia/Hong_Kong. For more information about time zones, see Time zones.
• If you set the Engine parameter to PostgreSQL.
• This time zone of the instance is not in UTC. For more information about time zones, see Time zones.
• You can specify this parameter only when the instance is equipped with standard SSDs or ESSDs.

NOTE: You can specify the time zone when you create a primary instance. You cannot specify the time zone when you create a read-only instance. Read-only instances inherit the time zone of their primary instance. If you do not specify this parameter, the system assigns the default time zone of the region where the instance resides.

The switch of delete protection. Valid values:

• true: delete protect.
• false: no delete protect.

NOTE: deletion_protection is valid only when attribute instance_charge_type is set to Postpaid or Serverless, supported engine type: MySQL, PostgreSQL, MariaDB, MSSQL.

• Immediate: The change immediately takes effect.
• MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.

• Yes
• No

• If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
• If the instance is not attached with a read-only instance, this parameter is empty.

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

• Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
• Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.

NOTE: If you set this parameter to Manual, you must specify the ManualHATime parameter.

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.

NOTE: This parameter only takes effect when the HAConfig parameter is set to Manual.

• Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
• Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
• Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.

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.

NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

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

• None: No archived backup files are retained.
• Lastest: Only the last archived backup file is retained.
• All: All the archived backup files are retained.

NOTE: This parameter is supported only when the instance runs the MySQL database engine.

• cert
• perfer
• verify-ca
• verify-full (supported only when the instance runs PostgreSQL 12 or later)

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

NOTE: This parameter is not required when you create an instance that runs MySQL, PostgreSQL, or SQL Server. You need to only specify the RoleARN parameter to create an instance that has cloud disk encryption enabled by using the obtained key ID. You can configure RAM authorization to require a RAM user to enable cloud disk encryption when the RAM user is used to create an instance. If cloud disk encryption is disabled during the instance creation, the creation operation fails. To complete the configuration, you can attach the following policy to the RAM user: {"Version":"1","Statement":[{"Effect":"Deny","Action":"rds:CreateDBInstance","Resource":"*","Condition":{"StringEquals":{"rds:DiskEncryptionRequired":"false"}}}]}

Deprecated: Attribute security_group_id has been deprecated from 1.69.0 and use security_group_ids instead.

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.

NOTE: The attribute ssl_action will be ignored when setting instance_charge_type = "Serverless" for SQLServer, PostgreSQL or MariaDB.

Automatic storage space expansion switch. Valid values:

• Enable
• Disable

NOTE: This parameter only takes effect when the StorageAutoScale parameter is set to Enable.

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

NOTE: This parameter only takes effect when the StorageAutoScale parameter is set to Enable. The value must be greater than or equal to the total size of the current storage space of the instance.

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.

NOTE: Because of data backup and migration, change DB instance type and storage would cost 15~20 minutes. Please make full preparation before changing them.

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.

NOTE: This parameter takes effect only when you set the UpgradeTime parameter to SpecifyTime.

A mapping of tags to assign to the resource.

• Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
• Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

Note: From 1.63.0, the tag key and value are case sensitive. Before that, they are not case sensitive.

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:

• PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
• MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
• rds: The instance runs RDS Basic or High-availability Edition.
• xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
• xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
• SQLServer: . Example: 15.0.4073.23.

NOTE: For more information about minor engine versions, see Release notes of minor AliPG versions, Release notes of minor AliSQL versions, and Release notes of minor engine versions of ApsaraDB RDS for SQL Server.

• SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
• LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.

• true: upgrade
• false: not to upgrade

Deprecated: Attribute upgrade_db_instance_kernel_version has been deprecated from 1.198.0 and use target_minor_version instead.

• Immediate: The minor engine version is immediately updated.
• MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
• SpecifyTime: The minor engine version is updated at the point in time you specify.

The VPC ID of the instance.

NOTE: This parameter applies only to ApsaraDB RDS for MySQL instances. For more information about Upgrade the major engine version of an ApsaraDB RDS for MySQL instance, see Upgrade the major engine version of an RDS instance in the ApsaraDB RDS console.

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

• Classic: classic network in enhanced whitelist mode
• VPC: virtual private cloud (VPC) in enhanced whitelist mode
• MIX: standard whitelist mode

NOTE: In standard whitelist mode, IP addresses and CIDR blocks can be added only to the default IP address whitelist. In enhanced whitelist mode, IP addresses and CIDR blocks can be added to both IP address whitelists of the classic network type and those of the VPC network type.

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

NOTE: When the 'engine_version' changes, it can be used as the target database version for the large version upgrade of RDS for MySQL instance.

• MySQL: [ 5.5、5.6、5.7、8.0 ]
• SQLServer: [ 2008r2、08r2_ent_ha、2012、2012_ent_ha、2012_std_ha、2012_web、2014_std_ha、2016_ent_ha、2016_std_ha、2016_web、2017_std_ha、2017_ent、2019_std_ha、2019_ent ]
• PostgreSQL: [ 10.0、11.0、12.0、13.0、14.0、15.0 ]
• MariaDB: [ 10.3 ]
• Serverless

• MySQL: [ 5.7、8.0 ]
• SQLServer: [ 2016_std_sl、2017_std_sl、2019_std_sl ]
• PostgreSQL: [ 14.0 ]
• MariaDB does not support creating serverless instances.

• [5, 2000] for MySQL/PostgreSQL HA dual node edition;
• [20,1000] for MySQL 5.7 basic single node edition;
• [10, 2000] for SQL Server 2008R2;
• [20,2000] for SQL Server 2012 basic single node edition Increase progressively at a rate of 5 GB. For details, see Instance type table. Note: There is extra 5 GB storage for SQL Server Instance, and it is not in specified instance_storage.

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

• To create a serverless instance, please pass the following values:
• MySQL basic: mysql.n2.serverless.1c
• MySQL high availability: mysql.n2.serverless.2c
• SQLServer high availability: mssql.mem2.serverless.s2
• PostgreSQL basic: pg.n2.serverless.1c

NOTE: When storage_auto_scale="Enable", do not perform instance_storage check. when storage_auto_scale="Disable", if the instance itself instance_storagehas changed. You need to manually revise the instance_storage in the template value. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

• cert
• perfer
• verify-ca
• verify-full (supported only when the instance runs PostgreSQL 12 or later)

The upgrade method to use. Valid values:

• Auto: Instances are automatically upgraded to a higher minor version.
• Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.

See more details and limitation.

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

NOTE: This parameter takes effect only when you create an ApsaraDB RDS for PostgreSQL instance. For more information, see Introduction to Babelfish.

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

NOTE: This parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see Introduction to Babelfish.

• aliyun: a cloud certificate
• custom: a custom certificate

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

• Basic: Basic Edition.
• HighAvailability: High-availability Edition.
• AlwaysOn: Cluster Edition.
• Finance: Enterprise Edition.
• cluster: MySQL Cluster Edition. (Available since 1.202.0)
• serverless_basic: RDS Serverless Basic Edition. This edition is available only for instances that run MySQL and PostgreSQL. (Available since 1.200.0)
• serverless_standard: RDS Serverless Basic Edition. This edition is available only for instances that run MySQL and PostgreSQL. (Available since 1.204.0)
• serverless_ha: RDS Serverless High-availability Edition for SQL Server. (Available since 1.204.0)

NOTE: zone_id_slave_a and zone_id_slave_b can specify slave zone ids when creating the high-availability or enterprise edition instances. Meanwhile, vswitch_id needs to pass in the corresponding vswitch id to the slave zone by order (If the vswitch_id is not specified, the classic network version will be created). For example, zone_id = "zone-a" and zone_id_slave_a = "zone-c", zone_id_slave_b = "zone-b", then the vswitch_id must be "vsw-zone-a,vsw-zone-c,vsw-zone-b". Of course, you can also choose automatic allocation , for example, zone_id = "zone-a" and zone_id_slave_a = "Auto",zone_id_slave_b = "Auto", then the vswitch_id must be "vsw-zone-a,Auto,Auto". The list contains up to 2 slave zone ids , separated by commas.

• 1: enables the public key
• 0: disables the public key

• 1: enables the CRL
• 0: disables the CRL

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

NOTE: The prefix must be 8 to 64 characters in length and can contain letters, digits, and hyphens (-). It cannot contain Chinese characters and special characters ~!#%^&*=+|{};:'",<>/?

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

NOTE: The IP address whitelists that have the hidden attribute are not displayed in the ApsaraDB RDS console. These IP address whitelists are used to access Alibaba Cloud services, such as Data Transmission Service (DTS).

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

NOTE: A maximum of 200 IP address whitelists can be configured for each instance.

• local_ssd: specifies to use local SSDs. This value is recommended.
• cloud_ssd: specifies to use standard SSDs.
• cloud_essd: specifies to use enhanced SSDs (ESSDs).
• cloud_essd2: specifies to use enhanced SSDs (ESSDs).
• cloud_essd3: specifies to use enhanced SSDs (ESSDs).
• general_essd: general essd.