Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. rds
  5. RdsUpgradeDbInstance
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.rds.RdsUpgradeDbInstance

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

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

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = alicloud.rds.getZones({
    engine: "PostgreSQL",
    engineVersion: "13.0",
    instanceChargeType: "PostPaid",
    category: "HighAvailability",
    dbInstanceStorageType: "cloud_essd",
});
const exampleGetInstanceClasses = example.then(example => alicloud.rds.getInstanceClasses({
    zoneId: example.zones?.[0]?.id,
    engine: "PostgreSQL",
    engineVersion: "13.0",
    category: "HighAvailability",
    dbInstanceStorageType: "cloud_essd",
    instanceChargeType: "PostPaid",
}));
const exampleGetCrossRegions = alicloud.rds.getCrossRegions({});
const exampleNetwork = new alicloud.vpc.Network("example", {
    vpcName: "terraform-example",
    cidrBlock: "172.16.0.0/16",
});
const exampleSwitch = new alicloud.vpc.Switch("example", {
    vpcId: exampleNetwork.id,
    cidrBlock: "172.16.0.0/24",
    zoneId: example.then(example => example.zones?.[0]?.id),
    vswitchName: "terraform-example",
});
const exampleInstance = new alicloud.rds.Instance("example", {
    engine: "PostgreSQL",
    engineVersion: "13.0",
    dbInstanceStorageType: "cloud_essd",
    instanceType: exampleGetInstanceClasses.then(exampleGetInstanceClasses => exampleGetInstanceClasses.instanceClasses?.[0]?.instanceClass),
    instanceStorage: exampleGetInstanceClasses.then(exampleGetInstanceClasses => exampleGetInstanceClasses.instanceClasses?.[0]?.storageRange?.min),
    instanceChargeType: "Postpaid",
    instanceName: "terraform-example",
    vswitchId: exampleSwitch.id,
    monitoringPeriod: 60,
});
const exampleRdsUpgradeDbInstance = new alicloud.rds.RdsUpgradeDbInstance("example", {
    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,
});
Copy
import pulumi
import pulumi_alicloud as alicloud

example = alicloud.rds.get_zones(engine="PostgreSQL",
    engine_version="13.0",
    instance_charge_type="PostPaid",
    category="HighAvailability",
    db_instance_storage_type="cloud_essd")
example_get_instance_classes = alicloud.rds.get_instance_classes(zone_id=example.zones[0].id,
    engine="PostgreSQL",
    engine_version="13.0",
    category="HighAvailability",
    db_instance_storage_type="cloud_essd",
    instance_charge_type="PostPaid")
example_get_cross_regions = alicloud.rds.get_cross_regions()
example_network = alicloud.vpc.Network("example",
    vpc_name="terraform-example",
    cidr_block="172.16.0.0/16")
example_switch = alicloud.vpc.Switch("example",
    vpc_id=example_network.id,
    cidr_block="172.16.0.0/24",
    zone_id=example.zones[0].id,
    vswitch_name="terraform-example")
example_instance = alicloud.rds.Instance("example",
    engine="PostgreSQL",
    engine_version="13.0",
    db_instance_storage_type="cloud_essd",
    instance_type=example_get_instance_classes.instance_classes[0].instance_class,
    instance_storage=example_get_instance_classes.instance_classes[0].storage_range.min,
    instance_charge_type="Postpaid",
    instance_name="terraform-example",
    vswitch_id=example_switch.id,
    monitoring_period=60)
