pulumi-alicloud-kotlin/com.pulumi.alicloud.rds.kotlin/RdsUpgradeDbInstanceArgs

RdsUpgradeDbInstanceArgs

data class RdsUpgradeDbInstanceArgs(val acl: Output<String>? = null, val autoUpgradeMinorVersion: Output<String>? = null, val caType: Output<String>? = null, val certificate: Output<String>? = null, val clientCaCert: Output<String>? = null, val clientCaEnabled: Output<Int>? = null, val clientCertRevocationList: Output<String>? = null, val clientCrlEnabled: Output<Int>? = null, val collectStatMode: Output<String>? = null, val connectionStringPrefix: Output<String>? = null, val dbInstanceClass: Output<String>? = null, val dbInstanceDescription: Output<String>? = null, val dbInstanceStorage: Output<Int>? = null, val dbInstanceStorageType: Output<String>? = null, val dbName: Output<String>? = null, val dedicatedHostGroupId: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val direction: Output<String>? = null, val effectiveTime: Output<String>? = null, val encryptionKey: Output<String>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val forceRestart: Output<Boolean>? = null, val haMode: Output<String>? = null, val instanceNetworkType: Output<String>? = null, val maintainTime: Output<String>? = null, val parameters: Output<List<RdsUpgradeDbInstanceParameterArgs>>? = null, val password: Output<String>? = null, val paymentType: Output<String>? = null, val pgHbaConfs: Output<List<RdsUpgradeDbInstancePgHbaConfArgs>>? = null, val port: Output<String>? = null, val privateIpAddress: Output<String>? = null, val privateKey: Output<String>? = null, val releasedKeepPolicy: Output<String>? = null, val replicationAcl: Output<String>? = null, val resourceGroupId: Output<String>? = null, val roleArn: Output<String>? = null, val securityIps: Output<List<String>>? = null, val serverCert: Output<String>? = null, val serverKey: Output<String>? = null, val sourceBiz: Output<String>? = null, val sourceDbInstanceId: Output<String>? = null, val sslEnabled: Output<Int>? = null, val switchOver: Output<String>? = null, val switchTime: Output<String>? = null, val switchTimeMode: Output<String>? = null, val syncMode: Output<String>? = null, val targetMajorVersion: Output<String>? = null, val tcpConnectionType: Output<String>? = null, val tdeStatus: Output<String>? = null, val vpcId: Output<String>? = null, val vswitchId: Output<String>? = null, val zoneId: Output<String>? = null, val zoneIdSlave1: Output<String>? = null) : ConvertibleToJava<RdsUpgradeDbInstanceArgs>

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 MySQL upgrade instance

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.rds.RdsFunctions;
import com.pulumi.alicloud.rds.inputs.GetZonesArgs;
import com.pulumi.alicloud.rds.inputs.GetInstanceClassesArgs;
import com.pulumi.alicloud.rds.inputs.GetCrossRegionsArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.rds.Instance;
import com.pulumi.alicloud.rds.InstanceArgs;
import com.pulumi.alicloud.rds.RdsUpgradeDbInstance;
import com.pulumi.alicloud.rds.RdsUpgradeDbInstanceArgs;
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 exampleZones = RdsFunctions.getZones(GetZonesArgs.builder()
            .engine("PostgreSQL")
            .engineVersion("13.0")
            .instanceChargeType("PostPaid")
            .category("HighAvailability")
            .dbInstanceStorageType("cloud_essd")
            .build());
        final var exampleInstanceClasses = RdsFunctions.getInstanceClasses(GetInstanceClassesArgs.builder()
            .zoneId(exampleZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .engine("PostgreSQL")
            .engineVersion("13.0")
            .category("HighAvailability")
            .dbInstanceStorageType("cloud_essd")
            .instanceChargeType("PostPaid")
            .build());
        final var exampleCrossRegions = RdsFunctions.getCrossRegions();
        var exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()
            .vpcName("terraform-example")
            .cidrBlock("172.16.0.0/16")
            .build());
        var exampleSwitch = new Switch("exampleSwitch", SwitchArgs.builder()
            .vpcId(exampleNetwork.id())
            .cidrBlock("172.16.0.0/24")
            .zoneId(exampleZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .vswitchName("terraform-example")
            .build());
        var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()
            .engine("PostgreSQL")
            .engineVersion("13.0")
            .dbInstanceStorageType("cloud_essd")
            .instanceType(exampleInstanceClasses.applyValue(getInstanceClassesResult -> getInstanceClassesResult.instanceClasses()[0].instanceClass()))
            .instanceStorage(exampleInstanceClasses.applyValue(getInstanceClassesResult -> getInstanceClassesResult.instanceClasses()[0].storageRange().min()))
            .instanceChargeType("Postpaid")
            .instanceName("terraform-example")
            .vswitchId(exampleSwitch.id())
            .monitoringPeriod("60")
            .build());
        var exampleRdsUpgradeDbInstance = new RdsUpgradeDbInstance("exampleRdsUpgradeDbInstance", RdsUpgradeDbInstanceArgs.builder()
            .sourceDbInstanceId(exampleInstance.id())
            .targetMajorVersion("14.0")
            .dbInstanceClass(exampleInstance.instanceType())
            .dbInstanceStorage(exampleInstance.instanceStorage())
            .dbInstanceStorageType(exampleInstance.dbInstanceStorageType())
            .instanceNetworkType("VPC")
            .collectStatMode("After")
            .switchOver("false")
            .paymentType("PayAsYouGo")
            .dbInstanceDescription("terraform-example")
            .vswitchId(exampleSwitch.id())
            .build());
    }
}

