Alibaba Cloud v3.57.1, Jun 26 24

Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi

alicloud.rds.RdsCloneDbInstance

Explore with Pulumi AI

Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-alicloud

Example Usage

Create an RDS MySQL clone 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 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",
    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 exampleRdsBackup = new alicloud.rds.RdsBackup("example", {
    dbInstanceId: exampleInstance.id,
    removeFromState: true,
});
const exampleRdsCloneDbInstance = new alicloud.rds.RdsCloneDbInstance("example", {
    sourceDbInstanceId: exampleInstance.id,
    dbInstanceStorageType: "cloud_essd",
    paymentType: "PayAsYouGo",
    backupId: exampleRdsBackup.backupId,
});

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_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",
    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_backup = alicloud.rds.RdsBackup("example",
    db_instance_id=example_instance.id,
    remove_from_state=True)
example_rds_clone_db_instance = alicloud.rds.RdsCloneDbInstance("example",
    source_db_instance_id=example_instance.id,
    db_instance_storage_type="cloud_essd",
    payment_type="PayAsYouGo",
    backup_id=example_rds_backup.backup_id)

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
		}
		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"),
			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
		}
		exampleRdsBackup, err := rds.NewRdsBackup(ctx, "example", &rds.RdsBackupArgs{
			DbInstanceId:    exampleInstance.ID(),
			RemoveFromState: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewRdsCloneDbInstance(ctx, "example", &rds.RdsCloneDbInstanceArgs{
			SourceDbInstanceId:    exampleInstance.ID(),
			DbInstanceStorageType: pulumi.String("cloud_essd"),
			PaymentType:           pulumi.String("PayAsYouGo"),
			BackupId:              exampleRdsBackup.BackupId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 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",
        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 exampleRdsBackup = new AliCloud.Rds.RdsBackup("example", new()
    {
        DbInstanceId = exampleInstance.Id,
        RemoveFromState = true,
    });

    var exampleRdsCloneDbInstance = new AliCloud.Rds.RdsCloneDbInstance("example", new()
    {
        SourceDbInstanceId = exampleInstance.Id,
        DbInstanceStorageType = "cloud_essd",
        PaymentType = "PayAsYouGo",
        BackupId = exampleRdsBackup.BackupId,
    });

});

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.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.RdsBackup;
import com.pulumi.alicloud.rds.RdsBackupArgs;
import com.pulumi.alicloud.rds.RdsCloneDbInstance;
import com.pulumi.alicloud.rds.RdsCloneDbInstanceArgs;
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());

        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")
            .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 exampleRdsBackup = new RdsBackup("exampleRdsBackup", RdsBackupArgs.builder()
            .dbInstanceId(exampleInstance.id())
            .removeFromState("true")
            .build());

        var exampleRdsCloneDbInstance = new RdsCloneDbInstance("exampleRdsCloneDbInstance", RdsCloneDbInstanceArgs.builder()
            .sourceDbInstanceId(exampleInstance.id())
            .dbInstanceStorageType("cloud_essd")
            .paymentType("PayAsYouGo")
            .backupId(exampleRdsBackup.backupId())
            .build());

    }
}

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'
      instanceType: ${exampleGetInstanceClasses.instanceClasses[0].instanceClass}
      instanceStorage: ${exampleGetInstanceClasses.instanceClasses[0].storageRange.min}
      instanceChargeType: Postpaid
      instanceName: terraform-example
      vswitchId: ${exampleSwitch.id}
      monitoringPeriod: '60'
  exampleRdsBackup:
    type: alicloud:rds:RdsBackup
    name: example
    properties:
      dbInstanceId: ${exampleInstance.id}
      removeFromState: 'true'
  exampleRdsCloneDbInstance:
    type: alicloud:rds:RdsCloneDbInstance
    name: example
    properties:
      sourceDbInstanceId: ${exampleInstance.id}
      dbInstanceStorageType: cloud_essd
      paymentType: PayAsYouGo
      backupId: ${exampleRdsBackup.backupId}
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

Create RdsCloneDbInstance Resource

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

Constructor syntax

new RdsCloneDbInstance(name: string, args: RdsCloneDbInstanceArgs, opts?: CustomResourceOptions);