example_rds_upgrade_db_instance = alicloud.rds.RdsUpgradeDbInstance("example",
    source_db_instance_id=example_instance.id,
    target_major_version="14.0",
    db_instance_class=example_instance.instance_type,
    db_instance_storage=example_instance.instance_storage,
    db_instance_storage_type=example_instance.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=example_switch.id)
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/rds"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := rds.GetZones(ctx, &rds.GetZonesArgs{
			Engine:                pulumi.StringRef("PostgreSQL"),
			EngineVersion:         pulumi.StringRef("13.0"),
			InstanceChargeType:    pulumi.StringRef("PostPaid"),
			Category:              pulumi.StringRef("HighAvailability"),
			DbInstanceStorageType: pulumi.StringRef("cloud_essd"),
		}, nil)
		if err != nil {
			return err
		}
		exampleGetInstanceClasses, err := rds.GetInstanceClasses(ctx, &rds.GetInstanceClassesArgs{
			ZoneId:                pulumi.StringRef(example.Zones[0].Id),
			Engine:                pulumi.StringRef("PostgreSQL"),
			EngineVersion:         pulumi.StringRef("13.0"),
			Category:              pulumi.StringRef("HighAvailability"),
			DbInstanceStorageType: pulumi.StringRef("cloud_essd"),
			InstanceChargeType:    pulumi.StringRef("PostPaid"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = rds.GetCrossRegions(ctx, &rds.GetCrossRegionsArgs{}, nil)
		if err != nil {
			return err
		}
		exampleNetwork, err := vpc.NewNetwork(ctx, "example", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		exampleSwitch, err := vpc.NewSwitch(ctx, "example", &vpc.SwitchArgs{
			VpcId:       exampleNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(example.Zones[0].Id),
			VswitchName: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		exampleInstance, err := rds.NewInstance(ctx, "example", &rds.InstanceArgs{
			Engine:                pulumi.String("PostgreSQL"),
			EngineVersion:         pulumi.String("13.0"),
			DbInstanceStorageType: pulumi.String("cloud_essd"),
			InstanceType:          pulumi.String(exampleGetInstanceClasses.InstanceClasses[0].InstanceClass),
			InstanceStorage:       pulumi.String(exampleGetInstanceClasses.InstanceClasses[0].StorageRange.Min),
			InstanceChargeType:    pulumi.String("Postpaid"),
			InstanceName:          pulumi.String("terraform-example"),
			VswitchId:             exampleSwitch.ID(),
			MonitoringPeriod:      pulumi.Int(60),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewRdsUpgradeDbInstance(ctx, "example", &rds.RdsUpgradeDbInstanceArgs{
			SourceDbInstanceId:    exampleInstance.ID(),
			TargetMajorVersion:    pulumi.String("14.0"),
			DbInstanceClass:       exampleInstance.InstanceType,
			DbInstanceStorage:     exampleInstance.InstanceStorage,
			DbInstanceStorageType: exampleInstance.DbInstanceStorageType,
			InstanceNetworkType:   pulumi.String("VPC"),
			CollectStatMode:       pulumi.String("After"),
			SwitchOver:            pulumi.String("false"),
			PaymentType:           pulumi.String("PayAsYouGo"),
			DbInstanceDescription: pulumi.String("terraform-example"),
			VswitchId:             exampleSwitch.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var example = AliCloud.Rds.GetZones.Invoke(new()
    {
        Engine = "PostgreSQL",
        EngineVersion = "13.0",
        InstanceChargeType = "PostPaid",
        Category = "HighAvailability",
        DbInstanceStorageType = "cloud_essd",
    });

    var exampleGetInstanceClasses = AliCloud.Rds.GetInstanceClasses.Invoke(new()
    {
        ZoneId = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        Engine = "PostgreSQL",
        EngineVersion = "13.0",
        Category = "HighAvailability",
        DbInstanceStorageType = "cloud_essd",
        InstanceChargeType = "PostPaid",
    });

    var exampleGetCrossRegions = AliCloud.Rds.GetCrossRegions.Invoke();

    var exampleNetwork = new AliCloud.Vpc.Network("example", new()
    {
        VpcName = "terraform-example",
        CidrBlock = "172.16.0.0/16",
    });

    var exampleSwitch = new AliCloud.Vpc.Switch("example", new()
    {
        VpcId = exampleNetwork.Id,
        CidrBlock = "172.16.0.0/24",
        ZoneId = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        VswitchName = "terraform-example",
    });

    var exampleInstance = new AliCloud.Rds.Instance("example", new()
    {
        Engine = "PostgreSQL",
        EngineVersion = "13.0",
        DbInstanceStorageType = "cloud_essd",
        InstanceType = exampleGetInstanceClasses.Apply(getInstanceClassesResult => getInstanceClassesResult.InstanceClasses[0]?.InstanceClass),
        InstanceStorage = exampleGetInstanceClasses.Apply(getInstanceClassesResult => getInstanceClassesResult.InstanceClasses[0]?.StorageRange?.Min),
        InstanceChargeType = "Postpaid",
        InstanceName = "terraform-example",
        VswitchId = exampleSwitch.Id,
        MonitoringPeriod = 60,
    });

    var exampleRdsUpgradeDbInstance = new AliCloud.Rds.RdsUpgradeDbInstance("example", new()
    {
        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,
    });

});
Copy
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 example = RdsFunctions.getZones(GetZonesArgs.builder()
            .engine("PostgreSQL")
            .engineVersion("13.0")
            .instanceChargeType("PostPaid")
            .category("HighAvailability")
            .dbInstanceStorageType("cloud_essd")
            .build());

        final var exampleGetInstanceClasses = RdsFunctions.getInstanceClasses(GetInstanceClassesArgs.builder()
            .zoneId(example.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .engine("PostgreSQL")
            .engineVersion("13.0")
            .category("HighAvailability")
            .dbInstanceStorageType("cloud_essd")
            .instanceChargeType("PostPaid")
            .build());

        final var exampleGetCrossRegions = 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(example.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(exampleGetInstanceClasses.applyValue(getInstanceClassesResult -> getInstanceClassesResult.instanceClasses()[0].instanceClass()))
            .instanceStorage(exampleGetInstanceClasses.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());

    }
}
Copy
resources:
  exampleNetwork:
    type: alicloud:vpc:Network
    name: example
    properties:
      vpcName: terraform-example
      cidrBlock: 172.16.0.0/16
  exampleSwitch:
    type: alicloud:vpc:Switch
    name: example
    properties:
      vpcId: ${exampleNetwork.id}
      cidrBlock: 172.16.0.0/24
      zoneId: ${example.zones[0].id}
      vswitchName: terraform-example
  exampleInstance:
    type: alicloud:rds:Instance
    name: example
    properties:
      engine: PostgreSQL
      engineVersion: '13.0'
      dbInstanceStorageType: cloud_essd
      instanceType: ${exampleGetInstanceClasses.instanceClasses[0].instanceClass}
      instanceStorage: ${exampleGetInstanceClasses.instanceClasses[0].storageRange.min}
      instanceChargeType: Postpaid
      instanceName: terraform-example
      vswitchId: ${exampleSwitch.id}
      monitoringPeriod: '60'
  exampleRdsUpgradeDbInstance:
    type: alicloud:rds:RdsUpgradeDbInstance
    name: example
    properties:
      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}
variables:
  example:
    fn::invoke:
      function: alicloud:rds:getZones
      arguments:
        engine: PostgreSQL
        engineVersion: '13.0'
        instanceChargeType: PostPaid
        category: HighAvailability
        dbInstanceStorageType: cloud_essd
  exampleGetInstanceClasses:
    fn::invoke:
      function: alicloud:rds:getInstanceClasses
      arguments:
        zoneId: ${example.zones[0].id}
        engine: PostgreSQL
        engineVersion: '13.0'
        category: HighAvailability
        dbInstanceStorageType: cloud_essd
        instanceChargeType: PostPaid
  exampleGetCrossRegions:
    fn::invoke:
      function: alicloud:rds:getCrossRegions
      arguments: {}
Copy

Create RdsUpgradeDbInstance Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new RdsUpgradeDbInstance(name: string, args: RdsUpgradeDbInstanceArgs, opts?: CustomResourceOptions);
@overload
def RdsUpgradeDbInstance(resource_name: str,
                         args: RdsUpgradeDbInstanceArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def RdsUpgradeDbInstance(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         collect_stat_mode: Optional[str] = None,
                         db_instance_class: Optional[str] = None,
                         db_instance_storage: Optional[int] = None,
                         db_instance_storage_type: Optional[str] = None,
                         instance_network_type: Optional[str] = None,
                         target_major_version: Optional[str] = None,
                         switch_over: Optional[str] = None,
                         source_db_instance_id: Optional[str] = None,
                         payment_type: Optional[str] = None,
                         parameters: Optional[Sequence[RdsUpgradeDbInstanceParameterArgs]] = None,
                         private_key: Optional[str] = None,
                         client_cert_revocation_list: Optional[str] = None,
                         client_crl_enabled: Optional[int] = None,
                         connection_string_prefix: Optional[str] = None,
                         db_instance_description: Optional[str] = None,
                         db_name: Optional[str] = None,
                         dedicated_host_group_id: Optional[str] = None,
                         deletion_protection: Optional[bool] = None,
                         direction: Optional[str] = None,
                         effective_time: Optional[str] = None,
                         encryption_key: Optional[str] = None,
                         engine: Optional[str] = None,
                         engine_version: Optional[str] = None,
                         force_restart: Optional[bool] = None,
                         ha_mode: Optional[str] = None,
                         maintain_time: Optional[str] = None,
                         client_ca_cert: Optional[str] = None,
                         password: Optional[str] = None,
                         certificate: Optional[str] = None,
                         pg_hba_confs: Optional[Sequence[RdsUpgradeDbInstancePgHbaConfArgs]] = None,
                         port: Optional[str] = None,
                         private_ip_address: Optional[str] = None,
                         client_ca_enabled: Optional[int] = None,
                         released_keep_policy: Optional[str] = None,
                         replication_acl: Optional[str] = None,
                         resource_group_id: Optional[str] = None,
                         role_arn: Optional[str] = None,
                         security_ips: Optional[Sequence[str]] = None,
                         server_cert: Optional[str] = None,
                         server_key: Optional[str] = None,
                         source_biz: Optional[str] = None,
                         ca_type: Optional[str] = None,
                         ssl_enabled: Optional[int] = None,
                         auto_upgrade_minor_version: Optional[str] = None,
                         switch_time: Optional[str] = None,
                         switch_time_mode: Optional[str] = None,
                         sync_mode: Optional[str] = None,
                         acl: Optional[str] = None,
                         tcp_connection_type: Optional[str] = None,
                         tde_status: Optional[str] = None,
                         vpc_id: Optional[str] = None,
                         vswitch_id: Optional[str] = None,
                         zone_id: Optional[str] = None,
                         zone_id_slave1: Optional[str] = None)
func NewRdsUpgradeDbInstance(ctx *Context, name string, args RdsUpgradeDbInstanceArgs, opts ...ResourceOption) (*RdsUpgradeDbInstance, error)
public RdsUpgradeDbInstance(string name, RdsUpgradeDbInstanceArgs args, CustomResourceOptions? opts = null)
public RdsUpgradeDbInstance(String name, RdsUpgradeDbInstanceArgs args)
public RdsUpgradeDbInstance(String name, RdsUpgradeDbInstanceArgs args, CustomResourceOptions options)

type: alicloud:rds:RdsUpgradeDbInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RdsUpgradeDbInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RdsUpgradeDbInstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RdsUpgradeDbInstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RdsUpgradeDbInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RdsUpgradeDbInstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var rdsUpgradeDbInstanceResource = new AliCloud.Rds.RdsUpgradeDbInstance("rdsUpgradeDbInstanceResource", new()
{
    CollectStatMode = "string",
    DbInstanceClass = "string",
    DbInstanceStorage = 0,
    DbInstanceStorageType = "string",
    InstanceNetworkType = "string",
    TargetMajorVersion = "string",
    SwitchOver = "string",
    SourceDbInstanceId = "string",
    PaymentType = "string",
    Parameters = new[]
    {
        new AliCloud.Rds.Inputs.RdsUpgradeDbInstanceParameterArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    PrivateKey = "string",
    ClientCertRevocationList = "string",
    ClientCrlEnabled = 0,
    ConnectionStringPrefix = "string",
    DbInstanceDescription = "string",
    DbName = "string",
    DedicatedHostGroupId = "string",
    DeletionProtection = false,
    Direction = "string",
    EffectiveTime = "string",
    EncryptionKey = "string",
    Engine = "string",
    EngineVersion = "string",
    ForceRestart = false,
    HaMode = "string",
    MaintainTime = "string",
    ClientCaCert = "string",
    Password = "string",
    Certificate = "string",
    PgHbaConfs = new[]
    {
        new AliCloud.Rds.Inputs.RdsUpgradeDbInstancePgHbaConfArgs
        {
            Address = "string",
            Database = "string",
            Method = "string",
            PriorityId = 0,
            Type = "string",
            User = "string",
            Mask = "string",
            Option = "string",
        },
    },
    Port = "string",
    PrivateIpAddress = "string",
    ClientCaEnabled = 0,
    ReleasedKeepPolicy = "string",
    ReplicationAcl = "string",
    ResourceGroupId = "string",
    RoleArn = "string",
    SecurityIps = new[]
    {
        "string",
    },
    ServerCert = "string",
    ServerKey = "string",
    SourceBiz = "string",
    CaType = "string",
    SslEnabled = 0,
    AutoUpgradeMinorVersion = "string",
    SwitchTime = "string",
    SwitchTimeMode = "string",
    SyncMode = "string",
    Acl = "string",
    TcpConnectionType = "string",
    TdeStatus = "string",
    VpcId = "string",
    VswitchId = "string",
    ZoneId = "string",
    ZoneIdSlave1 = "string",
});
Copy
example, err := rds.NewRdsUpgradeDbInstance(ctx, "rdsUpgradeDbInstanceResource", &rds.RdsUpgradeDbInstanceArgs{
	CollectStatMode:       pulumi.String("string"),
	DbInstanceClass:       pulumi.String("string"),
	DbInstanceStorage:     pulumi.Int(0),
	DbInstanceStorageType: pulumi.String("string"),
	InstanceNetworkType:   pulumi.String("string"),
	TargetMajorVersion:    pulumi.String("string"),
	SwitchOver:            pulumi.String("string"),
	SourceDbInstanceId:    pulumi.String("string"),
	PaymentType:           pulumi.String("string"),
	Parameters: rds.RdsUpgradeDbInstanceParameterArray{
		&rds.RdsUpgradeDbInstanceParameterArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	PrivateKey:               pulumi.String("string"),
	ClientCertRevocationList: pulumi.String("string"),
	ClientCrlEnabled:         pulumi.Int(0),
	ConnectionStringPrefix:   pulumi.String("string"),
	DbInstanceDescription:    pulumi.String("string"),
	DbName:                   pulumi.String("string"),
	DedicatedHostGroupId:     pulumi.String("string"),
	DeletionProtection:       pulumi.Bool(false),
	Direction:                pulumi.String("string"),
	EffectiveTime:            pulumi.String("string"),
	EncryptionKey:            pulumi.String("string"),
	Engine:                   pulumi.String("string"),
	EngineVersion:            pulumi.String("string"),
	ForceRestart:             pulumi.Bool(false),
	HaMode:                   pulumi.String("string"),
	MaintainTime:             pulumi.String("string"),
	ClientCaCert:             pulumi.String("string"),
	Password:                 pulumi.String("string"),
	Certificate:              pulumi.String("string"),
	PgHbaConfs: rds.RdsUpgradeDbInstancePgHbaConfArray{
		&rds.RdsUpgradeDbInstancePgHbaConfArgs{
			Address:    pulumi.String("string"),
			Database:   pulumi.String("string"),
			Method:     pulumi.String("string"),
			PriorityId: pulumi.Int(0),
			Type:       pulumi.String("string"),
			User:       pulumi.String("string"),
			Mask:       pulumi.String("string"),
			Option:     pulumi.String("string"),
		},
	},
	Port:               pulumi.String("string"),
	PrivateIpAddress:   pulumi.String("string"),
	ClientCaEnabled:    pulumi.Int(0),
	ReleasedKeepPolicy: pulumi.String("string"),
	ReplicationAcl:     pulumi.String("string"),
	ResourceGroupId:    pulumi.String("string"),
	RoleArn:            pulumi.String("string"),
	SecurityIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServerCert:              pulumi.String("string"),
	ServerKey:               pulumi.String("string"),
	SourceBiz:               pulumi.String("string"),
	CaType:                  pulumi.String("string"),
	SslEnabled:              pulumi.Int(0),
	AutoUpgradeMinorVersion: pulumi.String("string"),
	SwitchTime:              pulumi.String("string"),
	SwitchTimeMode:          pulumi.String("string"),
	SyncMode:                pulumi.String("string"),
	Acl:                     pulumi.String("string"),
	TcpConnectionType:       pulumi.String("string"),
	TdeStatus:               pulumi.String("string"),
	VpcId:                   pulumi.String("string"),
	VswitchId:               pulumi.String("string"),
	ZoneId:                  pulumi.String("string"),
	ZoneIdSlave1:            pulumi.String("string"),
})
Copy
var rdsUpgradeDbInstanceResource = new RdsUpgradeDbInstance("rdsUpgradeDbInstanceResource", RdsUpgradeDbInstanceArgs.builder()
    .collectStatMode("string")
    .dbInstanceClass("string")
    .dbInstanceStorage(0)
    .dbInstanceStorageType("string")
    .instanceNetworkType("string")
    .targetMajorVersion("string")
    .switchOver("string")
    .sourceDbInstanceId("string")
    .paymentType("string")
    .parameters(RdsUpgradeDbInstanceParameterArgs.builder()
        .name("string")
        .value("string")
        .build())
    .privateKey("string")
    .clientCertRevocationList("string")
    .clientCrlEnabled(0)
    .connectionStringPrefix("string")
    .dbInstanceDescription("string")
    .dbName("string")
    .dedicatedHostGroupId("string")
    .deletionProtection(false)
    .direction("string")
    .effectiveTime("string")
    .encryptionKey("string")
    .engine("string")
    .engineVersion("string")
    .forceRestart(false)
    .haMode("string")
    .maintainTime("string")
    .clientCaCert("string")
    .password("string")
    .certificate("string")
    .pgHbaConfs(RdsUpgradeDbInstancePgHbaConfArgs.builder()
        .address("string")
        .database("string")
        .method("string")
        .priorityId(0)
        .type("string")
        .user("string")
        .mask("string")
        .option("string")
        .build())
    .port("string")
    .privateIpAddress("string")
    .clientCaEnabled(0)
    .releasedKeepPolicy("string")
    .replicationAcl("string")
    .resourceGroupId("string")
    .roleArn("string")
    .securityIps("string")
    .serverCert("string")
    .serverKey("string")
    .sourceBiz("string")
    .caType("string")
    .sslEnabled(0)
    .autoUpgradeMinorVersion("string")
    .switchTime("string")
    .switchTimeMode("string")
    .syncMode("string")
    .acl("string")
    .tcpConnectionType("string")
    .tdeStatus("string")
    .vpcId("string")
    .vswitchId("string")
    .zoneId("string")
    .zoneIdSlave1("string")
    .build());
Copy
rds_upgrade_db_instance_resource = alicloud.rds.RdsUpgradeDbInstance("rdsUpgradeDbInstanceResource",
    collect_stat_mode="string",
    db_instance_class="string",
    db_instance_storage=0,
    db_instance_storage_type="string",
    instance_network_type="string",
    target_major_version="string",
    switch_over="string",
    source_db_instance_id="string",
    payment_type="string",
    parameters=[{
        "name": "string",
        "value": "string",
    }],
    private_key="string",
    client_cert_revocation_list="string",
    client_crl_enabled=0,
    connection_string_prefix="string",
    db_instance_description="string",
    db_name="string",
    dedicated_host_group_id="string",
    deletion_protection=False,
    direction="string",
    effective_time="string",
    encryption_key="string",
    engine="string",
    engine_version="string",
    force_restart=False,
    ha_mode="string",
    maintain_time="string",
    client_ca_cert="string",
    password="string",
    certificate="string",
    pg_hba_confs=[{
        "address": "string",
        "database": "string",
        "method": "string",
        "priority_id": 0,
        "type": "string",
        "user": "string",
        "mask": "string",
        "option": "string",
    }],
    port="string",
    private_ip_address="string",
    client_ca_enabled=0,
    released_keep_policy="string",
    replication_acl="string",
    resource_group_id="string",
    role_arn="string",
    security_ips=["string"],
    server_cert="string",
    server_key="string",
    source_biz="string",
    ca_type="string",
    ssl_enabled=0,
    auto_upgrade_minor_version="string",
    switch_time="string",
    switch_time_mode="string",
    sync_mode="string",
    acl="string",
    tcp_connection_type="string",
    tde_status="string",
    vpc_id="string",
    vswitch_id="string",
    zone_id="string",
    zone_id_slave1="string")
Copy
const rdsUpgradeDbInstanceResource = new alicloud.rds.RdsUpgradeDbInstance("rdsUpgradeDbInstanceResource", {
    collectStatMode: "string",
    dbInstanceClass: "string",
    dbInstanceStorage: 0,
    dbInstanceStorageType: "string",
    instanceNetworkType: "string",
    targetMajorVersion: "string",
    switchOver: "string",
    sourceDbInstanceId: "string",
    paymentType: "string",
    parameters: [{
        name: "string",
        value: "string",
    }],
    privateKey: "string",
    clientCertRevocationList: "string",
    clientCrlEnabled: 0,
    connectionStringPrefix: "string",
    dbInstanceDescription: "string",
    dbName: "string",
    dedicatedHostGroupId: "string",
    deletionProtection: false,
    direction: "string",
    effectiveTime: "string",
    encryptionKey: "string",
    engine: "string",
    engineVersion: "string",
    forceRestart: false,
    haMode: "string",
    maintainTime: "string",
    clientCaCert: "string",
    password: "string",
    certificate: "string",
    pgHbaConfs: [{
        address: "string",
        database: "string",
        method: "string",
        priorityId: 0,
        type: "string",
        user: "string",
        mask: "string",
        option: "string",
    }],
    port: "string",
    privateIpAddress: "string",
    clientCaEnabled: 0,
    releasedKeepPolicy: "string",
    replicationAcl: "string",
    resourceGroupId: "string",
    roleArn: "string",
    securityIps: ["string"],
    serverCert: "string",
    serverKey: "string",
    sourceBiz: "string",
    caType: "string",
    sslEnabled: 0,
    autoUpgradeMinorVersion: "string",
    switchTime: "string",
    switchTimeMode: "string",
    syncMode: "string",
    acl: "string",
    tcpConnectionType: "string",
    tdeStatus: "string",
    vpcId: "string",
    vswitchId: "string",
    zoneId: "string",
    zoneIdSlave1: "string",
});
Copy
type: alicloud:rds:RdsUpgradeDbInstance
properties:
    acl: string
    autoUpgradeMinorVersion: string
    caType: string
    certificate: string
    clientCaCert: string
    clientCaEnabled: 0
    clientCertRevocationList: string
    clientCrlEnabled: 0
    collectStatMode: string
    connectionStringPrefix: string
    dbInstanceClass: string
    dbInstanceDescription: string
    dbInstanceStorage: 0
    dbInstanceStorageType: string
    dbName: string
    dedicatedHostGroupId: string
    deletionProtection: false
    direction: string
    effectiveTime: string
    encryptionKey: string
    engine: string
    engineVersion: string
    forceRestart: false
    haMode: string
    instanceNetworkType: string
    maintainTime: string
    parameters:
        - name: string
          value: string
    password: string
    paymentType: string
    pgHbaConfs:
        - address: string
          database: string
          mask: string
          method: string
          option: string
          priorityId: 0
          type: string
          user: string
    port: string
    privateIpAddress: string
    privateKey: string
    releasedKeepPolicy: string
    replicationAcl: string
    resourceGroupId: string
    roleArn: string
    securityIps:
        - string
    serverCert: string
    serverKey: string
    sourceBiz: string
    sourceDbInstanceId: string
    sslEnabled: 0
    switchOver: string
    switchTime: string
    switchTimeMode: string
    syncMode: string
    targetMajorVersion: string
    tcpConnectionType: string
    tdeStatus: string
    vpcId: string
    vswitchId: string
    zoneId: string
    zoneIdSlave1: string
Copy

RdsUpgradeDbInstance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The RdsUpgradeDbInstance resource accepts the following input properties:

CollectStatMode This property is required. string

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.

DbInstanceClass This property is required. string
The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.
DbInstanceStorage This property is required. int

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.

DbInstanceStorageType This property is required. string
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.
InstanceNetworkType
This property is required.
Changes to this property will trigger replacement.
string
The network type of the instance. Valid values:

  • Classic: Classic Network.
  • VPC: VPC.
PaymentType This property is required. string
The billing method of the new instance. Valid values: PayAsYouGo and Subscription.
SourceDbInstanceId
This property is required.
Changes to this property will trigger replacement.
string
The source db instance id.
SwitchOver This property is required. string
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.
TargetMajorVersion
This property is required.
Changes to this property will trigger replacement.
string

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.

Acl string
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 string
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.
CaType string
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 string
The file that contains the certificate used for TDE.
ClientCaCert string
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 int
The client ca enabled.
ClientCertRevocationList string
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 int
The client crl enabled.
ConnectionStringPrefix string
The connection string prefix.
DbInstanceDescription string
The db instance description.
DbName string

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.

DedicatedHostGroupId string
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 bool

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.

Direction string
The direction. Valid values: Auto, Down, TempUpgrade, Up.
EffectiveTime string
The effective time.
EncryptionKey string

The ID of the private key.

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

Engine Changes to this property will trigger replacement. string
Database type. Value options: MySQL, SQLServer, PostgreSQL.
EngineVersion Changes to this property will trigger replacement. string
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.
ForceRestart bool
Set it to true to make some parameter efficient when modifying them. Default to false.
HaMode string
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.
MaintainTime string
The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).
Parameters List<Pulumi.AliCloud.Rds.Inputs.RdsUpgradeDbInstanceParameter>
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 string

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.

PgHbaConfs List<Pulumi.AliCloud.Rds.Inputs.RdsUpgradeDbInstancePgHbaConf>
The configuration of AD domain . See pg_hba_conf below.
Port string
The port.
PrivateIpAddress string
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 string
The file that contains the private key used for TDE.
ReleasedKeepPolicy string
The released keep policy.
ReplicationAcl string
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 string
The resource group id.
RoleArn string

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.

SecurityIps List<string>

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.

ServerCert string
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 string
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 string
The source biz.
SslEnabled int
Enable or disable SSL. Valid values: 0 and 1.
SwitchTime string
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 string
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.
SyncMode string

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.

TcpConnectionType string
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.
TdeStatus string
Specifies whether to enable TDE. Valid values: Enabled and Disabled.
VpcId string

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

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

VswitchId string

The ID of the vSwitch associated with the specified VPC.

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

ZoneId Changes to this property will trigger replacement. string

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.

ZoneIdSlave1 Changes to this property will trigger replacement. string
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.
CollectStatMode This property is required. string

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.

DbInstanceClass This property is required. string
The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.
DbInstanceStorage This property is required. int

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.

DbInstanceStorageType This property is required. string
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.
InstanceNetworkType
This property is required.
Changes to this property will trigger replacement.
string
The network type of the instance. Valid values:

  • Classic: Classic Network.
  • VPC: VPC.
PaymentType This property is required. string
The billing method of the new instance. Valid values: PayAsYouGo and Subscription.
SourceDbInstanceId
This property is required.
Changes to this property will trigger replacement.
string
The source db instance id.
SwitchOver This property is required. string
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.
TargetMajorVersion
This property is required.
Changes to this property will trigger replacement.
string

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.

Acl string
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 string
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.
CaType string
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 string
The file that contains the certificate used for TDE.
ClientCaCert string
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 int
The client ca enabled.
ClientCertRevocationList string
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 int
The client crl enabled.
ConnectionStringPrefix string
The connection string prefix.
DbInstanceDescription string
The db instance description.
DbName string

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.

DedicatedHostGroupId string
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 bool

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.

Direction string
The direction. Valid values: Auto, Down, TempUpgrade, Up.
EffectiveTime string
The effective time.
EncryptionKey string

The ID of the private key.

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

Engine Changes to this property will trigger replacement. string
Database type. Value options: MySQL, SQLServer, PostgreSQL.
EngineVersion Changes to this property will trigger replacement. string
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.
ForceRestart bool
Set it to true to make some parameter efficient when modifying them. Default to false.
HaMode string
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.
MaintainTime string
The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).
Parameters []RdsUpgradeDbInstanceParameterArgs
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 string

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.

PgHbaConfs []RdsUpgradeDbInstancePgHbaConfArgs
The configuration of AD domain . See pg_hba_conf below.
Port string
The port.
PrivateIpAddress string
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 string
The file that contains the private key used for TDE.
ReleasedKeepPolicy string
The released keep policy.
ReplicationAcl string
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 string
The resource group id.
RoleArn string

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.

SecurityIps []string

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.

ServerCert string
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 string
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 string
The source biz.
SslEnabled int
Enable or disable SSL. Valid values: 0 and 1.
SwitchTime string
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 string
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.
SyncMode string

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.

TcpConnectionType string
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.
TdeStatus string
Specifies whether to enable TDE. Valid values: Enabled and Disabled.
VpcId string

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

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

VswitchId string

The ID of the vSwitch associated with the specified VPC.

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

ZoneId Changes to this property will trigger replacement. string

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.

ZoneIdSlave1 Changes to this property will trigger replacement. string
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.
collectStatMode This property is required. String

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.

dbInstanceClass This property is required. String
The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.
dbInstanceStorage This property is required. Integer

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.

dbInstanceStorageType This property is required. String
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.
instanceNetworkType
This property is required.
Changes to this property will trigger replacement.
String
The network type of the instance. Valid values:

  • Classic: Classic Network.
  • VPC: VPC.
paymentType This property is required. String
The billing method of the new instance. Valid values: PayAsYouGo and Subscription.
sourceDbInstanceId
This property is required.
Changes to this property will trigger replacement.
String
The source db instance id.
switchOver This property is required. String
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.
targetMajorVersion
This property is required.
Changes to this property will trigger replacement.
String

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.

acl String
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 String
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.
caType String
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 String
The file that contains the certificate used for TDE.
clientCaCert String
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 Integer
The client ca enabled.
clientCertRevocationList String
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 Integer
The client crl enabled.
connectionStringPrefix String
The connection string prefix.
dbInstanceDescription String
The db instance description.
dbName String

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.

dedicatedHostGroupId String
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 Boolean

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.

direction String
The direction. Valid values: Auto, Down, TempUpgrade, Up.
effectiveTime String
The effective time.
encryptionKey String

The ID of the private key.

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

engine Changes to this property will trigger replacement. String
Database type. Value options: MySQL, SQLServer, PostgreSQL.
engineVersion Changes to this property will trigger replacement. String
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.
forceRestart Boolean
Set it to true to make some parameter efficient when modifying them. Default to false.
haMode String
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.
maintainTime String
The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).
parameters List<RdsUpgradeDbInstanceParameter>
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 String

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.

pgHbaConfs List<RdsUpgradeDbInstancePgHbaConf>
The configuration of AD domain . See pg_hba_conf below.
port String
The port.
privateIpAddress String
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 String
The file that contains the private key used for TDE.
releasedKeepPolicy String
The released keep policy.
replicationAcl String
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 String
The resource group id.
roleArn String

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.

securityIps List<String>

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.

serverCert String
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 String
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 String
The source biz.
sslEnabled Integer
Enable or disable SSL. Valid values: 0 and 1.
switchTime String
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 String
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.
syncMode String

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.

tcpConnectionType String
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.
tdeStatus String
Specifies whether to enable TDE. Valid values: Enabled and Disabled.
vpcId String

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

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

vswitchId String

The ID of the vSwitch associated with the specified VPC.

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

zoneId Changes to this property will trigger replacement. String

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.

zoneIdSlave1 Changes to this property will trigger replacement. String
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.
collectStatMode This property is required. string

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.

dbInstanceClass This property is required. string
The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.
dbInstanceStorage This property is required. number

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.

dbInstanceStorageType This property is required. string
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.
instanceNetworkType
This property is required.
Changes to this property will trigger replacement.
string
The network type of the instance. Valid values:

  • Classic: Classic Network.
  • VPC: VPC.
paymentType This property is required. string
The billing method of the new instance. Valid values: PayAsYouGo and Subscription.
sourceDbInstanceId
This property is required.
Changes to this property will trigger replacement.
string
The source db instance id.
switchOver This property is required. string
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.
targetMajorVersion
This property is required.
Changes to this property will trigger replacement.
string

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.

acl string
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 string
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.
caType string
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 string
The file that contains the certificate used for TDE.
clientCaCert string
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 number
The client ca enabled.
clientCertRevocationList string
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 number
The client crl enabled.
connectionStringPrefix string
The connection string prefix.
dbInstanceDescription string
The db instance description.
dbName string

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.

dedicatedHostGroupId string
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 boolean

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.

direction string
The direction. Valid values: Auto, Down, TempUpgrade, Up.
effectiveTime string
The effective time.
encryptionKey string

The ID of the private key.

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

engine Changes to this property will trigger replacement. string
Database type. Value options: MySQL, SQLServer, PostgreSQL.
engineVersion Changes to this property will trigger replacement. string
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.
forceRestart boolean
Set it to true to make some parameter efficient when modifying them. Default to false.
haMode string
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.
maintainTime string
The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).
parameters RdsUpgradeDbInstanceParameter[]
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 string

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.

pgHbaConfs RdsUpgradeDbInstancePgHbaConf[]
The configuration of AD domain . See pg_hba_conf below.
port string
The port.
privateIpAddress string
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 string
The file that contains the private key used for TDE.
releasedKeepPolicy string
The released keep policy.
replicationAcl string
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 string
The resource group id.
roleArn string

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.

securityIps string[]

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.

serverCert string
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 string
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 string
The source biz.
sslEnabled number
Enable or disable SSL. Valid values: 0 and 1.
switchTime string
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 string
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.
syncMode string

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.

tcpConnectionType string
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.
tdeStatus string
Specifies whether to enable TDE. Valid values: Enabled and Disabled.
vpcId string

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

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

vswitchId string

The ID of the vSwitch associated with the specified VPC.

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

zoneId Changes to this property will trigger replacement. string

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.

zoneIdSlave1 Changes to this property will trigger replacement. string
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.
collect_stat_mode This property is required. str

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.

db_instance_class This property is required. str
The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.
db_instance_storage This property is required. int

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.

db_instance_storage_type This property is required. str
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.
instance_network_type
This property is required.
Changes to this property will trigger replacement.
str
The network type of the instance. Valid values:

  • Classic: Classic Network.
  • VPC: VPC.
payment_type This property is required. str
The billing method of the new instance. Valid values: PayAsYouGo and Subscription.
source_db_instance_id
This property is required.
Changes to this property will trigger replacement.
str
The source db instance id.
switch_over This property is required. str
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.
target_major_version
This property is required.
Changes to this property will trigger replacement.
str

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.

acl str
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 str
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 str
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 str
The file that contains the certificate used for TDE.
client_ca_cert str
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 int
The client ca enabled.
client_cert_revocation_list str
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 int
The client crl enabled.
connection_string_prefix str
The connection string prefix.
db_instance_description str
The db instance description.
db_name str

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 str
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.
deletion_protection bool

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.

direction str
The direction. Valid values: Auto, Down, TempUpgrade, Up.
effective_time str
The effective time.
encryption_key str

The ID of the private key.

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

engine Changes to this property will trigger replacement. str
Database type. Value options: MySQL, SQLServer, PostgreSQL.
engine_version Changes to this property will trigger replacement. str
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.
force_restart bool
Set it to true to make some parameter efficient when modifying them. Default to false.
ha_mode str
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.
maintain_time str
The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).
parameters Sequence[RdsUpgradeDbInstanceParameterArgs]
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 str

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.

pg_hba_confs Sequence[RdsUpgradeDbInstancePgHbaConfArgs]
The configuration of AD domain . See pg_hba_conf below.
port str
The port.
private_ip_address str
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.
private_key str
The file that contains the private key used for TDE.
released_keep_policy str
The released keep policy.
replication_acl str
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 str
The resource group id.
role_arn str

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 Sequence[str]

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 str
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 str
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 str
The source biz.
ssl_enabled int
Enable or disable SSL. Valid values: 0 and 1.
switch_time str
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.
switch_time_mode str
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.
sync_mode str

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.

tcp_connection_type str
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.
tde_status str
Specifies whether to enable TDE. Valid values: Enabled and Disabled.
vpc_id str

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

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

vswitch_id str

The ID of the vSwitch associated with the specified VPC.

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

zone_id Changes to this property will trigger replacement. str

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_slave1 Changes to this property will trigger replacement. str
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.
collectStatMode This property is required. String

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.

dbInstanceClass This property is required. String
The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.
dbInstanceStorage This property is required. Number

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.

dbInstanceStorageType This property is required. String
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.
instanceNetworkType
This property is required.
Changes to this property will trigger replacement.
String
The network type of the instance. Valid values:

  • Classic: Classic Network.
  • VPC: VPC.
paymentType This property is required. String
The billing method of the new instance. Valid values: PayAsYouGo and Subscription.
sourceDbInstanceId
This property is required.
Changes to this property will trigger replacement.
String
The source db instance id.
switchOver This property is required. String
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.
targetMajorVersion
This property is required.
Changes to this property will trigger replacement.
String

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.

acl String
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 String
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.
caType String
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 String
The file that contains the certificate used for TDE.
clientCaCert String
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 Number
The client ca enabled.
clientCertRevocationList String
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 Number
The client crl enabled.
connectionStringPrefix String
The connection string prefix.
dbInstanceDescription String
The db instance description.
dbName String

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.

dedicatedHostGroupId String
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 Boolean

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.

direction String
The direction. Valid values: Auto, Down, TempUpgrade, Up.
effectiveTime String
The effective time.
encryptionKey String

The ID of the private key.

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

engine Changes to this property will trigger replacement. String
Database type. Value options: MySQL, SQLServer, PostgreSQL.
engineVersion Changes to this property will trigger replacement. String
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.
forceRestart Boolean
Set it to true to make some parameter efficient when modifying them. Default to false.
haMode String
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.
maintainTime String
The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).
parameters List<Property Map>
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 String

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.

pgHbaConfs List<Property Map>
The configuration of AD domain . See pg_hba_conf below.
port String
The port.
privateIpAddress String
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 String
The file that contains the private key used for TDE.
releasedKeepPolicy String
The released keep policy.
replicationAcl String
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 String
The resource group id.
roleArn String

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.

securityIps List<String>

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.

serverCert String
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 String
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 String
The source biz.
sslEnabled Number
Enable or disable SSL. Valid values: 0 and 1.
switchTime String
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 String
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.
syncMode String

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.

tcpConnectionType String
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.
tdeStatus String
Specifies whether to enable TDE. Valid values: Enabled and Disabled.
vpcId String

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

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

vswitchId String

The ID of the vSwitch associated with the specified VPC.

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

zoneId Changes to this property will trigger replacement. String

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.

zoneIdSlave1 Changes to this property will trigger replacement. String
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the RdsUpgradeDbInstance resource produces the following output properties:

ConnectionString string
The database connection address.
Id string
The provider-assigned unique ID for this managed resource.
ConnectionString string
The database connection address.
Id string
The provider-assigned unique ID for this managed resource.
connectionString String
The database connection address.
id String
The provider-assigned unique ID for this managed resource.
connectionString string
The database connection address.
id string
The provider-assigned unique ID for this managed resource.
connection_string str
The database connection address.
id str
The provider-assigned unique ID for this managed resource.
connectionString String
The database connection address.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing RdsUpgradeDbInstance Resource

Get an existing RdsUpgradeDbInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RdsUpgradeDbInstanceState, opts?: CustomResourceOptions): RdsUpgradeDbInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acl: Optional[str] = None,
        auto_upgrade_minor_version: Optional[str] = None,
        ca_type: Optional[str] = None,
        certificate: Optional[str] = None,
        client_ca_cert: Optional[str] = None,
        client_ca_enabled: Optional[int] = None,
        client_cert_revocation_list: Optional[str] = None,
        client_crl_enabled: Optional[int] = None,
        collect_stat_mode: Optional[str] = None,
        connection_string: Optional[str] = None,
        connection_string_prefix: Optional[str] = None,
        db_instance_class: Optional[str] = None,
        db_instance_description: Optional[str] = None,
        db_instance_storage: Optional[int] = None,
        db_instance_storage_type: Optional[str] = None,
        db_name: Optional[str] = None,
        dedicated_host_group_id: Optional[str] = None,
        deletion_protection: Optional[bool] = None,
        direction: Optional[str] = None,
        effective_time: Optional[str] = None,
        encryption_key: Optional[str] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        force_restart: Optional[bool] = None,
        ha_mode: Optional[str] = None,
        instance_network_type: Optional[str] = None,
        maintain_time: Optional[str] = None,
        parameters: Optional[Sequence[RdsUpgradeDbInstanceParameterArgs]] = None,
        password: Optional[str] = None,
        payment_type: Optional[str] = None,
        pg_hba_confs: Optional[Sequence[RdsUpgradeDbInstancePgHbaConfArgs]] = None,
        port: Optional[str] = None,
        private_ip_address: Optional[str] = None,
        private_key: Optional[str] = None,
        released_keep_policy: Optional[str] = None,
        replication_acl: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        role_arn: Optional[str] = None,
        security_ips: Optional[Sequence[str]] = None,
        server_cert: Optional[str] = None,
        server_key: Optional[str] = None,
        source_biz: Optional[str] = None,
        source_db_instance_id: Optional[str] = None,
        ssl_enabled: Optional[int] = None,
        switch_over: Optional[str] = None,
        switch_time: Optional[str] = None,
        switch_time_mode: Optional[str] = None,
        sync_mode: Optional[str] = None,
        target_major_version: Optional[str] = None,
        tcp_connection_type: Optional[str] = None,
        tde_status: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_id: Optional[str] = None,
        zone_id_slave1: Optional[str] = None) -> RdsUpgradeDbInstance
func GetRdsUpgradeDbInstance(ctx *Context, name string, id IDInput, state *RdsUpgradeDbInstanceState, opts ...ResourceOption) (*RdsUpgradeDbInstance, error)
public static RdsUpgradeDbInstance Get(string name, Input<string> id, RdsUpgradeDbInstanceState? state, CustomResourceOptions? opts = null)
public static RdsUpgradeDbInstance get(String name, Output<String> id, RdsUpgradeDbInstanceState state, CustomResourceOptions options)
resources:  _:    type: alicloud:rds:RdsUpgradeDbInstance    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Acl string
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 string
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.
CaType string
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 string
The file that contains the certificate used for TDE.
ClientCaCert string
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 int
The client ca enabled.
ClientCertRevocationList string
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 int
The client crl enabled.
CollectStatMode string

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.

ConnectionString string
The database connection address.
ConnectionStringPrefix string
The connection string prefix.
DbInstanceClass string
The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.
DbInstanceDescription string
The db instance description.
DbInstanceStorage int

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.

DbInstanceStorageType string
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.
DbName string

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.

DedicatedHostGroupId string
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 bool

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.

Direction string
The direction. Valid values: Auto, Down, TempUpgrade, Up.
EffectiveTime string
The effective time.
EncryptionKey string

The ID of the private key.

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

Engine Changes to this property will trigger replacement. string
Database type. Value options: MySQL, SQLServer, PostgreSQL.
EngineVersion Changes to this property will trigger replacement. string
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.
ForceRestart bool
Set it to true to make some parameter efficient when modifying them. Default to false.
HaMode string
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.
InstanceNetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:

  • Classic: Classic Network.
  • VPC: VPC.
MaintainTime string
The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).
Parameters List<Pulumi.AliCloud.Rds.Inputs.RdsUpgradeDbInstanceParameter>
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 string

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.

PaymentType string
The billing method of the new instance. Valid values: PayAsYouGo and Subscription.
PgHbaConfs List<Pulumi.AliCloud.Rds.Inputs.RdsUpgradeDbInstancePgHbaConf>
The configuration of AD domain . See pg_hba_conf below.
Port string
The port.
PrivateIpAddress string
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 string
The file that contains the private key used for TDE.
ReleasedKeepPolicy string
The released keep policy.
ReplicationAcl string
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 string
The resource group id.
RoleArn string

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.

SecurityIps List<string>

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.

ServerCert string
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 string
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 string
The source biz.
SourceDbInstanceId Changes to this property will trigger replacement. string
The source db instance id.
SslEnabled int
Enable or disable SSL. Valid values: 0 and 1.
SwitchOver string
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.
SwitchTime string
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 string
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.
SyncMode string

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.

TargetMajorVersion Changes to this property will trigger replacement. string

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.

TcpConnectionType string
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.
TdeStatus string
Specifies whether to enable TDE. Valid values: Enabled and Disabled.
VpcId string

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

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

VswitchId string

The ID of the vSwitch associated with the specified VPC.

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

ZoneId Changes to this property will trigger replacement. string

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.

ZoneIdSlave1 Changes to this property will trigger replacement. string
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.
Acl string
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 string
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.
CaType string
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 string
The file that contains the certificate used for TDE.
ClientCaCert string
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 int
The client ca enabled.
ClientCertRevocationList string
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 int
The client crl enabled.
CollectStatMode string

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.

ConnectionString string
The database connection address.
ConnectionStringPrefix string
The connection string prefix.
DbInstanceClass string
The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.
DbInstanceDescription string
The db instance description.
DbInstanceStorage int

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.

DbInstanceStorageType string
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.
DbName string

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.

DedicatedHostGroupId string
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 bool

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.

Direction string
The direction. Valid values: Auto, Down, TempUpgrade, Up.
EffectiveTime string
The effective time.
EncryptionKey string

The ID of the private key.

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

Engine Changes to this property will trigger replacement. string
Database type. Value options: MySQL, SQLServer, PostgreSQL.
EngineVersion Changes to this property will trigger replacement. string
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.
ForceRestart bool
Set it to true to make some parameter efficient when modifying them. Default to false.
HaMode string
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.
InstanceNetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:

  • Classic: Classic Network.
  • VPC: VPC.
MaintainTime string
The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).
Parameters []RdsUpgradeDbInstanceParameterArgs
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 string

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.