Import

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

$ pulumi import alicloud:rds/rdsUpgradeDbInstance:RdsUpgradeDbInstance example <id>

Constructors

RdsUpgradeDbInstanceArgs

fun RdsUpgradeDbInstanceArgs(acl: Output<String>? = null, autoUpgradeMinorVersion: Output<String>? = null, caType: Output<String>? = null, certificate: Output<String>? = null, clientCaCert: Output<String>? = null, clientCaEnabled: Output<Int>? = null, clientCertRevocationList: Output<String>? = null, clientCrlEnabled: Output<Int>? = null, collectStatMode: Output<String>? = null, connectionStringPrefix: Output<String>? = null, dbInstanceClass: Output<String>? = null, dbInstanceDescription: Output<String>? = null, dbInstanceStorage: Output<Int>? = null, dbInstanceStorageType: Output<String>? = null, dbName: Output<String>? = null, dedicatedHostGroupId: Output<String>? = null, deletionProtection: Output<Boolean>? = null, direction: Output<String>? = null, effectiveTime: Output<String>? = null, encryptionKey: Output<String>? = null, engine: Output<String>? = null, engineVersion: Output<String>? = null, forceRestart: Output<Boolean>? = null, haMode: Output<String>? = null, instanceNetworkType: Output<String>? = null, maintainTime: Output<String>? = null, parameters: Output<List<RdsUpgradeDbInstanceParameterArgs>>? = null, password: Output<String>? = null, paymentType: Output<String>? = null, pgHbaConfs: Output<List<RdsUpgradeDbInstancePgHbaConfArgs>>? = null, port: Output<String>? = null, privateIpAddress: Output<String>? = null, privateKey: Output<String>? = null, releasedKeepPolicy: Output<String>? = null, replicationAcl: Output<String>? = null, resourceGroupId: Output<String>? = null, roleArn: Output<String>? = null, securityIps: Output<List<String>>? = null, serverCert: Output<String>? = null, serverKey: Output<String>? = null, sourceBiz: Output<String>? = null, sourceDbInstanceId: Output<String>? = null, sslEnabled: Output<Int>? = null, switchOver: Output<String>? = null, switchTime: Output<String>? = null, switchTimeMode: Output<String>? = null, syncMode: Output<String>? = null, targetMajorVersion: Output<String>? = null, tcpConnectionType: Output<String>? = null, tdeStatus: Output<String>? = null, vpcId: Output<String>? = null, vswitchId: Output<String>? = null, zoneId: Output<String>? = null, zoneIdSlave1: Output<String>? = null)

Functions

toJava

open override fun toJava(): RdsUpgradeDbInstanceArgs

Properties

acl

val acl: Output<String>? = null

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

autoUpgradeMinorVersion

val autoUpgradeMinorVersion: Output<String>? = null

How to upgrade the minor version of the instance. Valid values:

caType

val caType: Output<String>? = null

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:

certificate

val certificate: Output<String>? = null

The file that contains the certificate used for TDE.

clientCaCert

val clientCaCert: Output<String>? = null

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.

clientCaEnabled

val clientCaEnabled: Output<Int>? = null

The client ca enabled.

clientCertRevocationList

val clientCertRevocationList: Output<String>? = null

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.

