alicloud_rds_upgrade_db_instance_Terraform(Terraform)-阿里云帮助中心

Provides a RDS Upgrade DB Instance resource.

For information about RDS Upgrade DB Instance and how to use it, see What is ApsaraDB for RDS.

-> NOTE: Available since v1.153.0+.

Example Usage

Create a RDS PostgreSQL upgrade instance

provider "alicloud" {
  region = "cn-hangzhou"
}

data "alicloud_db_zones" "example" {
  engine                   = "PostgreSQL"
  engine_version           = "13.0"
  instance_charge_type     = "PostPaid"
  category                 = "HighAvailability"
  db_instance_storage_type = "cloud_essd"
}

data "alicloud_db_instance_classes" "example" {
  zone_id                  = data.alicloud_db_zones.example.zones.0.id
  engine                   = "PostgreSQL"
  engine_version           = "13.0"
  category                 = "HighAvailability"
  db_instance_storage_type = "cloud_essd"
  instance_charge_type     = "PostPaid"
}

data "alicloud_rds_cross_regions" "example" {
}

resource "alicloud_vpc" "example" {
  vpc_name   = "terraform-example"
  cidr_block = "172.16.0.0/16"
}

resource "alicloud_vswitch" "example" {
  vpc_id       = alicloud_vpc.example.id
  cidr_block   = "172.16.0.0/24"
  zone_id      = data.alicloud_db_zones.example.zones.0.id
  vswitch_name = "terraform-example"
}

resource "alicloud_db_instance" "example" {
  engine                   = "PostgreSQL"
  engine_version           = "13.0"
  db_instance_storage_type = "cloud_essd"
  instance_type            = data.alicloud_db_instance_classes.example.instance_classes.0.instance_class
  instance_storage         = data.alicloud_db_instance_classes.example.instance_classes.0.storage_range.min
  instance_charge_type     = "Postpaid"
  instance_name            = "terraform-example"
  vswitch_id               = alicloud_vswitch.example.id
  monitoring_period        = "60"
}

resource "alicloud_rds_upgrade_db_instance" "example" {
  source_db_instance_id    = alicloud_db_instance.example.id
  target_major_version     = "14.0"
  db_instance_class        = alicloud_db_instance.example.instance_type
  db_instance_storage      = alicloud_db_instance.example.instance_storage
  db_instance_storage_type = alicloud_db_instance.example.db_instance_storage_type
  instance_network_type    = "VPC"
  collect_stat_mode        = "After"
  switch_over              = "false"
  payment_type             = "PayAsYouGo"
  db_instance_description  = "terraform-example"
  vswitch_id               = alicloud_vswitch.example.id
}

Argument Reference

The following arguments are supported:

source_db_instance_id - (Required, ForceNew) The source db instance id.
db_instance_storage_type - (Required) The type of storage media that is used for the new instance. Valid values:
- local_ssd: local SSDs.
- cloud_ssd: standard SSDs.
- cloud_essd: enhanced SSDs (ESSDs) of performance level 1 (PL1).
- cloud_essd2: ESSDs of PL2.
- cloud_essd3: ESSDs of PL3.
payment_type - (Required) The billing method of the new instance. Valid values: PayAsYouGo and Subscription.
db_instance_class - (Required) The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.
db_instance_storage - (Required) The storage capacity of the new instance. Unit: GB. The storage capacity increases in increments of 5 GB. For more information, see Primary ApsaraDB RDS instance types.

-> NOTE: The default value of this parameter is the storage capacity of the original instance.

vpc_id - (Optional, Computed) The ID of the VPC to which the new instance belongs.

-> NOTE: Make sure that the VPC resides in the specified region.

vswitch_id - (Optional, Computed) The ID of the vSwitch associated with the specified VPC.

-> NOTE: Make sure that the vSwitch belongs to the specified VPC and region.

private_ip_address - (Optional, Computed) The intranet IP address of the new instance must be within the specified vSwitch IP address range. By default, the system automatically allocates by using VPCId and VSwitchId.
deletion_protection - (Optional, Available in 1.167.0+) The switch of delete protection. Valid values:
- true: delete protect.
- false: no delete protect.