PaymentType string
The billing method of the new instance. Valid values: PayAsYouGo and Subscription.
PgHbaConfs []RdsUpgradeDbInstancePgHbaConfArgs
The configuration of AD domain . See pg_hba_conf below.
Port string
The port.
PrivateIpAddress string
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 string
The file that contains the private key used for TDE.
ReleasedKeepPolicy string
The released keep policy.
ReplicationAcl string
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 string
The resource group id.
RoleArn string

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.

SecurityIps []string

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.

ServerCert string
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 string
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 string
The source biz.
SourceDbInstanceId Changes to this property will trigger replacement. string
The source db instance id.
SslEnabled int
Enable or disable SSL. Valid values: 0 and 1.
SwitchOver string
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.
SwitchTime string
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 string
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.
SyncMode string

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.

TargetMajorVersion Changes to this property will trigger replacement. string

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.

TcpConnectionType string
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.
TdeStatus string
Specifies whether to enable TDE. Valid values: Enabled and Disabled.
VpcId string

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

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

VswitchId string

The ID of the vSwitch associated with the specified VPC.

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

ZoneId Changes to this property will trigger replacement. string

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.

ZoneIdSlave1 Changes to this property will trigger replacement. string
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.
acl String
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 String
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.
caType String
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 String
The file that contains the certificate used for TDE.
clientCaCert String
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 Integer
The client ca enabled.
clientCertRevocationList String
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 Integer
The client crl enabled.
collectStatMode String

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.