@overload
def RdsCloneDbInstance(resource_name: str,
                       args: RdsCloneDbInstanceArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def RdsCloneDbInstance(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       db_instance_storage_type: Optional[str] = None,
                       source_db_instance_id: Optional[str] = None,
                       payment_type: Optional[str] = None,
                       parameters: Optional[Sequence[RdsCloneDbInstanceParameterArgs]] = None,
                       client_ca_cert: Optional[str] = None,
                       backup_id: Optional[str] = None,
                       certificate: Optional[str] = None,
                       period: Optional[str] = None,
                       client_ca_enabled: Optional[int] = None,
                       client_cert_revocation_list: Optional[str] = None,
                       client_crl_enabled: Optional[int] = 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,
                       backup_type: Optional[str] = None,
                       db_name: Optional[str] = None,
                       db_names: 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,
                       pg_hba_confs: Optional[Sequence[RdsCloneDbInstancePgHbaConfArgs]] = None,
                       maintain_time: Optional[str] = None,
                       acl: Optional[str] = None,
                       password: Optional[str] = None,
                       category: Optional[str] = None,
                       ca_type: Optional[str] = None,
                       instance_network_type: Optional[str] = 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,
                       restore_table: Optional[str] = None,
                       restore_time: Optional[str] = None,
                       role_arn: Optional[str] = None,
                       security_ips: Optional[Sequence[str]] = None,
                       server_cert: Optional[str] = None,
                       server_key: Optional[str] = None,
                       serverless_configs: Optional[Sequence[RdsCloneDbInstanceServerlessConfigArgs]] = None,
                       source_biz: Optional[str] = None,
                       auto_upgrade_minor_version: Optional[str] = None,
                       ssl_enabled: Optional[int] = None,
                       switch_time: Optional[str] = None,
                       sync_mode: Optional[str] = None,
                       table_meta: Optional[str] = None,
                       tcp_connection_type: Optional[str] = None,
                       tde_status: Optional[str] = None,
                       used_time: Optional[int] = None,
                       vpc_id: Optional[str] = None,
                       vswitch_id: Optional[str] = None,
                       zone_id: Optional[str] = None,
                       zone_id_slave_a: Optional[str] = None,
                       zone_id_slave_b: Optional[str] = None)

func NewRdsCloneDbInstance(ctx *Context, name string, args RdsCloneDbInstanceArgs, opts ...ResourceOption) (*RdsCloneDbInstance, error)

public RdsCloneDbInstance(string name, RdsCloneDbInstanceArgs args, CustomResourceOptions? opts = null)

public RdsCloneDbInstance(String name, RdsCloneDbInstanceArgs args)
public RdsCloneDbInstance(String name, RdsCloneDbInstanceArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args RdsCloneDbInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args RdsCloneDbInstanceArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RdsCloneDbInstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RdsCloneDbInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RdsCloneDbInstanceArgs: 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 rdsCloneDbInstanceResource = new AliCloud.Rds.RdsCloneDbInstance("rdsCloneDbInstanceResource", new()
{
    DbInstanceStorageType = "string",
    SourceDbInstanceId = "string",
    PaymentType = "string",
    Parameters = new[]
    {
        new AliCloud.Rds.Inputs.RdsCloneDbInstanceParameterArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    ClientCaCert = "string",
    BackupId = "string",
    Certificate = "string",
    Period = "string",
    ClientCaEnabled = 0,
    ClientCertRevocationList = "string",
    ClientCrlEnabled = 0,
    ConnectionStringPrefix = "string",
    DbInstanceClass = "string",
    DbInstanceDescription = "string",
    DbInstanceStorage = 0,
    BackupType = "string",
    DbName = "string",
    DbNames = "string",
    DedicatedHostGroupId = "string",
    DeletionProtection = false,
    Direction = "string",
    EffectiveTime = "string",
    EncryptionKey = "string",
    Engine = "string",
    EngineVersion = "string",
    ForceRestart = false,
    HaMode = "string",
    PgHbaConfs = new[]
    {
        new AliCloud.Rds.Inputs.RdsCloneDbInstancePgHbaConfArgs
        {
            Address = "string",
            Database = "string",
            Method = "string",
            PriorityId = 0,
            Type = "string",
            User = "string",
            Mask = "string",
            Option = "string",
        },
    },
    MaintainTime = "string",
    Acl = "string",
    Password = "string",
    Category = "string",
    CaType = "string",
    InstanceNetworkType = "string",
    Port = "string",
    PrivateIpAddress = "string",
    PrivateKey = "string",
    ReleasedKeepPolicy = "string",
    ReplicationAcl = "string",
    ResourceGroupId = "string",
    RestoreTable = "string",
    RestoreTime = "string",
    RoleArn = "string",
    SecurityIps = new[]
    {
        "string",
    },
    ServerCert = "string",
    ServerKey = "string",
    ServerlessConfigs = new[]
    {
        new AliCloud.Rds.Inputs.RdsCloneDbInstanceServerlessConfigArgs
        {
            MaxCapacity = 0,
            MinCapacity = 0,
            AutoPause = false,
            SwitchForce = false,
        },
    },
    SourceBiz = "string",
    AutoUpgradeMinorVersion = "string",
    SslEnabled = 0,
    SwitchTime = "string",
    SyncMode = "string",
    TableMeta = "string",
    TcpConnectionType = "string",
    TdeStatus = "string",
    UsedTime = 0,
    VpcId = "string",
    VswitchId = "string",
    ZoneId = "string",
    ZoneIdSlaveA = "string",
    ZoneIdSlaveB = "string",
});

example, err := rds.NewRdsCloneDbInstance(ctx, "rdsCloneDbInstanceResource", &rds.RdsCloneDbInstanceArgs{
	DbInstanceStorageType: pulumi.String("string"),
	SourceDbInstanceId:    pulumi.String("string"),
	PaymentType:           pulumi.String("string"),
	Parameters: rds.RdsCloneDbInstanceParameterArray{
		&rds.RdsCloneDbInstanceParameterArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	ClientCaCert:             pulumi.String("string"),
	BackupId:                 pulumi.String("string"),
	Certificate:              pulumi.String("string"),
	Period:                   pulumi.String("string"),
	ClientCaEnabled:          pulumi.Int(0),
	ClientCertRevocationList: pulumi.String("string"),
	ClientCrlEnabled:         pulumi.Int(0),
	ConnectionStringPrefix:   pulumi.String("string"),
	DbInstanceClass:          pulumi.String("string"),
	DbInstanceDescription:    pulumi.String("string"),
	DbInstanceStorage:        pulumi.Int(0),
	BackupType:               pulumi.String("string"),
	DbName:                   pulumi.String("string"),
	DbNames:                  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"),
	PgHbaConfs: rds.RdsCloneDbInstancePgHbaConfArray{
		&rds.RdsCloneDbInstancePgHbaConfArgs{
			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"),
		},
	},
	MaintainTime:        pulumi.String("string"),
	Acl:                 pulumi.String("string"),
	Password:            pulumi.String("string"),
	Category:            pulumi.String("string"),
	CaType:              pulumi.String("string"),
	InstanceNetworkType: pulumi.String("string"),
	Port:                pulumi.String("string"),
	PrivateIpAddress:    pulumi.String("string"),
	PrivateKey:          pulumi.String("string"),
	ReleasedKeepPolicy:  pulumi.String("string"),
	ReplicationAcl:      pulumi.String("string"),
	ResourceGroupId:     pulumi.String("string"),
	RestoreTable:        pulumi.String("string"),
	RestoreTime:         pulumi.String("string"),
	RoleArn:             pulumi.String("string"),
	SecurityIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServerCert: pulumi.String("string"),
	ServerKey:  pulumi.String("string"),
	ServerlessConfigs: rds.RdsCloneDbInstanceServerlessConfigArray{
		&rds.RdsCloneDbInstanceServerlessConfigArgs{
			MaxCapacity: pulumi.Float64(0),
			MinCapacity: pulumi.Float64(0),
			AutoPause:   pulumi.Bool(false),
			SwitchForce: pulumi.Bool(false),
		},
	},
	SourceBiz:               pulumi.String("string"),
	AutoUpgradeMinorVersion: pulumi.String("string"),
	SslEnabled:              pulumi.Int(0),
	SwitchTime:              pulumi.String("string"),
	SyncMode:                pulumi.String("string"),
	TableMeta:               pulumi.String("string"),
	TcpConnectionType:       pulumi.String("string"),
	TdeStatus:               pulumi.String("string"),
	UsedTime:                pulumi.Int(0),
	VpcId:                   pulumi.String("string"),
	VswitchId:               pulumi.String("string"),
	ZoneId:                  pulumi.String("string"),
	ZoneIdSlaveA:            pulumi.String("string"),
	ZoneIdSlaveB:            pulumi.String("string"),
})

var rdsCloneDbInstanceResource = new RdsCloneDbInstance("rdsCloneDbInstanceResource", RdsCloneDbInstanceArgs.builder()
    .dbInstanceStorageType("string")
    .sourceDbInstanceId("string")
    .paymentType("string")
    .parameters(RdsCloneDbInstanceParameterArgs.builder()
        .name("string")
        .value("string")
        .build())
    .clientCaCert("string")
    .backupId("string")
    .certificate("string")
    .period("string")
    .clientCaEnabled(0)
    .clientCertRevocationList("string")
    .clientCrlEnabled(0)
    .connectionStringPrefix("string")
    .dbInstanceClass("string")
    .dbInstanceDescription("string")
    .dbInstanceStorage(0)
    .backupType("string")
    .dbName("string")
    .dbNames("string")
    .dedicatedHostGroupId("string")
    .deletionProtection(false)
    .direction("string")
    .effectiveTime("string")
    .encryptionKey("string")
    .engine("string")
    .engineVersion("string")
    .forceRestart(false)
    .haMode("string")
    .pgHbaConfs(RdsCloneDbInstancePgHbaConfArgs.builder()
        .address("string")
        .database("string")
        .method("string")
        .priorityId(0)
        .type("string")
        .user("string")
        .mask("string")
        .option("string")
        .build())
    .maintainTime("string")
    .acl("string")
    .password("string")
    .category("string")
    .caType("string")
    .instanceNetworkType("string")
    .port("string")
    .privateIpAddress("string")
    .privateKey("string")
    .releasedKeepPolicy("string")
    .replicationAcl("string")
    .resourceGroupId("string")
    .restoreTable("string")
    .restoreTime("string")
    .roleArn("string")
    .securityIps("string")
    .serverCert("string")
    .serverKey("string")
    .serverlessConfigs(RdsCloneDbInstanceServerlessConfigArgs.builder()
        .maxCapacity(0)
        .minCapacity(0)
        .autoPause(false)
        .switchForce(false)
        .build())
    .sourceBiz("string")
    .autoUpgradeMinorVersion("string")
    .sslEnabled(0)
    .switchTime("string")
    .syncMode("string")
    .tableMeta("string")
    .tcpConnectionType("string")
    .tdeStatus("string")
    .usedTime(0)
    .vpcId("string")
    .vswitchId("string")
    .zoneId("string")
    .zoneIdSlaveA("string")
    .zoneIdSlaveB("string")
    .build());

rds_clone_db_instance_resource = alicloud.rds.RdsCloneDbInstance("rdsCloneDbInstanceResource",
    db_instance_storage_type="string",
    source_db_instance_id="string",
    payment_type="string",
    parameters=[alicloud.rds.RdsCloneDbInstanceParameterArgs(
        name="string",
        value="string",
    )],
    client_ca_cert="string",
    backup_id="string",
    certificate="string",
    period="string",
    client_ca_enabled=0,
    client_cert_revocation_list="string",
    client_crl_enabled=0,
    connection_string_prefix="string",
    db_instance_class="string",
    db_instance_description="string",
    db_instance_storage=0,
    backup_type="string",
    db_name="string",
    db_names="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",
    pg_hba_confs=[alicloud.rds.RdsCloneDbInstancePgHbaConfArgs(
        address="string",
        database="string",
        method="string",
        priority_id=0,
        type="string",
        user="string",
        mask="string",
        option="string",
    )],
    maintain_time="string",
    acl="string",
    password="string",
    category="string",
    ca_type="string",
    instance_network_type="string",
    port="string",
    private_ip_address="string",
    private_key="string",
    released_keep_policy="string",
    replication_acl="string",
    resource_group_id="string",
    restore_table="string",
    restore_time="string",
    role_arn="string",
    security_ips=["string"],
    server_cert="string",
    server_key="string",
    serverless_configs=[alicloud.rds.RdsCloneDbInstanceServerlessConfigArgs(
        max_capacity=0,
        min_capacity=0,
        auto_pause=False,
        switch_force=False,
    )],
    source_biz="string",
    auto_upgrade_minor_version="string",
    ssl_enabled=0,
    switch_time="string",
    sync_mode="string",
    table_meta="string",
    tcp_connection_type="string",
    tde_status="string",
    used_time=0,
    vpc_id="string",
    vswitch_id="string",
    zone_id="string",
    zone_id_slave_a="string",
    zone_id_slave_b="string")

const rdsCloneDbInstanceResource = new alicloud.rds.RdsCloneDbInstance("rdsCloneDbInstanceResource", {
    dbInstanceStorageType: "string",
    sourceDbInstanceId: "string",
    paymentType: "string",
    parameters: [{
        name: "string",
        value: "string",
    }],
    clientCaCert: "string",
    backupId: "string",
    certificate: "string",
    period: "string",
    clientCaEnabled: 0,
    clientCertRevocationList: "string",
    clientCrlEnabled: 0,
    connectionStringPrefix: "string",
    dbInstanceClass: "string",
    dbInstanceDescription: "string",
    dbInstanceStorage: 0,
    backupType: "string",
    dbName: "string",
    dbNames: "string",
    dedicatedHostGroupId: "string",
    deletionProtection: false,
    direction: "string",
    effectiveTime: "string",
    encryptionKey: "string",
    engine: "string",
    engineVersion: "string",
    forceRestart: false,
    haMode: "string",
    pgHbaConfs: [{
        address: "string",
        database: "string",
        method: "string",
        priorityId: 0,
        type: "string",
        user: "string",
        mask: "string",
        option: "string",
    }],
    maintainTime: "string",
    acl: "string",
    password: "string",
    category: "string",
    caType: "string",
    instanceNetworkType: "string",
    port: "string",
    privateIpAddress: "string",
    privateKey: "string",
    releasedKeepPolicy: "string",
    replicationAcl: "string",
    resourceGroupId: "string",
    restoreTable: "string",
    restoreTime: "string",
    roleArn: "string",
    securityIps: ["string"],
    serverCert: "string",
    serverKey: "string",
    serverlessConfigs: [{
        maxCapacity: 0,
        minCapacity: 0,
        autoPause: false,
        switchForce: false,
    }],
    sourceBiz: "string",
    autoUpgradeMinorVersion: "string",
    sslEnabled: 0,
    switchTime: "string",
    syncMode: "string",
    tableMeta: "string",
    tcpConnectionType: "string",
    tdeStatus: "string",
    usedTime: 0,
    vpcId: "string",
    vswitchId: "string",
    zoneId: "string",
    zoneIdSlaveA: "string",
    zoneIdSlaveB: "string",
});

type: alicloud:rds:RdsCloneDbInstance
properties:
    acl: string
    autoUpgradeMinorVersion: string
    backupId: string
    backupType: string
    caType: string
    category: string
    certificate: string
    clientCaCert: string
    clientCaEnabled: 0
    clientCertRevocationList: string
    clientCrlEnabled: 0
    connectionStringPrefix: string
    dbInstanceClass: string
    dbInstanceDescription: string
    dbInstanceStorage: 0
    dbInstanceStorageType: string
    dbName: string
    dbNames: 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
    period: 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
    restoreTable: string
    restoreTime: string
    roleArn: string
    securityIps:
        - string
    serverCert: string
    serverKey: string
    serverlessConfigs:
        - autoPause: false
          maxCapacity: 0
          minCapacity: 0
          switchForce: false
    sourceBiz: string
    sourceDbInstanceId: string
    sslEnabled: 0
    switchTime: string
    syncMode: string
    tableMeta: string
    tcpConnectionType: string
    tdeStatus: string
    usedTime: 0
    vpcId: string
    vswitchId: string
    zoneId: string
    zoneIdSlaveA: string
    zoneIdSlaveB: string

RdsCloneDbInstance Resource Properties

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

Inputs

The RdsCloneDbInstance resource accepts the following input properties:

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

PaymentType string

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

SourceDbInstanceId string

The source db instance id.

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.

BackupId string

The ID of the data backup file you want to use. You can call the DescribeBackups operation to query the most recent data backup file list.

NOTE: You must specify at least one of the BackupId and RestoreTime parameters. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

BackupType string

The type of backup that is used to restore the data of the original instance. Valid values:

FullBackup: full backup
IncrementalBackup: incremental backup

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.

Category string

Instance series. Valid values:

Basic: Basic Edition
HighAvailability: High availability
AlwaysOn: Cluster Edition
Finance: Three-node Enterprise Edition.
serverless_basic: Serverless Basic Edition. (Available in 1.200.0+)
serverless_standard: MySQL Serverless High Availability Edition. (Available in 1.207.0+)
serverless_ha: SQLServer Serverless High Availability Edition. (Available in 1.207.0+)
cluster: MySQL Cluster Edition. (Available in 1.207.0+)

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.

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.

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.

DbNames string

The names of the databases that you want to create on the new instance.

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 string

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

EngineVersion 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 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.RdsCloneDbInstanceParameter>

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.

Period string

The period. Valid values: Month, Year.

NOTE: If you set the payment_type parameter to Subscription, you must specify the period parameter.

PgHbaConfs List<Pulumi.AliCloud.Rds.Inputs.RdsCloneDbInstancePgHbaConf>

The details of the 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.

RestoreTable string

Specifies whether to restore only the databases and tables that you specify. The value 1 specifies to restore only the specified databases and tables. If you do not want to restore only the specified databases or tables, you can choose not to specify this parameter.

RestoreTime string

The point in time to which you want to restore the data of the original instance. The point in time must fall within the specified log backup retention period. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

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.

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.

ServerlessConfigs List<Pulumi.AliCloud.Rds.Inputs.RdsCloneDbInstanceServerlessConfig>

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

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.

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.

TableMeta string

The information about the databases and tables that you want to restore. Format: [{"type":"db","name":"The original name of Database 1","newname":"The new name of Database 1","tables":[{"type":"table","name":"The original name of Table 1 in Database 1","newname":"The new name of Table 1 in Database 1"},{"type":"table","name":"The original name of Table 2 in Database 1","newname":"The new name of Table 2 in Database 1"}]},{"type":"db","name":"The original name of Database 2","newname":"The new name of Database 2","tables":[{"type":"table","name":"The original name of Table 1 in Database 2","newname":"The new name of Table 1 in Database 2"},{"type":"table","name":"The original name of Table 2 in Database 2","newname":"The new name of Table 2 in Database 2"}]}]

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
Disabled

UsedTime int

The subscription period of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:

If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 3.
If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.

NOTE: If you set the payment_type parameter to Subscription, you must specify the used_time parameter.

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. If there are multiple vswitches, separate them with commas. The first vswitch is a primary zone switch and the query only returns that vswitch. If there are multiple vswitches, do not perform vswitch_id check.

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

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

ZoneIdSlaveA string

The region ID of the secondary instance if you create a secondary instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.

ZoneIdSlaveB string

The region ID of the log instance if you create a log instance. If you set this parameter to the same value as the ZoneId parameter, the instance is deployed in a single zone. Otherwise, the instance is deployed in multiple zones.

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

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

PaymentType string

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

SourceDbInstanceId string

The source db instance id.

Acl string

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.

BackupId string

The ID of the data backup file you want to use. You can call the DescribeBackups operation to query the most recent data backup file list.

NOTE: You must specify at least one of the BackupId and RestoreTime parameters. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

BackupType string

The type of backup that is used to restore the data of the original instance. Valid values:

FullBackup: full backup
IncrementalBackup: incremental backup

CaType string

aliyun: using cloud certificates
custom: use a custom certificate. Valid values: aliyun, custom.

Category string

Instance series. Valid values:

Basic: Basic Edition
HighAvailability: High availability
AlwaysOn: Cluster Edition
Finance: Three-node Enterprise Edition.
serverless_basic: Serverless Basic Edition. (Available in 1.200.0+)
serverless_standard: MySQL Serverless High Availability Edition. (Available in 1.207.0+)
serverless_ha: SQLServer Serverless High Availability Edition. (Available in 1.207.0+)
cluster: MySQL Cluster Edition. (Available in 1.207.0+)

Certificate string

The file that contains the certificate used for TDE.

ClientCaCert string

ClientCaEnabled int

The client ca enabled.

ClientCertRevocationList string

ClientCrlEnabled int

The client crl enabled.

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.

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.

DbNames string

The names of the databases that you want to create on the new instance.

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 string

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

EngineVersion 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 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 []RdsCloneDbInstanceParameterArgs

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.

Period string

The period. Valid values: Month, Year.

NOTE: If you set the payment_type parameter to Subscription, you must specify the period parameter.

PgHbaConfs []RdsCloneDbInstancePgHbaConfArgs

The details of the 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

ResourceGroupId string

The resource group id.

RestoreTable string

RestoreTime string

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.

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.

ServerlessConfigs []RdsCloneDbInstanceServerlessConfigArgs

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.

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.

TableMeta string

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
Disabled

UsedTime int

The subscription period of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:

If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 3.
If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.

NOTE: If you set the payment_type parameter to Subscription, you must specify the used_time parameter.

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

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

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

ZoneIdSlaveA string

ZoneIdSlaveB string

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

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

paymentType String

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

sourceDbInstanceId String

The source db instance id.

acl String

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.

backupId String

The ID of the data backup file you want to use. You can call the DescribeBackups operation to query the most recent data backup file list.

NOTE: You must specify at least one of the BackupId and RestoreTime parameters. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

backupType String

The type of backup that is used to restore the data of the original instance. Valid values:

FullBackup: full backup
IncrementalBackup: incremental backup

caType String

aliyun: using cloud certificates
custom: use a custom certificate. Valid values: aliyun, custom.

category String

Instance series. Valid values:

Basic: Basic Edition
HighAvailability: High availability
AlwaysOn: Cluster Edition
Finance: Three-node Enterprise Edition.
serverless_basic: Serverless Basic Edition. (Available in 1.200.0+)
serverless_standard: MySQL Serverless High Availability Edition. (Available in 1.207.0+)
serverless_ha: SQLServer Serverless High Availability Edition. (Available in 1.207.0+)
cluster: MySQL Cluster Edition. (Available in 1.207.0+)

certificate String

The file that contains the certificate used for TDE.

clientCaCert String

clientCaEnabled Integer

The client ca enabled.

clientCertRevocationList String

clientCrlEnabled Integer

The client crl enabled.

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.

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.

dbNames String

The names of the databases that you want to create on the new instance.

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 String

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

engineVersion 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 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<RdsCloneDbInstanceParameter>

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.

period String

The period. Valid values: Month, Year.

NOTE: If you set the payment_type parameter to Subscription, you must specify the period parameter.

pgHbaConfs List<RdsCloneDbInstancePgHbaConf>

The details of the 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

resourceGroupId String

The resource group id.

restoreTable String

restoreTime String

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.

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.

serverlessConfigs List<RdsCloneDbInstanceServerlessConfig>

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.

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.

tableMeta String

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
Disabled

usedTime Integer

The subscription period of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:

If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 3.
If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.

NOTE: If you set the payment_type parameter to Subscription, you must specify the used_time parameter.

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

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

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

zoneIdSlaveA String

zoneIdSlaveB String

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

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

paymentType string

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

sourceDbInstanceId string

The source db instance id.

acl string

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.

backupId string

The ID of the data backup file you want to use. You can call the DescribeBackups operation to query the most recent data backup file list.

NOTE: You must specify at least one of the BackupId and RestoreTime parameters. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

backupType string

The type of backup that is used to restore the data of the original instance. Valid values:

FullBackup: full backup
IncrementalBackup: incremental backup

caType string

aliyun: using cloud certificates
custom: use a custom certificate. Valid values: aliyun, custom.

category string

Instance series. Valid values:

Basic: Basic Edition
HighAvailability: High availability
AlwaysOn: Cluster Edition
Finance: Three-node Enterprise Edition.
serverless_basic: Serverless Basic Edition. (Available in 1.200.0+)
serverless_standard: MySQL Serverless High Availability Edition. (Available in 1.207.0+)
serverless_ha: SQLServer Serverless High Availability Edition. (Available in 1.207.0+)
cluster: MySQL Cluster Edition. (Available in 1.207.0+)

certificate string

The file that contains the certificate used for TDE.

clientCaCert string

clientCaEnabled number

The client ca enabled.

clientCertRevocationList string

clientCrlEnabled number

The client crl enabled.

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.

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.

dbNames string

The names of the databases that you want to create on the new instance.

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 string

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

engineVersion 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 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 RdsCloneDbInstanceParameter[]

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.

period string

The period. Valid values: Month, Year.

NOTE: If you set the payment_type parameter to Subscription, you must specify the period parameter.

pgHbaConfs RdsCloneDbInstancePgHbaConf[]

The details of the 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

resourceGroupId string

The resource group id.

restoreTable string

restoreTime string

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.

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.

serverlessConfigs RdsCloneDbInstanceServerlessConfig[]

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.

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.

tableMeta string

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
Disabled

usedTime number

The subscription period of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:

If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 3.
If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.

NOTE: If you set the payment_type parameter to Subscription, you must specify the used_time parameter.

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

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

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

zoneIdSlaveA string

zoneIdSlaveB string

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

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

payment_type str

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

source_db_instance_id str

The source db instance id.

acl str

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.

backup_id str

The ID of the data backup file you want to use. You can call the DescribeBackups operation to query the most recent data backup file list.

NOTE: You must specify at least one of the BackupId and RestoreTime parameters. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

backup_type str

The type of backup that is used to restore the data of the original instance. Valid values:

FullBackup: full backup
IncrementalBackup: incremental backup

ca_type str

aliyun: using cloud certificates
custom: use a custom certificate. Valid values: aliyun, custom.

category str

Instance series. Valid values:

Basic: Basic Edition
HighAvailability: High availability
AlwaysOn: Cluster Edition
Finance: Three-node Enterprise Edition.
serverless_basic: Serverless Basic Edition. (Available in 1.200.0+)
serverless_standard: MySQL Serverless High Availability Edition. (Available in 1.207.0+)
serverless_ha: SQLServer Serverless High Availability Edition. (Available in 1.207.0+)
cluster: MySQL Cluster Edition. (Available in 1.207.0+)

certificate str

The file that contains the certificate used for TDE.

client_ca_cert str

client_ca_enabled int

The client ca enabled.

client_cert_revocation_list str

client_crl_enabled int

The client crl enabled.

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

db_names str

The names of the databases that you want to create on the new instance.

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 str

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

engine_version 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 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[RdsCloneDbInstanceParameterArgs]

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.

period str

The period. Valid values: Month, Year.

NOTE: If you set the payment_type parameter to Subscription, you must specify the period parameter.

pg_hba_confs Sequence[RdsCloneDbInstancePgHbaConfArgs]

The details of the 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

resource_group_id str

The resource group id.

restore_table str

restore_time str

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.

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.

serverless_configs Sequence[RdsCloneDbInstanceServerlessConfigArgs]

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.

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.

table_meta str

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
Disabled

used_time int

The subscription period of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:

If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 3.
If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.

NOTE: If you set the payment_type parameter to Subscription, you must specify the used_time parameter.

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

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

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

zone_id_slave_a str

zone_id_slave_b str

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

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

paymentType String

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

sourceDbInstanceId String

The source db instance id.

acl String

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.

backupId String

The ID of the data backup file you want to use. You can call the DescribeBackups operation to query the most recent data backup file list.

NOTE: You must specify at least one of the BackupId and RestoreTime parameters. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

backupType String

The type of backup that is used to restore the data of the original instance. Valid values:

FullBackup: full backup
IncrementalBackup: incremental backup

caType String

aliyun: using cloud certificates
custom: use a custom certificate. Valid values: aliyun, custom.

category String

Instance series. Valid values:

Basic: Basic Edition
HighAvailability: High availability
AlwaysOn: Cluster Edition
Finance: Three-node Enterprise Edition.
serverless_basic: Serverless Basic Edition. (Available in 1.200.0+)
serverless_standard: MySQL Serverless High Availability Edition. (Available in 1.207.0+)
serverless_ha: SQLServer Serverless High Availability Edition. (Available in 1.207.0+)
cluster: MySQL Cluster Edition. (Available in 1.207.0+)

certificate String

The file that contains the certificate used for TDE.

clientCaCert String

clientCaEnabled Number

The client ca enabled.

clientCertRevocationList String

clientCrlEnabled Number

The client crl enabled.

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.

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.

dbNames String

The names of the databases that you want to create on the new instance.

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 String

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

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

period String

The period. Valid values: Month, Year.

NOTE: If you set the payment_type parameter to Subscription, you must specify the period parameter.

pgHbaConfs List<Property Map>

The details of the 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

resourceGroupId String

The resource group id.

restoreTable String

restoreTime String

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.

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.

serverlessConfigs List<Property Map>

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.

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.

tableMeta String

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
Disabled

usedTime Number

The subscription period of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:

If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 3.
If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.

NOTE: If you set the payment_type parameter to Subscription, you must specify the used_time parameter.

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

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

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

zoneIdSlaveA String

zoneIdSlaveB String

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

Outputs

All input properties are implicitly available as output properties. Additionally, the RdsCloneDbInstance 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 RdsCloneDbInstance Resource

Get an existing RdsCloneDbInstance 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?: RdsCloneDbInstanceState, opts?: CustomResourceOptions): RdsCloneDbInstance

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acl: Optional[str] = None,
        auto_upgrade_minor_version: Optional[str] = None,
        backup_id: Optional[str] = None,
        backup_type: Optional[str] = None,
        ca_type: Optional[str] = None,
        category: 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,
        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,
        db_names: 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[RdsCloneDbInstanceParameterArgs]] = None,
        password: Optional[str] = None,
        payment_type: Optional[str] = None,
        period: Optional[str] = None,
        pg_hba_confs: Optional[Sequence[RdsCloneDbInstancePgHbaConfArgs]] = 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,
        restore_table: Optional[str] = None,
        restore_time: Optional[str] = None,
        role_arn: Optional[str] = None,
        security_ips: Optional[Sequence[str]] = None,
        server_cert: Optional[str] = None,
        server_key: Optional[str] = None,
        serverless_configs: Optional[Sequence[RdsCloneDbInstanceServerlessConfigArgs]] = None,
        source_biz: Optional[str] = None,
        source_db_instance_id: Optional[str] = None,
        ssl_enabled: Optional[int] = None,
        switch_time: Optional[str] = None,
        sync_mode: Optional[str] = None,
        table_meta: Optional[str] = None,
        tcp_connection_type: Optional[str] = None,
        tde_status: Optional[str] = None,
        used_time: Optional[int] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_id: Optional[str] = None,
        zone_id_slave_a: Optional[str] = None,
        zone_id_slave_b: Optional[str] = None) -> RdsCloneDbInstance

func GetRdsCloneDbInstance(ctx *Context, name string, id IDInput, state *RdsCloneDbInstanceState, opts ...ResourceOption) (*RdsCloneDbInstance, error)

public static RdsCloneDbInstance Get(string name, Input<string> id, RdsCloneDbInstanceState? state, CustomResourceOptions? opts = null)

public static RdsCloneDbInstance get(String name, Output<String> id, RdsCloneDbInstanceState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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

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.

BackupId string

The ID of the data backup file you want to use. You can call the DescribeBackups operation to query the most recent data backup file list.

NOTE: You must specify at least one of the BackupId and RestoreTime parameters. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

BackupType string

The type of backup that is used to restore the data of the original instance. Valid values:

FullBackup: full backup
IncrementalBackup: incremental backup

CaType string

aliyun: using cloud certificates
custom: use a custom certificate. Valid values: aliyun, custom.

Category string

Instance series. Valid values:

Basic: Basic Edition
HighAvailability: High availability
AlwaysOn: Cluster Edition
Finance: Three-node Enterprise Edition.
serverless_basic: Serverless Basic Edition. (Available in 1.200.0+)
serverless_standard: MySQL Serverless High Availability Edition. (Available in 1.207.0+)
serverless_ha: SQLServer Serverless High Availability Edition. (Available in 1.207.0+)
cluster: MySQL Cluster Edition. (Available in 1.207.0+)

Certificate string

The file that contains the certificate used for TDE.

ClientCaCert string

ClientCaEnabled int

The client ca enabled.

ClientCertRevocationList string

ClientCrlEnabled int

The client crl enabled.

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.

DbNames string

The names of the databases that you want to create on the new instance.

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 string

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

EngineVersion 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 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.RdsCloneDbInstanceParameter>

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 and Serverless.

Period string

The period. Valid values: Month, Year.

NOTE: If you set the payment_type parameter to Subscription, you must specify the period parameter.

PgHbaConfs List<Pulumi.AliCloud.Rds.Inputs.RdsCloneDbInstancePgHbaConf>

The details of the 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

ResourceGroupId string

The resource group id.

RestoreTable string

RestoreTime string

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.

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.

ServerlessConfigs List<Pulumi.AliCloud.Rds.Inputs.RdsCloneDbInstanceServerlessConfig>

SourceBiz string

The source biz.

SourceDbInstanceId string

The source db instance id.

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.

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.

TableMeta string

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
Disabled

UsedTime int

The subscription period of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:

If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 3.
If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.

NOTE: If you set the payment_type parameter to Subscription, you must specify the used_time parameter.

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

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

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

ZoneIdSlaveA string

ZoneIdSlaveB string

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

Acl string

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.

BackupId string

The ID of the data backup file you want to use. You can call the DescribeBackups operation to query the most recent data backup file list.

NOTE: You must specify at least one of the BackupId and RestoreTime parameters. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

BackupType string

The type of backup that is used to restore the data of the original instance. Valid values:

FullBackup: full backup
IncrementalBackup: incremental backup

CaType string

aliyun: using cloud certificates
custom: use a custom certificate. Valid values: aliyun, custom.

Category string

Instance series. Valid values:

Basic: Basic Edition
HighAvailability: High availability
AlwaysOn: Cluster Edition
Finance: Three-node Enterprise Edition.
serverless_basic: Serverless Basic Edition. (Available in 1.200.0+)
serverless_standard: MySQL Serverless High Availability Edition. (Available in 1.207.0+)
serverless_ha: SQLServer Serverless High Availability Edition. (Available in 1.207.0+)
cluster: MySQL Cluster Edition. (Available in 1.207.0+)

Certificate string

The file that contains the certificate used for TDE.

ClientCaCert string

ClientCaEnabled int

The client ca enabled.

ClientCertRevocationList string

ClientCrlEnabled int

The client crl enabled.

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.

DbNames string

The names of the databases that you want to create on the new instance.

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 string

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

EngineVersion 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 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 []RdsCloneDbInstanceParameterArgs

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 and Serverless.

Period string

The period. Valid values: Month, Year.

NOTE: If you set the payment_type parameter to Subscription, you must specify the period parameter.

PgHbaConfs []RdsCloneDbInstancePgHbaConfArgs

The details of the 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

ResourceGroupId string

The resource group id.

RestoreTable string

RestoreTime string

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.

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.

ServerlessConfigs []RdsCloneDbInstanceServerlessConfigArgs

SourceBiz string

The source biz.

SourceDbInstanceId string

The source db instance id.

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.

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.

TableMeta string

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
Disabled

UsedTime int

The subscription period of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:

If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 3.
If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.

NOTE: If you set the payment_type parameter to Subscription, you must specify the used_time parameter.

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

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

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

ZoneIdSlaveA string

ZoneIdSlaveB string

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

acl String

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.

backupId String

The ID of the data backup file you want to use. You can call the DescribeBackups operation to query the most recent data backup file list.

NOTE: You must specify at least one of the BackupId and RestoreTime parameters. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

backupType String

The type of backup that is used to restore the data of the original instance. Valid values:

FullBackup: full backup
IncrementalBackup: incremental backup

caType String

aliyun: using cloud certificates
custom: use a custom certificate. Valid values: aliyun, custom.

category String

Instance series. Valid values:

Basic: Basic Edition
HighAvailability: High availability
AlwaysOn: Cluster Edition
Finance: Three-node Enterprise Edition.
serverless_basic: Serverless Basic Edition. (Available in 1.200.0+)
serverless_standard: MySQL Serverless High Availability Edition. (Available in 1.207.0+)
serverless_ha: SQLServer Serverless High Availability Edition. (Available in 1.207.0+)
cluster: MySQL Cluster Edition. (Available in 1.207.0+)

certificate String

The file that contains the certificate used for TDE.

clientCaCert String

clientCaEnabled Integer

The client ca enabled.

clientCertRevocationList String

clientCrlEnabled Integer

The client crl enabled.

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.

dbNames String

The names of the databases that you want to create on the new instance.

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 String

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

engineVersion 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 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<RdsCloneDbInstanceParameter>

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 and Serverless.

period String

The period. Valid values: Month, Year.

NOTE: If you set the payment_type parameter to Subscription, you must specify the period parameter.

pgHbaConfs List<RdsCloneDbInstancePgHbaConf>

The details of the 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

resourceGroupId String

The resource group id.

restoreTable String

restoreTime String

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.

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.

serverlessConfigs List<RdsCloneDbInstanceServerlessConfig>

sourceBiz String

The source biz.

sourceDbInstanceId String

The source db instance id.

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.

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.

tableMeta String

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
Disabled

usedTime Integer

The subscription period of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:

If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 3.
If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.

NOTE: If you set the payment_type parameter to Subscription, you must specify the used_time parameter.

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

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

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

zoneIdSlaveA String

zoneIdSlaveB String

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

acl string

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.

backupId string

The ID of the data backup file you want to use. You can call the DescribeBackups operation to query the most recent data backup file list.

NOTE: You must specify at least one of the BackupId and RestoreTime parameters. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

backupType string

The type of backup that is used to restore the data of the original instance. Valid values:

FullBackup: full backup
IncrementalBackup: incremental backup

caType string

aliyun: using cloud certificates
custom: use a custom certificate. Valid values: aliyun, custom.

category string

Instance series. Valid values:

Basic: Basic Edition
HighAvailability: High availability
AlwaysOn: Cluster Edition
Finance: Three-node Enterprise Edition.
serverless_basic: Serverless Basic Edition. (Available in 1.200.0+)
serverless_standard: MySQL Serverless High Availability Edition. (Available in 1.207.0+)
serverless_ha: SQLServer Serverless High Availability Edition. (Available in 1.207.0+)
cluster: MySQL Cluster Edition. (Available in 1.207.0+)

certificate string

The file that contains the certificate used for TDE.

clientCaCert string

clientCaEnabled number

The client ca enabled.

clientCertRevocationList string

clientCrlEnabled number

The client crl enabled.

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.

dbNames string

The names of the databases that you want to create on the new instance.

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 string

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

engineVersion 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 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 RdsCloneDbInstanceParameter[]

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 and Serverless.

period string

The period. Valid values: Month, Year.

NOTE: If you set the payment_type parameter to Subscription, you must specify the period parameter.

pgHbaConfs RdsCloneDbInstancePgHbaConf[]

The details of the 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

resourceGroupId string

The resource group id.

restoreTable string

restoreTime string

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.

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.

serverlessConfigs RdsCloneDbInstanceServerlessConfig[]

sourceBiz string

The source biz.

sourceDbInstanceId string

The source db instance id.

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.

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.

tableMeta string

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
Disabled

usedTime number

The subscription period of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:

If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 3.
If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.

NOTE: If you set the payment_type parameter to Subscription, you must specify the used_time parameter.

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

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

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

zoneIdSlaveA string

zoneIdSlaveB string

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

acl str

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.

backup_id str

The ID of the data backup file you want to use. You can call the DescribeBackups operation to query the most recent data backup file list.

NOTE: You must specify at least one of the BackupId and RestoreTime parameters. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

backup_type str

The type of backup that is used to restore the data of the original instance. Valid values:

FullBackup: full backup
IncrementalBackup: incremental backup

ca_type str

aliyun: using cloud certificates
custom: use a custom certificate. Valid values: aliyun, custom.

category str

Instance series. Valid values:

Basic: Basic Edition
HighAvailability: High availability
AlwaysOn: Cluster Edition
Finance: Three-node Enterprise Edition.
serverless_basic: Serverless Basic Edition. (Available in 1.200.0+)
serverless_standard: MySQL Serverless High Availability Edition. (Available in 1.207.0+)
serverless_ha: SQLServer Serverless High Availability Edition. (Available in 1.207.0+)
cluster: MySQL Cluster Edition. (Available in 1.207.0+)

certificate str

The file that contains the certificate used for TDE.

client_ca_cert str

client_ca_enabled int

The client ca enabled.

client_cert_revocation_list str

client_crl_enabled int

The client crl enabled.

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.

db_names str

The names of the databases that you want to create on the new instance.

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 str

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

engine_version 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 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[RdsCloneDbInstanceParameterArgs]

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 and Serverless.

period str

The period. Valid values: Month, Year.

NOTE: If you set the payment_type parameter to Subscription, you must specify the period parameter.

pg_hba_confs Sequence[RdsCloneDbInstancePgHbaConfArgs]

The details of the 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

resource_group_id str

The resource group id.

restore_table str

restore_time str

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.

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.

serverless_configs Sequence[RdsCloneDbInstanceServerlessConfigArgs]

source_biz str

The source biz.

source_db_instance_id str

The source db instance id.

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.

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.

table_meta str

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
Disabled

used_time int

The subscription period of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:

If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 3.
If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.

NOTE: If you set the payment_type parameter to Subscription, you must specify the used_time parameter.

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

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

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

zone_id_slave_a str

zone_id_slave_b str

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

acl String

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.

backupId String

The ID of the data backup file you want to use. You can call the DescribeBackups operation to query the most recent data backup file list.

NOTE: You must specify at least one of the BackupId and RestoreTime parameters. When payment_type="Serverless" and when modifying, do not perform instance_storage check. Otherwise, check.

backupType String

The type of backup that is used to restore the data of the original instance. Valid values:

FullBackup: full backup
IncrementalBackup: incremental backup

caType String

aliyun: using cloud certificates
custom: use a custom certificate. Valid values: aliyun, custom.

category String

Instance series. Valid values:

Basic: Basic Edition
HighAvailability: High availability
AlwaysOn: Cluster Edition
Finance: Three-node Enterprise Edition.
serverless_basic: Serverless Basic Edition. (Available in 1.200.0+)
serverless_standard: MySQL Serverless High Availability Edition. (Available in 1.207.0+)
serverless_ha: SQLServer Serverless High Availability Edition. (Available in 1.207.0+)
cluster: MySQL Cluster Edition. (Available in 1.207.0+)

certificate String

The file that contains the certificate used for TDE.

clientCaCert String

clientCaEnabled Number

The client ca enabled.

clientCertRevocationList String

clientCrlEnabled Number

The client crl enabled.

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.

dbNames String

The names of the databases that you want to create on the new instance.

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 String

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

engineVersion 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 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 and Serverless.

period String

The period. Valid values: Month, Year.

NOTE: If you set the payment_type parameter to Subscription, you must specify the period parameter.

pgHbaConfs List<Property Map>

The details of the 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

resourceGroupId String

The resource group id.

restoreTable String

restoreTime String

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.

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.

serverlessConfigs List<Property Map>

sourceBiz String

The source biz.

sourceDbInstanceId String

The source db instance id.

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.

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.

tableMeta String

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
Disabled

usedTime Number

The subscription period of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:

If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 3.
If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.

NOTE: If you set the payment_type parameter to Subscription, you must specify the used_time parameter.

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

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

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

zoneIdSlaveA String

zoneIdSlaveB String

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

Supporting Types

RdsCloneDbInstanceParameter, RdsCloneDbInstanceParameterArgs

Name string: The parameters name.
Value string: The parameters value.

Name string: The parameters name.
Value string: The parameters value.

name String: The parameters name.
value String: The parameters value.

name string: The parameters name.
value string: The parameters value.

name str: The parameters name.
value str: The parameters value.

name String: The parameters name.
value String: The parameters value.

RdsCloneDbInstancePgHbaConf, RdsCloneDbInstancePgHbaConfArgs

Address 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 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 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 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 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 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 string

Database string

Method 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 int

Type 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 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

address String

database String

method 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 Integer

type 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 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

address string

database string

method 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 number

type 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 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

address str

database str

method 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 int

type 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 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

address String

database String

method 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 Number

type 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 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

RdsCloneDbInstanceServerlessConfig, RdsCloneDbInstanceServerlessConfigArgs

MaxCapacity double

The maximum number of RDS Capacity Units (RCUs). The value of this parameter must be greater than or equal to min_capacity and only supports passing integers. Valid values:

MySQL: 1~8
SQLServer: 2~8
PostgreSQL: 1~12

MinCapacity double

The minimum number of RCUs. The value of this parameter must be less than or equal to max_capacity. Valid values:

MySQL: 0.5~8
SQLServer: 2~8 (Supports integers only).
PostgreSQL: 0.5~12

AutoPause bool

Specifies whether to enable the smart startup and stop feature for the serverless instance. Valid values:

true: enables the feature.
false: disables the feature. This is the default value.

Only MySQL Serverless instances need to set this parameter. If there is no connection within 10 minutes, it will enter a paused state and automatically wake up when the connection enters.

SwitchForce bool

Specifies whether to enable the forced scaling feature for the serverless instance. Valid values:

true: enables the feature.
false: disables the feature. This is the default value.

Only MySQL Serverless instances need to set this parameter. After enabling this parameter, there will be a flash break within 1 minute when the instance is forced to expand or shrink. Please use it with caution according to the actual situation.
The elastic scaling of an instance RCU usually takes effect immediately, but in some special circumstances (such as during large transaction execution), it is not possible to complete scaling immediately. In this case, this parameter can be enabled to force scaling.

MaxCapacity float64

The maximum number of RDS Capacity Units (RCUs). The value of this parameter must be greater than or equal to min_capacity and only supports passing integers. Valid values:

MySQL: 1~8
SQLServer: 2~8
PostgreSQL: 1~12

MinCapacity float64

The minimum number of RCUs. The value of this parameter must be less than or equal to max_capacity. Valid values:

MySQL: 0.5~8
SQLServer: 2~8 (Supports integers only).
PostgreSQL: 0.5~12

AutoPause bool

Specifies whether to enable the smart startup and stop feature for the serverless instance. Valid values:

true: enables the feature.
false: disables the feature. This is the default value.

Only MySQL Serverless instances need to set this parameter. If there is no connection within 10 minutes, it will enter a paused state and automatically wake up when the connection enters.

SwitchForce bool

Specifies whether to enable the forced scaling feature for the serverless instance. Valid values:

true: enables the feature.
false: disables the feature. This is the default value.

Only MySQL Serverless instances need to set this parameter. After enabling this parameter, there will be a flash break within 1 minute when the instance is forced to expand or shrink. Please use it with caution according to the actual situation.
The elastic scaling of an instance RCU usually takes effect immediately, but in some special circumstances (such as during large transaction execution), it is not possible to complete scaling immediately. In this case, this parameter can be enabled to force scaling.

maxCapacity Double

The maximum number of RDS Capacity Units (RCUs). The value of this parameter must be greater than or equal to min_capacity and only supports passing integers. Valid values:

MySQL: 1~8
SQLServer: 2~8
PostgreSQL: 1~12

minCapacity Double

The minimum number of RCUs. The value of this parameter must be less than or equal to max_capacity. Valid values:

MySQL: 0.5~8
SQLServer: 2~8 (Supports integers only).
PostgreSQL: 0.5~12

autoPause Boolean

Specifies whether to enable the smart startup and stop feature for the serverless instance. Valid values:

true: enables the feature.
false: disables the feature. This is the default value.

Only MySQL Serverless instances need to set this parameter. If there is no connection within 10 minutes, it will enter a paused state and automatically wake up when the connection enters.

switchForce Boolean

Specifies whether to enable the forced scaling feature for the serverless instance. Valid values:

true: enables the feature.
false: disables the feature. This is the default value.

Only MySQL Serverless instances need to set this parameter. After enabling this parameter, there will be a flash break within 1 minute when the instance is forced to expand or shrink. Please use it with caution according to the actual situation.
The elastic scaling of an instance RCU usually takes effect immediately, but in some special circumstances (such as during large transaction execution), it is not possible to complete scaling immediately. In this case, this parameter can be enabled to force scaling.

maxCapacity number

The maximum number of RDS Capacity Units (RCUs). The value of this parameter must be greater than or equal to min_capacity and only supports passing integers. Valid values:

MySQL: 1~8
SQLServer: 2~8
PostgreSQL: 1~12

minCapacity number

The minimum number of RCUs. The value of this parameter must be less than or equal to max_capacity. Valid values:

MySQL: 0.5~8
SQLServer: 2~8 (Supports integers only).
PostgreSQL: 0.5~12

autoPause boolean

Specifies whether to enable the smart startup and stop feature for the serverless instance. Valid values:

true: enables the feature.
false: disables the feature. This is the default value.

Only MySQL Serverless instances need to set this parameter. If there is no connection within 10 minutes, it will enter a paused state and automatically wake up when the connection enters.

switchForce boolean

Specifies whether to enable the forced scaling feature for the serverless instance. Valid values:

true: enables the feature.
false: disables the feature. This is the default value.

Only MySQL Serverless instances need to set this parameter. After enabling this parameter, there will be a flash break within 1 minute when the instance is forced to expand or shrink. Please use it with caution according to the actual situation.
The elastic scaling of an instance RCU usually takes effect immediately, but in some special circumstances (such as during large transaction execution), it is not possible to complete scaling immediately. In this case, this parameter can be enabled to force scaling.

max_capacity float

The maximum number of RDS Capacity Units (RCUs). The value of this parameter must be greater than or equal to min_capacity and only supports passing integers. Valid values:

MySQL: 1~8
SQLServer: 2~8
PostgreSQL: 1~12

min_capacity float

The minimum number of RCUs. The value of this parameter must be less than or equal to max_capacity. Valid values:

MySQL: 0.5~8
SQLServer: 2~8 (Supports integers only).
PostgreSQL: 0.5~12

auto_pause bool

Specifies whether to enable the smart startup and stop feature for the serverless instance. Valid values:

true: enables the feature.
false: disables the feature. This is the default value.

Only MySQL Serverless instances need to set this parameter. If there is no connection within 10 minutes, it will enter a paused state and automatically wake up when the connection enters.

switch_force bool

Specifies whether to enable the forced scaling feature for the serverless instance. Valid values:

true: enables the feature.
false: disables the feature. This is the default value.

Only MySQL Serverless instances need to set this parameter. After enabling this parameter, there will be a flash break within 1 minute when the instance is forced to expand or shrink. Please use it with caution according to the actual situation.
The elastic scaling of an instance RCU usually takes effect immediately, but in some special circumstances (such as during large transaction execution), it is not possible to complete scaling immediately. In this case, this parameter can be enabled to force scaling.

maxCapacity Number

The maximum number of RDS Capacity Units (RCUs). The value of this parameter must be greater than or equal to min_capacity and only supports passing integers. Valid values:

MySQL: 1~8
SQLServer: 2~8
PostgreSQL: 1~12

minCapacity Number

The minimum number of RCUs. The value of this parameter must be less than or equal to max_capacity. Valid values:

MySQL: 0.5~8
SQLServer: 2~8 (Supports integers only).
PostgreSQL: 0.5~12

autoPause Boolean

Specifies whether to enable the smart startup and stop feature for the serverless instance. Valid values:

true: enables the feature.
false: disables the feature. This is the default value.

Only MySQL Serverless instances need to set this parameter. If there is no connection within 10 minutes, it will enter a paused state and automatically wake up when the connection enters.

switchForce Boolean

Specifies whether to enable the forced scaling feature for the serverless instance. Valid values:

true: enables the feature.
false: disables the feature. This is the default value.

Only MySQL Serverless instances need to set this parameter. After enabling this parameter, there will be a flash break within 1 minute when the instance is forced to expand or shrink. Please use it with caution according to the actual situation.
The elastic scaling of an instance RCU usually takes effect immediately, but in some special circumstances (such as during large transaction execution), it is not possible to complete scaling immediately. In this case, this parameter can be enabled to force scaling.

Import

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

$ pulumi import alicloud:rds/rdsCloneDbInstance:RdsCloneDbInstance example <id>

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.57.1 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-alicloud

alicloud.rds.RdsCloneDbInstance

On this page

On this page

Example Usage

Create an RDS MySQL clone instance

Create RdsCloneDbInstance Resource

Constructor syntax

Parameters

Constructor example

RdsCloneDbInstance Resource Properties

Inputs

Outputs

Look up Existing RdsCloneDbInstance Resource

Supporting Types

RdsCloneDbInstanceParameter, RdsCloneDbInstanceParameterArgs

RdsCloneDbInstancePgHbaConf, RdsCloneDbInstancePgHbaConfArgs

RdsCloneDbInstanceServerlessConfig, RdsCloneDbInstanceServerlessConfigArgs

Import

Package Details

On this page

On this page