-> NOTE: deletion_protection is valid only when attribute payment_type is set to PayAsYouGo, supported engine type: MySQL, PostgreSQL, MariaDB, MSSQL.

acl - (Optional, Computed) This parameter is only supported by the RDS PostgreSQL cloud disk version. This parameter indicates the authentication method. It is allowed only when the public key of the client certificate authority is enabled. Valid values: cert and perfer and verify-ca and verify-full (supported by RDS PostgreSQL above 12).
auto_upgrade_minor_version - (Optional, Computed) How to upgrade the minor version of the instance. Valid values:
- Auto: automatically upgrade the minor version.
- Manual: It is not automatically upgraded. It is only mandatory when the current version is offline.
ca_type - (Optional, Computed) This parameter is only supported by the RDS PostgreSQL cloud disk version. It indicates the certificate type. When the value of ssl_action is Open, the default value of this parameter is aliyun. Value range:
- aliyun: using cloud certificates.
- custom: use a custom certificate. Valid values: aliyun, custom.
certificate - (Optional) The file that contains the certificate used for TDE.
client_ca_cert - (Optional) This parameter is only supported by the RDS PostgreSQL cloud disk version. It indicates the public key of the client certification authority. If the value of client_ca_enabled is 1, this parameter must be configured.
client_ca_enabled - (Optional) The client ca enabled.
client_cert_revocation_list - (Optional) This parameter is only supported by the RDS PostgreSQL cloud disk version, which indicates that the client revokes the certificate file. If the value of client_crl_enabled is 1, this parameter must be configured.
client_crl_enabled - (Optional) The client crl enabled.
connection_string_prefix - (Optional) The connection string prefix.
db_instance_description - (Optional, Computed) The db instance description.
db_name - (Optional) The name of the database for which you want to enable TDE. Up to 50 names can be entered in a single request. If you specify multiple names, separate these names with commas (,).

-> NOTE: This parameter is available and must be specified only when the instance runs SQL Server 2019 SE or an Enterprise Edition of SQL Server.

dedicated_host_group_id - (Optional) The ID of the dedicated cluster to which the new instance belongs. This parameter takes effect only when you create the new instance in a dedicated cluster.
direction - (Optional) The direction. Valid values: Auto, Down, TempUpgrade, Up.
effective_time - (Optional) The effective time.
encryption_key - (Optional) The ID of the private key.

-> NOTE: This parameter is available only when the instance runs MySQL.

engine_version - (Optional, Computed, ForceNew) Database version. Value:
- MySQL: 5.5/5.6/5.7/8.0.
- SQL Server: 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: 9.4/10.0/11.0/12.0/13.0.
- MariaDB: 10.3.
instance_network_type - (Required, ForceNew) The network type of the instance. Valid values:
- Classic: Classic Network.
- VPC: VPC.
maintain_time - (Optional, Computed) The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).
password - (Optional) The password of the certificate.

-> NOTE: This parameter is available only when the instance runs SQL Server 2019 SE or an Enterprise Edition of SQL Server.

port - (Optional, Computed) The port.
private_key - (Optional) The file that contains the private key used for TDE.
released_keep_policy - (Optional) The released keep policy.
replication_acl - (Optional, Computed) This parameter is only supported by the RDS PostgreSQL cloud disk version, indicating the authentication method of the replication permission. It is only allowed when the public key of the client certificate authority is enabled. Valid values: cert and perfer and verify-ca and verify-full (supported by RDS PostgreSQL above 12).
resource_group_id - (Optional) The resource group id.
role_arn - (Optional) The Alibaba Cloud Resource Name (ARN) of a RAM role. A RAM role is a virtual RAM identity that you can create within your Alibaba Cloud account. For more information, see RAM role overview.

-> NOTE: This parameter is available only when the instance runs MySQL.

security_ips - (Optional, Computed) The IP address whitelist of the instance. Separate multiple IP addresses with commas (,) and cannot be repeated. The following two formats are supported:
- IP address form, for example: 10.23.12.24.
- CIDR format, for example, 10.23.12.0/24 (no Inter-Domain Routing, 24 indicates the length of the prefix in the address, ranging from 1 to 32).