connectionString String
The database connection address.
connectionStringPrefix String
The connection string prefix.
dbInstanceClass String
The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.
dbInstanceDescription String
The db instance description.
dbInstanceStorage Integer

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.

dbInstanceStorageType String
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.
dbName String

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.

dedicatedHostGroupId String
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 Boolean

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.

direction String
The direction. Valid values: Auto, Down, TempUpgrade, Up.
effectiveTime String
The effective time.
encryptionKey String

The ID of the private key.

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

engine Changes to this property will trigger replacement. String
Database type. Value options: MySQL, SQLServer, PostgreSQL.
engineVersion Changes to this property will trigger replacement. String
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.
forceRestart Boolean
Set it to true to make some parameter efficient when modifying them. Default to false.
haMode String
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.
instanceNetworkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values:

  • Classic: Classic Network.
  • VPC: VPC.
maintainTime String
The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).
parameters List<RdsUpgradeDbInstanceParameter>
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 String

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.

paymentType String
The billing method of the new instance. Valid values: PayAsYouGo and Subscription.
pgHbaConfs List<RdsUpgradeDbInstancePgHbaConf>
The configuration of AD domain . See pg_hba_conf below.
port String
The port.
privateIpAddress String
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 String
The file that contains the private key used for TDE.
releasedKeepPolicy String
The released keep policy.
replicationAcl String
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 String
The resource group id.
roleArn String

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.