clientCrlEnabled

val clientCrlEnabled: Output<Int>? = null

The client crl enabled.

collectStatMode

val collectStatMode: Output<String>? = null

The time at which ApsaraDB RDS collects the statistics of the new instance.

connectionStringPrefix

val connectionStringPrefix: Output<String>? = null

The connection string prefix.

dbInstanceClass

val dbInstanceClass: Output<String>? = null

The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.

dbInstanceDescription

val dbInstanceDescription: Output<String>? = null

The db instance description.

dbInstanceStorage

val dbInstanceStorage: Output<Int>? = null

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.

dbInstanceStorageType

val dbInstanceStorageType: Output<String>? = null

The type of storage media that is used for the new instance. Valid values:

dbName

val dbName: Output<String>? = null

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

dedicatedHostGroupId

val dedicatedHostGroupId: Output<String>? = null

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.

deletionProtection

val deletionProtection: Output<Boolean>? = null

The switch of delete protection. Valid values:

direction

val direction: Output<String>? = null

The direction. Valid values: Auto, Down, TempUpgrade, Up.

effectiveTime

val effectiveTime: Output<String>? = null

The effective time.

encryptionKey

val encryptionKey: Output<String>? = null

The ID of the private key.

engine

val engine: Output<String>? = null

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

engineVersion

val engineVersion: Output<String>? = null

Database version. Value:

forceRestart

val forceRestart: Output<Boolean>? = null

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

haMode

val haMode: Output<String>? = null

The high availability mode. Valid values:

instanceNetworkType

val instanceNetworkType: Output<String>? = null

The network type of the instance. Valid values:

maintainTime

val maintainTime: Output<String>? = null

The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).

parameters

val parameters: Output<List<RdsUpgradeDbInstanceParameterArgs>>? = null

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.

password

val password: Output<String>? = null

The password of the certificate.

paymentType

val paymentType: Output<String>? = null

The billing method of the new instance. Valid values: PayAsYouGo and Subscription.

pgHbaConfs

val pgHbaConfs: Output<List<RdsUpgradeDbInstancePgHbaConfArgs>>? = null

The configuration of AD domain . See pg_hba_conf below.

port

val port: Output<String>? = null

The port.

privateIpAddress

val privateIpAddress: Output<String>? = null

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.

privateKey

val privateKey: Output<String>? = null

The file that contains the private key used for TDE.

releasedKeepPolicy

val releasedKeepPolicy: Output<String>? = null

The released keep policy.

replicationAcl

val replicationAcl: Output<String>? = null

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

resourceGroupId

val resourceGroupId: Output<String>? = null

The resource group id.

roleArn

val roleArn: Output<String>? = null

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.

securityIps

val securityIps: Output<List<String>>? = null

The IP address whitelist of the instance. Separate multiple IP addresses with commas (,) and cannot be repeated. The following two formats are supported:

serverCert

val serverCert: Output<String>? = null

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.

serverKey

val serverKey: Output<String>? = null

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.

sourceBiz

val sourceBiz: Output<String>? = null

The source biz.

sourceDbInstanceId

val sourceDbInstanceId: Output<String>? = null

The source db instance id.

sslEnabled

val sslEnabled: Output<Int>? = null

Enable or disable SSL. Valid values: 0 and 1.

switchOver

val switchOver: Output<String>? = null

Specifies whether ApsaraDB RDS automatically switches your workloads over to the new instance after data is migrated to the new instance. Valid values:

switchTime

val switchTime: Output<String>? = null

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.

switchTimeMode

val switchTimeMode: Output<String>? = null

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:

syncMode

val syncMode: Output<String>? = null

The data replication mode. Valid values:

targetMajorVersion

val targetMajorVersion: Output<String>? = null

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.

tcpConnectionType

val tcpConnectionType: Output<String>? = null

The availability check method of the instance. Valid values:

tdeStatus

val tdeStatus: Output<String>? = null

Specifies whether to enable TDE. Valid values: Enabled and Disabled.

vpcId

val vpcId: Output<String>? = null

The ID of the VPC to which the new instance belongs.

vswitchId

val vswitchId: Output<String>? = null

The ID of the vSwitch associated with the specified VPC.

zoneId

val zoneId: Output<String>? = null

The ID of the zone to which the new instance belongs. You can call the DescribeRegions operation to query the most recent region list.

zoneIdSlave1

val zoneIdSlave1: Output<String>? = null

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.