-> NOTE: each instance can add up to 1000 IP addresses or IP segments, that is, the total number of IP addresses or IP segments in all IP whitelist groups cannot exceed 1000. When there are more IP addresses, it is recommended to merge them into IP segments, for example, 10.23.12.0/24.

server_cert - (Optional, Computed) This parameter is only supported by the RDS PostgreSQL cloud disk version. It indicates the content of the server certificate. If the CAType value is custom, this parameter must be configured.
server_key - (Optional, Computed) This parameter is only supported by the RDS PostgreSQL cloud disk version. It indicates the private key of the server certificate. If the value of CAType is custom, this parameter must be configured.
source_biz - (Optional) The source biz.
ssl_enabled - (Optional, Computed) Enable or disable SSL. Valid values: 0 and 1.
switch_time - (Optional) The time at which you want to apply the specification changes. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
ha_mode - (Optional, Computed) The high availability mode. Valid values:
- RPO: Data persistence is preferred. The instance preferentially ensures data reliability to minimize data loss. Use this mode if you have higher requirements on data consistency.
- RTO: Instance availability is preferred. The instance restores services as soon as possible to ensure availability. Use this mode if you have higher requirements on service availability.
sync_mode - (Optional, Computed) The data replication mode. Valid values:
- Sync: strong synchronization.
- Semi-sync: Semi-synchronous.
- Async: asynchronous.

-> NOTE: SQL Server 2017 cluster version is currently not supported.

tde_status - (Optional) Specifies whether to enable TDE. Valid values: Enabled and Disabled.
zone_id - (Optional, Computed, ForceNew) The ID of the zone to which the new instance belongs. You can call the DescribeRegions operation to query the most recent region list.

-> NOTE: The default value of this parameter is the ID of the zone to which the original instance belongs.

zone_id_slave_1 - (Optional, Computed, ForceNew) The ID of the zone to which the secondary instance of the new instance belongs. You can specify this parameter only when the original instance runs RDS High-availability Edition. You can select a zone that belongs to the region where the original instance resides. You can call the DescribeRegions operation to query zone IDs.
engine - (Optional, Computed, ForceNew) Database type. Value options: MySQL, SQLServer, PostgreSQL.
parameters - (Optional, Computed) 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.
force_restart - (Optional) Set it to true to make some parameter efficient when modifying them. Default to false.
switch_time_mode - (Optional) The time at which ApsaraDB RDS switches your workloads over to the new instance. This parameter is used together with the SwitchOver parameter and takes effect only when you set the SwitchOver parameter to true. Valid values:
- Immediate: After data is migrated to the new instance, ApsaraDB RDS immediately switches your workloads over to the new instance.
- MaintainTime: After data is migrated to the new instance, ApsaraDB RDS switches your workloads over to the new instance during the maintenance window that you specify. You can call the ModifyDBInstanceMaintainTime operation to change the maintenance window of an instance.
switch_over - (Required) Specifies whether ApsaraDB RDS automatically switches your workloads over to the new instance after data is migrated to the new instance. Valid values:
- true: ApsaraDB RDS automatically switches workloads over to the new instance. If you set this parameter to true, you must take note of the following information:
  - After the switchover is complete, you cannot roll your workloads back to the original instance. Proceed with caution.
  - During the switchover, the original instance processes only read requests. You must perform the switchover during off-peak hours.
  - If read-only instances are attached to the original instance, you can set this parameter only to false. In this case, the read-only instances that are attached to the original instance cannot be cloned. After the upgrade is complete, you must create read-only instances for the new instance.
- false: ApsaraDB RDS does not automatically switch your workloads over to the new instance. Before you perform an upgrade, we recommend that you set this parameter to false to test whether the new major engine version is compatible with your workloads. If you set this parameter to false, you must take note of the following information:
  - The data migration does not interrupt your workloads on the original instance.
  - After data is migrated to the new instance, you must update the endpoint configuration on your application. This update requires you to replace the endpoint of the original instance with the endpoint of the new instance. For more information about how to view the endpoint of an instance, see View and change the internal and public endpoints and port numbers of an ApsaraDB RDS for PostgreSQL instance.