securityIps List<String>

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.

serverCert String
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 String
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 String
The source biz.
sourceDbInstanceId Changes to this property will trigger replacement. String
The source db instance id.
sslEnabled Integer
Enable or disable SSL. Valid values: 0 and 1.
switchOver String
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.
switchTime String
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 String
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.
syncMode String

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.

targetMajorVersion Changes to this property will trigger replacement. String

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.

tcpConnectionType String
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.
tdeStatus String
Specifies whether to enable TDE. Valid values: Enabled and Disabled.
vpcId String

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

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

vswitchId String

The ID of the vSwitch associated with the specified VPC.

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

zoneId Changes to this property will trigger replacement. String

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.

zoneIdSlave1 Changes to this property will trigger replacement. String
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.
acl string
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 string
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.
caType string
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 string
The file that contains the certificate used for TDE.
clientCaCert string
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 number
The client ca enabled.
clientCertRevocationList string
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 number
The client crl enabled.
collectStatMode string

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.

connectionString string
The database connection address.
connectionStringPrefix string
The connection string prefix.
dbInstanceClass string
The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.
dbInstanceDescription string
The db instance description.
dbInstanceStorage number

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.

dbInstanceStorageType string
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.
dbName string

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.

dedicatedHostGroupId string
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 boolean

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.

direction string
The direction. Valid values: Auto, Down, TempUpgrade, Up.
effectiveTime string
The effective time.
encryptionKey string

The ID of the private key.

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

engine Changes to this property will trigger replacement. string
Database type. Value options: MySQL, SQLServer, PostgreSQL.
engineVersion Changes to this property will trigger replacement. string
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.
forceRestart boolean
Set it to true to make some parameter efficient when modifying them. Default to false.
haMode string
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.
instanceNetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:

  • Classic: Classic Network.
  • VPC: VPC.
maintainTime string
The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).
parameters RdsUpgradeDbInstanceParameter[]
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 string

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.

paymentType string
The billing method of the new instance. Valid values: PayAsYouGo and Subscription.
pgHbaConfs RdsUpgradeDbInstancePgHbaConf[]
The configuration of AD domain . See pg_hba_conf below.
port string
The port.
privateIpAddress string
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 string
The file that contains the private key used for TDE.
releasedKeepPolicy string
The released keep policy.
replicationAcl string
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 string
The resource group id.
roleArn string

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.

securityIps string[]

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.

serverCert string
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 string
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 string
The source biz.
sourceDbInstanceId Changes to this property will trigger replacement. string
The source db instance id.
sslEnabled number
Enable or disable SSL. Valid values: 0 and 1.
switchOver string
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.
switchTime string
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 string
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.
syncMode string

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.