collect_stat_mode - (Required) The time at which ApsaraDB RDS collects the statistics of the new instance.
- Before: ApsaraDB RDS collects the statistics of the new instance before the switchover to ensure service stability. If the original instance contains a large amount of data, the upgrade may require a long period of time.
- After: ApsaraDB RDS collects the statistics of the new instance after the switchover to accelerate the upgrade. If you access tables for which no statistics are generated, the query plans that you specify may be inaccurately executed. In addition, your database service may be unavailable during peak hours.

-> NOTE If you set the SwitchOver parameter to false, the value Before specifies that ApsaraDB RDS collects the statistics of the new instance before the new instance starts to process read and write requests, and the value After specifies that ApsaraDB RDS collects the statistics of the new instance after the new instance starts to process read and write requests.

target_major_version - (Required, ForceNew) The major engine version of the new instance. The value of this parameter must be the major engine version on which an upgrade check is performed.

-> NOTE You can call the UpgradeDBInstanceMajorVersionPrecheck operation to perform an upgrade check on a major engine version.

tcp_connection_type - (Optional, Available in 1.171.0+) The availability check method of the instance. Valid values:
- 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.
pg_hba_conf - (Optional, Available in 1.155.0+) The configuration of AD domain . See pg_hba_conf below.

`parameters`

The parameters mapping supports the following:

name - (Required) The parameter name.
value - (Required) The parameter value.

`pg_hba_conf`

The pg_hba_conf mapping supports the following:

type - (Required) The type of connection to the instance. Valid values:
- host: specifies to verify TCP/IP connections, including SSL connections and non-SSL connections.
- hostssl: specifies to verify only TCP/IP connections that are established over SSL connections.
- hostnossl: specifies to verify only TCP/IP connections that are established over non-SSL connections.

-> NOTE: You can set this parameter to hostssl only when SSL encryption is enabled for the instance. For more information, see Configure SSL encryption for an ApsaraDB RDS for PostgreSQL instance.

mask - (Optional) The mask of the instance. If the value of the Address parameter is an IP address, you can use this parameter to specify the mask of the IP address.
database - (Required) The name of the database that the specified users are allowed to access. If you set this parameter to all, the specified users are allowed to access all databases in the instance. If you specify multiple databases, separate the database names with commas (,).
priority_id - (Required) The priority of an AD domain. If you set this parameter to 0, the AD domain has the highest priority. Valid values: 0 to 10000. This parameter is used to identify each AD domain. When you add an AD domain, the value of the PriorityId parameter of the new AD domain cannot be the same as the value of the PriorityId parameter for any existing AD domain. When you modify or delete an AD domain, you must also modify or delete the value of the PriorityId parameter for this AD domain.
address - (Required) The IP addresses from which the specified users can access the specified databases. If you set this parameter to 0.0.0.0/0, the specified users are allowed to access the specified databases from all IP addresses.
user - (Required) The user that is allowed to access the instance. If you specify multiple users, separate the usernames with commas (,).
method - (Required) The authentication method of Lightweight Directory Access Protocol (LDAP). Valid values: trust, reject, scram-sha-256, md5, password, gss, sspi, ldap, radius, cert, pam.
option - (Optional) Optional. The value of this parameter is based on the value of the HbaItem.N.Method parameter. In this topic, LDAP is used as an example. You must configure this parameter. For more information, see Authentication Methods.

Attributes Reference

The following attributes are exported:

id - The resource ID in terraform of Upgrade DB Instance.
connection_string - The database connection address.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

create - (Defaults to 300 mins) Used when create the Upgrade DB Instance.
update - (Defaults to 30 mins) Used when update the Upgrade DB Instance.
delete - (Defaults to 20 mins) Used when terminating the Upgrade DB instance.

Import

RDS Upgrade DB Instance can be imported using the id, e.g.

$ terraform import alicloud_rds_upgrade_db_instance.example <id>