targetMajorVersion Changes to this property will trigger replacement. string

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.

tcpConnectionType string
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.
tdeStatus string
Specifies whether to enable TDE. Valid values: Enabled and Disabled.
vpcId string

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

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

vswitchId string

The ID of the vSwitch associated with the specified VPC.

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

zoneId Changes to this property will trigger replacement. string

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.

zoneIdSlave1 Changes to this property will trigger replacement. string
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.
acl str
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 str
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 str
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 str
The file that contains the certificate used for TDE.
client_ca_cert str
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 int
The client ca enabled.
client_cert_revocation_list str
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 int
The client crl enabled.
collect_stat_mode str

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.

connection_string str
The database connection address.
connection_string_prefix str
The connection string prefix.
db_instance_class str
The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.
db_instance_description str
The db instance description.
db_instance_storage int

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.

db_instance_storage_type str
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.
db_name str

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 str
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.
deletion_protection bool

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.

direction str
The direction. Valid values: Auto, Down, TempUpgrade, Up.
effective_time str
The effective time.
encryption_key str

The ID of the private key.

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

engine Changes to this property will trigger replacement. str
Database type. Value options: MySQL, SQLServer, PostgreSQL.
engine_version Changes to this property will trigger replacement. str
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.
force_restart bool
Set it to true to make some parameter efficient when modifying them. Default to false.
ha_mode str
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.
instance_network_type Changes to this property will trigger replacement. str
The network type of the instance. Valid values:

  • Classic: Classic Network.
  • VPC: VPC.
maintain_time str
The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).
parameters Sequence[RdsUpgradeDbInstanceParameterArgs]
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 str

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.

payment_type str
The billing method of the new instance. Valid values: PayAsYouGo and Subscription.
pg_hba_confs Sequence[RdsUpgradeDbInstancePgHbaConfArgs]
The configuration of AD domain . See pg_hba_conf below.
port str
The port.
private_ip_address str
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.
private_key str
The file that contains the private key used for TDE.
released_keep_policy str
The released keep policy.
replication_acl str
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 str
The resource group id.
role_arn str

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 Sequence[str]

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 str
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 str
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 str
The source biz.
source_db_instance_id Changes to this property will trigger replacement. str
The source db instance id.
ssl_enabled int
Enable or disable SSL. Valid values: 0 and 1.
switch_over str
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.
switch_time str
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.
switch_time_mode str
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.
sync_mode str

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.

target_major_version Changes to this property will trigger replacement. str

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 str
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.
tde_status str
Specifies whether to enable TDE. Valid values: Enabled and Disabled.
vpc_id str

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

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

vswitch_id str

The ID of the vSwitch associated with the specified VPC.

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

zone_id Changes to this property will trigger replacement. str

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_slave1 Changes to this property will trigger replacement. str
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.
acl String
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 String
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.
caType String
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 String
The file that contains the certificate used for TDE.
clientCaCert String
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 Number
The client ca enabled.
clientCertRevocationList String
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 Number
The client crl enabled.
collectStatMode String

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.

connectionString String
The database connection address.
connectionStringPrefix String
The connection string prefix.
dbInstanceClass String
The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types.
dbInstanceDescription String
The db instance description.
dbInstanceStorage Number

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.

dbInstanceStorageType String
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.
dbName String

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.

dedicatedHostGroupId String
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 Boolean

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.

direction String
The direction. Valid values: Auto, Down, TempUpgrade, Up.
effectiveTime String
The effective time.
encryptionKey String

The ID of the private key.

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

engine Changes to this property will trigger replacement. String
Database type. Value options: MySQL, SQLServer, PostgreSQL.
engineVersion Changes to this property will trigger replacement. String
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.
forceRestart Boolean
Set it to true to make some parameter efficient when modifying them. Default to false.
haMode String
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.
instanceNetworkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values:

  • Classic: Classic Network.
  • VPC: VPC.
maintainTime String
The maintainable time period of the instance. Format: HH:mm Z- HH:mm Z(UTC time).
parameters List<Property Map>
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 String

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.

paymentType String
The billing method of the new instance. Valid values: PayAsYouGo and Subscription.
pgHbaConfs List<Property Map>
The configuration of AD domain . See pg_hba_conf below.
port String
The port.
privateIpAddress String
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 String
The file that contains the private key used for TDE.
releasedKeepPolicy String
The released keep policy.
replicationAcl String
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 String
The resource group id.
roleArn String

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.

securityIps List<String>

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.

serverCert String
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 String
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 String
The source biz.
sourceDbInstanceId Changes to this property will trigger replacement. String
The source db instance id.
sslEnabled Number
Enable or disable SSL. Valid values: 0 and 1.
switchOver String
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.
switchTime String
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 String
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.
syncMode String

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.

targetMajorVersion Changes to this property will trigger replacement. String

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.

tcpConnectionType String
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.
tdeStatus String
Specifies whether to enable TDE. Valid values: Enabled and Disabled.
vpcId String

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

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

vswitchId String

The ID of the vSwitch associated with the specified VPC.

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

zoneId Changes to this property will trigger replacement. String

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.

zoneIdSlave1 Changes to this property will trigger replacement. String
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.

Supporting Types

RdsUpgradeDbInstanceParameter
, RdsUpgradeDbInstanceParameterArgs

Name This property is required. string
The parameter name.
Value This property is required. string
The parameter value.
Name This property is required. string
The parameter name.
Value This property is required. string
The parameter value.
name This property is required. String
The parameter name.
value This property is required. String
The parameter value.
name This property is required. string
The parameter name.
value This property is required. string
The parameter value.
name This property is required. str
The parameter name.
value This property is required. str
The parameter value.
name This property is required. String
The parameter name.
value This property is required. String
The parameter value.

RdsUpgradeDbInstancePgHbaConf
, RdsUpgradeDbInstancePgHbaConfArgs

Address This property is required. string
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.
Database This property is required. string
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 (,).
Method This property is required. string
The authentication method of Lightweight Directory Access Protocol (LDAP). Valid values: trust, reject, scram-sha-256, md5, password, gss, sspi, ldap, radius, cert, pam.
PriorityId This property is required. int
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.
Type This property is required. string

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.

User This property is required. string
The user that is allowed to access the instance. If you specify multiple users, separate the usernames with commas (,).
Mask string
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.
Option string
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.
Address This property is required. string
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.
Database This property is required. string
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 (,).
Method This property is required. string
The authentication method of Lightweight Directory Access Protocol (LDAP). Valid values: trust, reject, scram-sha-256, md5, password, gss, sspi, ldap, radius, cert, pam.
PriorityId This property is required. int
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.
Type This property is required. string

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.

User This property is required. string
The user that is allowed to access the instance. If you specify multiple users, separate the usernames with commas (,).
Mask string
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.
Option string
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.
address This property is required. String
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.
database This property is required. String
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 (,).
method This property is required. String
The authentication method of Lightweight Directory Access Protocol (LDAP). Valid values: trust, reject, scram-sha-256, md5, password, gss, sspi, ldap, radius, cert, pam.
priorityId This property is required. Integer
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.
type This property is required. String

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.

user This property is required. String
The user that is allowed to access the instance. If you specify multiple users, separate the usernames with commas (,).
mask String
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.
option String
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.
address This property is required. string
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.
database This property is required. string
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 (,).
method This property is required. string
The authentication method of Lightweight Directory Access Protocol (LDAP). Valid values: trust, reject, scram-sha-256, md5, password, gss, sspi, ldap, radius, cert, pam.
priorityId This property is required. number
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.
type This property is required. string

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.

user This property is required. string
The user that is allowed to access the instance. If you specify multiple users, separate the usernames with commas (,).
mask string
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.
option string
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.
address This property is required. str
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.
database This property is required. str
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 (,).
method This property is required. str
The authentication method of Lightweight Directory Access Protocol (LDAP). Valid values: trust, reject, scram-sha-256, md5, password, gss, sspi, ldap, radius, cert, pam.
priority_id This property is required. int
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.
type This property is required. str

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.

user This property is required. str
The user that is allowed to access the instance. If you specify multiple users, separate the usernames with commas (,).
mask str
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.
option str
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.
address This property is required. String
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.
database This property is required. String
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 (,).
method This property is required. String
The authentication method of Lightweight Directory Access Protocol (LDAP). Valid values: trust, reject, scram-sha-256, md5, password, gss, sspi, ldap, radius, cert, pam.
priorityId This property is required. Number
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.
type This property is required. String

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.

user This property is required. String
The user that is allowed to access the instance. If you specify multiple users, separate the usernames with commas (,).
mask String
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.
option String
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.

Import

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

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

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud