1. Packages
  2. Packages
  3. Alibaba Cloud Provider
  4. API Docs
  5. rds
  6. Custom
Viewing docs for Alibaba Cloud v3.104.0
published on Thursday, Jun 25, 2026 by Pulumi
alicloud logo
Viewing docs for Alibaba Cloud v3.104.0
published on Thursday, Jun 25, 2026 by Pulumi

    Provides a RDS Custom resource.

    RDS dedicated host for users.

    For information about RDS Custom and how to use it, see What is Custom.

    NOTE: Available since v1.247.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const config = new pulumi.Config();
    const name = config.get("name") || "terraform-example";
    const clusterId = config.get("clusterId") || "c18c40b2b336840e2b2bbf8ab291758e2";
    const deploymentsetid = config.get("deploymentsetid") || "ds-2ze78ef5kyj9eveue92m";
    const vswtich_id = config.get("vswtich-id") || "example_vswitch";
    const vpcName = config.get("vpcName") || "beijing111";
    const exampleRegionId = config.get("exampleRegionId") || "cn-beijing";
    const description = config.get("description") || "ran_1-08_rccreatenodepool_api";
    const exampleZoneId = config.get("exampleZoneId") || "cn-beijing-h";
    const securitygroupName = config.get("securitygroupName") || "rds_custom_init_sg_cn_beijing";
    const _default = alicloud.resourcemanager.getResourceGroups({});
    const vpcId = new alicloud.vpc.Network("vpcId", {vpcName: vpcName});
    const vSwitchId = new alicloud.vpc.Switch("vSwitchId", {
        vpcId: vpcId.id,
        zoneId: exampleZoneId,
        vswitchName: vswtich_id,
        cidrBlock: "172.16.5.0/24",
    });
    const securityGroupId = new alicloud.ecs.SecurityGroup("securityGroupId", {
        vpcId: vpcId.id,
        securityGroupName: securitygroupName,
    });
    const deploymentSet = new alicloud.ecs.EcsDeploymentSet("deploymentSet", {});
    const keyPairName = new alicloud.ecs.EcsKeyPair("KeyPairName", {keyPairName: vSwitchId.id});
    const defaultCustom = new alicloud.rds.Custom("default", {
        amount: 1,
        autoRenew: false,
        period: 1,
        autoPay: true,
        instanceType: "mysql.x2.xlarge.6cm",
        dataDisks: [{
            category: "cloud_essd",
            size: 50,
            performanceLevel: "PL1",
        }],
        status: "Running",
        securityGroupIds: [securityGroupId.id],
        ioOptimized: "optimized",
        description: description,
        keyPairName: keyPairName.id,
        zoneId: exampleZoneId,
        instanceChargeType: "Prepaid",
        internetMaxBandwidthOut: 0,
        imageId: "aliyun_2_1903_x64_20G_alibase_20240628.vhd",
        securityEnhancementStrategy: "Active",
        periodUnit: "Month",
        password: "jingyiTEST@123",
        systemDisk: {
            size: "40",
            category: "cloud_essd",
        },
        hostName: "1743386110",
        createMode: "0",
        spotStrategy: "NoSpot",
        vswitchId: vSwitchId.id,
        supportCase: "eni",
        deploymentSetId: deploymentsetid,
        dryRun: false,
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "terraform-example"
    cluster_id = config.get("clusterId")
    if cluster_id is None:
        cluster_id = "c18c40b2b336840e2b2bbf8ab291758e2"
    deploymentsetid = config.get("deploymentsetid")
    if deploymentsetid is None:
        deploymentsetid = "ds-2ze78ef5kyj9eveue92m"
    vswtich_id = config.get("vswtich-id")
    if vswtich_id is None:
        vswtich_id = "example_vswitch"
    vpc_name = config.get("vpcName")
    if vpc_name is None:
        vpc_name = "beijing111"
    example_region_id = config.get("exampleRegionId")
    if example_region_id is None:
        example_region_id = "cn-beijing"
    description = config.get("description")
    if description is None:
        description = "ran_1-08_rccreatenodepool_api"
    example_zone_id = config.get("exampleZoneId")
    if example_zone_id is None:
        example_zone_id = "cn-beijing-h"
    securitygroup_name = config.get("securitygroupName")
    if securitygroup_name is None:
        securitygroup_name = "rds_custom_init_sg_cn_beijing"
    default = alicloud.resourcemanager.get_resource_groups()
    vpc_id = alicloud.vpc.Network("vpcId", vpc_name=vpc_name)
    v_switch_id = alicloud.vpc.Switch("vSwitchId",
        vpc_id=vpc_id.id,
        zone_id=example_zone_id,
        vswitch_name=vswtich_id,
        cidr_block="172.16.5.0/24")
    security_group_id = alicloud.ecs.SecurityGroup("securityGroupId",
        vpc_id=vpc_id.id,
        security_group_name=securitygroup_name)
    deployment_set = alicloud.ecs.EcsDeploymentSet("deploymentSet")
    key_pair_name = alicloud.ecs.EcsKeyPair("KeyPairName", key_pair_name=v_switch_id.id)
    default_custom = alicloud.rds.Custom("default",
        amount=1,
        auto_renew=False,
        period=1,
        auto_pay=True,
        instance_type="mysql.x2.xlarge.6cm",
        data_disks=[{
            "category": "cloud_essd",
            "size": 50,
            "performance_level": "PL1",
        }],
        status="Running",
        security_group_ids=[security_group_id.id],
        io_optimized="optimized",
        description=description,
        key_pair_name=key_pair_name.id,
        zone_id=example_zone_id,
        instance_charge_type="Prepaid",
        internet_max_bandwidth_out=0,
        image_id="aliyun_2_1903_x64_20G_alibase_20240628.vhd",
        security_enhancement_strategy="Active",
        period_unit="Month",
        password="jingyiTEST@123",
        system_disk={
            "size": "40",
            "category": "cloud_essd",
        },
        host_name="1743386110",
        create_mode="0",
        spot_strategy="NoSpot",
        vswitch_id=v_switch_id.id,
        support_case="eni",
        deployment_set_id=deploymentsetid,
        dry_run=False)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/rds"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		name := "terraform-example"
    		if param := cfg.Get("name"); param != "" {
    			name = param
    		}
    		clusterId := "c18c40b2b336840e2b2bbf8ab291758e2"
    		if param := cfg.Get("clusterId"); param != "" {
    			clusterId = param
    		}
    		deploymentsetid := "ds-2ze78ef5kyj9eveue92m"
    		if param := cfg.Get("deploymentsetid"); param != "" {
    			deploymentsetid = param
    		}
    		vswtich_id := "example_vswitch"
    		if param := cfg.Get("vswtich-id"); param != "" {
    			vswtich_id = param
    		}
    		vpcName := "beijing111"
    		if param := cfg.Get("vpcName"); param != "" {
    			vpcName = param
    		}
    		exampleRegionId := "cn-beijing"
    		if param := cfg.Get("exampleRegionId"); param != "" {
    			exampleRegionId = param
    		}
    		description := "ran_1-08_rccreatenodepool_api"
    		if param := cfg.Get("description"); param != "" {
    			description = param
    		}
    		exampleZoneId := "cn-beijing-h"
    		if param := cfg.Get("exampleZoneId"); param != "" {
    			exampleZoneId = param
    		}
    		securitygroupName := "rds_custom_init_sg_cn_beijing"
    		if param := cfg.Get("securitygroupName"); param != "" {
    			securitygroupName = param
    		}
    		_, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		vpcId, err := vpc.NewNetwork(ctx, "vpcId", &vpc.NetworkArgs{
    			VpcName: pulumi.String(vpcName),
    		})
    		if err != nil {
    			return err
    		}
    		vSwitchId, err := vpc.NewSwitch(ctx, "vSwitchId", &vpc.SwitchArgs{
    			VpcId:       vpcId.ID(),
    			ZoneId:      pulumi.String(exampleZoneId),
    			VswitchName: pulumi.String(vswtich_id),
    			CidrBlock:   pulumi.String("172.16.5.0/24"),
    		})
    		if err != nil {
    			return err
    		}
    		securityGroupId, err := ecs.NewSecurityGroup(ctx, "securityGroupId", &ecs.SecurityGroupArgs{
    			VpcId:             vpcId.ID(),
    			SecurityGroupName: pulumi.String(securitygroupName),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ecs.NewEcsDeploymentSet(ctx, "deploymentSet", nil)
    		if err != nil {
    			return err
    		}
    		keyPairName, err := ecs.NewEcsKeyPair(ctx, "KeyPairName", &ecs.EcsKeyPairArgs{
    			KeyPairName: vSwitchId.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = rds.NewCustom(ctx, "default", &rds.CustomArgs{
    			Amount:       pulumi.Int(1),
    			AutoRenew:    pulumi.Bool(false),
    			Period:       pulumi.Int(1),
    			AutoPay:      pulumi.Bool(true),
    			InstanceType: pulumi.String("mysql.x2.xlarge.6cm"),
    			DataDisks: rds.CustomDataDiskArray{
    				&rds.CustomDataDiskArgs{
    					Category:         pulumi.String("cloud_essd"),
    					Size:             pulumi.Int(50),
    					PerformanceLevel: pulumi.String("PL1"),
    				},
    			},
    			Status: pulumi.String("Running"),
    			SecurityGroupIds: pulumi.StringArray{
    				securityGroupId.ID(),
    			},
    			IoOptimized:                 pulumi.String("optimized"),
    			Description:                 pulumi.String(description),
    			KeyPairName:                 keyPairName.ID(),
    			ZoneId:                      pulumi.String(exampleZoneId),
    			InstanceChargeType:          pulumi.String("Prepaid"),
    			InternetMaxBandwidthOut:     pulumi.Int(0),
    			ImageId:                     pulumi.String("aliyun_2_1903_x64_20G_alibase_20240628.vhd"),
    			SecurityEnhancementStrategy: pulumi.String("Active"),
    			PeriodUnit:                  pulumi.String("Month"),
    			Password:                    pulumi.String("jingyiTEST@123"),
    			SystemDisk: &rds.CustomSystemDiskArgs{
    				Size:     pulumi.String("40"),
    				Category: pulumi.String("cloud_essd"),
    			},
    			HostName:        pulumi.String("1743386110"),
    			CreateMode:      pulumi.String("0"),
    			SpotStrategy:    pulumi.String("NoSpot"),
    			VswitchId:       vSwitchId.ID(),
    			SupportCase:     pulumi.String("eni"),
    			DeploymentSetId: pulumi.String(deploymentsetid),
    			DryRun:          pulumi.Bool(false),
    		})
    		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 config = new Config();
        var name = config.Get("name") ?? "terraform-example";
        var clusterId = config.Get("clusterId") ?? "c18c40b2b336840e2b2bbf8ab291758e2";
        var deploymentsetid = config.Get("deploymentsetid") ?? "ds-2ze78ef5kyj9eveue92m";
        var vswtich_id = config.Get("vswtich-id") ?? "example_vswitch";
        var vpcName = config.Get("vpcName") ?? "beijing111";
        var exampleRegionId = config.Get("exampleRegionId") ?? "cn-beijing";
        var description = config.Get("description") ?? "ran_1-08_rccreatenodepool_api";
        var exampleZoneId = config.Get("exampleZoneId") ?? "cn-beijing-h";
        var securitygroupName = config.Get("securitygroupName") ?? "rds_custom_init_sg_cn_beijing";
        var @default = AliCloud.ResourceManager.GetResourceGroups.Invoke();
    
        var vpcId = new AliCloud.Vpc.Network("vpcId", new()
        {
            VpcName = vpcName,
        });
    
        var vSwitchId = new AliCloud.Vpc.Switch("vSwitchId", new()
        {
            VpcId = vpcId.Id,
            ZoneId = exampleZoneId,
            VswitchName = vswtich_id,
            CidrBlock = "172.16.5.0/24",
        });
    
        var securityGroupId = new AliCloud.Ecs.SecurityGroup("securityGroupId", new()
        {
            VpcId = vpcId.Id,
            SecurityGroupName = securitygroupName,
        });
    
        var deploymentSet = new AliCloud.Ecs.EcsDeploymentSet("deploymentSet");
    
        var keyPairName = new AliCloud.Ecs.EcsKeyPair("KeyPairName", new()
        {
            KeyPairName = vSwitchId.Id,
        });
    
        var defaultCustom = new AliCloud.Rds.Custom("default", new()
        {
            Amount = 1,
            AutoRenew = false,
            Period = 1,
            AutoPay = true,
            InstanceType = "mysql.x2.xlarge.6cm",
            DataDisks = new[]
            {
                new AliCloud.Rds.Inputs.CustomDataDiskArgs
                {
                    Category = "cloud_essd",
                    Size = 50,
                    PerformanceLevel = "PL1",
                },
            },
            Status = "Running",
            SecurityGroupIds = new[]
            {
                securityGroupId.Id,
            },
            IoOptimized = "optimized",
            Description = description,
            KeyPairName = keyPairName.Id,
            ZoneId = exampleZoneId,
            InstanceChargeType = "Prepaid",
            InternetMaxBandwidthOut = 0,
            ImageId = "aliyun_2_1903_x64_20G_alibase_20240628.vhd",
            SecurityEnhancementStrategy = "Active",
            PeriodUnit = "Month",
            Password = "jingyiTEST@123",
            SystemDisk = new AliCloud.Rds.Inputs.CustomSystemDiskArgs
            {
                Size = "40",
                Category = "cloud_essd",
            },
            HostName = "1743386110",
            CreateMode = "0",
            SpotStrategy = "NoSpot",
            VswitchId = vSwitchId.Id,
            SupportCase = "eni",
            DeploymentSetId = deploymentsetid,
            DryRun = false,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
    import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
    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.ecs.SecurityGroup;
    import com.pulumi.alicloud.ecs.SecurityGroupArgs;
    import com.pulumi.alicloud.ecs.EcsDeploymentSet;
    import com.pulumi.alicloud.ecs.EcsKeyPair;
    import com.pulumi.alicloud.ecs.EcsKeyPairArgs;
    import com.pulumi.alicloud.rds.Custom;
    import com.pulumi.alicloud.rds.CustomArgs;
    import com.pulumi.alicloud.rds.inputs.CustomDataDiskArgs;
    import com.pulumi.alicloud.rds.inputs.CustomSystemDiskArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 config = ctx.config();
            final var name = config.get("name").orElse("terraform-example");
            final var clusterId = config.get("clusterId").orElse("c18c40b2b336840e2b2bbf8ab291758e2");
            final var deploymentsetid = config.get("deploymentsetid").orElse("ds-2ze78ef5kyj9eveue92m");
            final var vswtich_id = config.get("vswtich-id").orElse("example_vswitch");
            final var vpcName = config.get("vpcName").orElse("beijing111");
            final var exampleRegionId = config.get("exampleRegionId").orElse("cn-beijing");
            final var description = config.get("description").orElse("ran_1-08_rccreatenodepool_api");
            final var exampleZoneId = config.get("exampleZoneId").orElse("cn-beijing-h");
            final var securitygroupName = config.get("securitygroupName").orElse("rds_custom_init_sg_cn_beijing");
            final var default = ResourcemanagerFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
                .build());
    
            var vpcId = new Network("vpcId", NetworkArgs.builder()
                .vpcName(vpcName)
                .build());
    
            var vSwitchId = new Switch("vSwitchId", SwitchArgs.builder()
                .vpcId(vpcId.id())
                .zoneId(exampleZoneId)
                .vswitchName(vswtich_id)
                .cidrBlock("172.16.5.0/24")
                .build());
    
            var securityGroupId = new SecurityGroup("securityGroupId", SecurityGroupArgs.builder()
                .vpcId(vpcId.id())
                .securityGroupName(securitygroupName)
                .build());
    
            var deploymentSet = new EcsDeploymentSet("deploymentSet");
    
            var keyPairName = new EcsKeyPair("keyPairName", EcsKeyPairArgs.builder()
                .keyPairName(vSwitchId.id())
                .build());
    
            var defaultCustom = new Custom("defaultCustom", CustomArgs.builder()
                .amount(1)
                .autoRenew(false)
                .period(1)
                .autoPay(true)
                .instanceType("mysql.x2.xlarge.6cm")
                .dataDisks(CustomDataDiskArgs.builder()
                    .category("cloud_essd")
                    .size(50)
                    .performanceLevel("PL1")
                    .build())
                .status("Running")
                .securityGroupIds(securityGroupId.id())
                .ioOptimized("optimized")
                .description(description)
                .keyPairName(keyPairName.id())
                .zoneId(exampleZoneId)
                .instanceChargeType("Prepaid")
                .internetMaxBandwidthOut(0)
                .imageId("aliyun_2_1903_x64_20G_alibase_20240628.vhd")
                .securityEnhancementStrategy("Active")
                .periodUnit("Month")
                .password("jingyiTEST@123")
                .systemDisk(CustomSystemDiskArgs.builder()
                    .size("40")
                    .category("cloud_essd")
                    .build())
                .hostName("1743386110")
                .createMode("0")
                .spotStrategy("NoSpot")
                .vswitchId(vSwitchId.id())
                .supportCase("eni")
                .deploymentSetId(deploymentsetid)
                .dryRun(false)
                .build());
    
        }
    }
    
    configuration:
      name:
        type: string
        default: terraform-example
      clusterId:
        type: string
        default: c18c40b2b336840e2b2bbf8ab291758e2
      deploymentsetid:
        type: string
        default: ds-2ze78ef5kyj9eveue92m
      vswtich-id:
        type: string
        default: example_vswitch
      vpcName:
        type: string
        default: beijing111
      exampleRegionId:
        type: string
        default: cn-beijing
      description:
        type: string
        default: ran_1-08_rccreatenodepool_api
      exampleZoneId:
        type: string
        default: cn-beijing-h
      securitygroupName:
        type: string
        default: rds_custom_init_sg_cn_beijing
    resources:
      vpcId:
        type: alicloud:vpc:Network
        properties:
          vpcName: ${vpcName}
      vSwitchId:
        type: alicloud:vpc:Switch
        properties:
          vpcId: ${vpcId.id}
          zoneId: ${exampleZoneId}
          vswitchName: ${["vswtich-id"]}
          cidrBlock: 172.16.5.0/24
      securityGroupId:
        type: alicloud:ecs:SecurityGroup
        properties:
          vpcId: ${vpcId.id}
          securityGroupName: ${securitygroupName}
      deploymentSet:
        type: alicloud:ecs:EcsDeploymentSet
      keyPairName:
        type: alicloud:ecs:EcsKeyPair
        name: KeyPairName
        properties:
          keyPairName: ${vSwitchId.id}
      defaultCustom:
        type: alicloud:rds:Custom
        name: default
        properties:
          amount: '1'
          autoRenew: false
          period: '1'
          autoPay: true
          instanceType: mysql.x2.xlarge.6cm
          dataDisks:
            - category: cloud_essd
              size: '50'
              performanceLevel: PL1
          status: Running
          securityGroupIds:
            - ${securityGroupId.id}
          ioOptimized: optimized
          description: ${description}
          keyPairName: ${keyPairName.id}
          zoneId: ${exampleZoneId}
          instanceChargeType: Prepaid
          internetMaxBandwidthOut: '0'
          imageId: aliyun_2_1903_x64_20G_alibase_20240628.vhd
          securityEnhancementStrategy: Active
          periodUnit: Month
          password: jingyiTEST@123
          systemDisk:
            size: '40'
            category: cloud_essd
          hostName: '1743386110'
          createMode: '0'
          spotStrategy: NoSpot
          vswitchId: ${vSwitchId.id}
          supportCase: eni
          deploymentSetId: ${deploymentsetid}
          dryRun: false
    variables:
      default:
        fn::invoke:
          function: alicloud:resourcemanager:getResourceGroups
          arguments: {}
    
    pulumi {
      required_providers {
        alicloud = {
          source = "pulumi/alicloud"
        }
      }
    }
    
    data "alicloud_resourcemanager_getresourcegroups" "default" {
    }
    
    resource "alicloud_vpc_network" "vpcId" {
      vpc_name = var.vpcName
    }
    resource "alicloud_vpc_switch" "vSwitchId" {
      vpc_id       = alicloud_vpc_network.vpcId.id
      zone_id      = var.exampleZoneId
      vswitch_name = var.vswtich-id
      cidr_block   = "172.16.5.0/24"
    }
    resource "alicloud_ecs_securitygroup" "securityGroupId" {
      vpc_id              = alicloud_vpc_network.vpcId.id
      security_group_name = var.securitygroupName
    }
    resource "alicloud_ecs_ecsdeploymentset" "deploymentSet" {
    }
    resource "alicloud_ecs_ecskeypair" "KeyPairName" {
      key_pair_name = alicloud_vpc_switch.vSwitchId.id
    }
    resource "alicloud_rds_custom" "default" {
      amount        = "1"
      auto_renew    = false
      period        = "1"
      auto_pay      = true
      instance_type = "mysql.x2.xlarge.6cm"
      data_disks {
        category          = "cloud_essd"
        size              = "50"
        performance_level = "PL1"
      }
      status                        = "Running"
      security_group_ids            = [alicloud_ecs_securitygroup.securityGroupId.id]
      io_optimized                  = "optimized"
      description                   = var.description
      key_pair_name                 = alicloud_ecs_ecskeypair.KeyPairName.id
      zone_id                       = var.exampleZoneId
      instance_charge_type          = "Prepaid"
      internet_max_bandwidth_out    = "0"
      image_id                      = "aliyun_2_1903_x64_20G_alibase_20240628.vhd"
      security_enhancement_strategy = "Active"
      period_unit                   = "Month"
      password                      = "jingyiTEST@123"
      system_disk = {
        size     = "40"
        category = "cloud_essd"
      }
      host_name         = "1743386110"
      create_mode       = "0"
      spot_strategy     = "NoSpot"
      vswitch_id        = alicloud_vpc_switch.vSwitchId.id
      support_case      = "eni"
      deployment_set_id = var.deploymentsetid
      dry_run           = false
    }
    variable "name" {
      type    = string
      default = "terraform-example"
    }
    variable "clusterId" {
      type    = string
      default = "c18c40b2b336840e2b2bbf8ab291758e2"
    }
    variable "deploymentsetid" {
      type    = string
      default = "ds-2ze78ef5kyj9eveue92m"
    }
    variable "vswtich-id" {
      type    = string
      default = "example_vswitch"
    }
    variable "vpcName" {
      type    = string
      default = "beijing111"
    }
    variable "exampleRegionId" {
      type    = string
      default = "cn-beijing"
    }
    variable "description" {
      type    = string
      default = "ran_1-08_rccreatenodepool_api"
    }
    variable "exampleZoneId" {
      type    = string
      default = "cn-beijing-h"
    }
    variable "securitygroupName" {
      type    = string
      default = "rds_custom_init_sg_cn_beijing"
    }
    

    📚 Need more examples? VIEW MORE EXAMPLES

    Create Custom Resource

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

    Constructor syntax

    new Custom(name: string, args: CustomArgs, opts?: CustomResourceOptions);
    @overload
    def Custom(resource_name: str,
               args: CustomArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Custom(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               instance_type: Optional[str] = None,
               vswitch_id: Optional[str] = None,
               direction: Optional[str] = None,
               io_optimized: Optional[str] = None,
               create_mode: Optional[str] = None,
               data_disks: Optional[Sequence[CustomDataDiskArgs]] = None,
               deployment_set_id: Optional[str] = None,
               description: Optional[str] = None,
               amount: Optional[int] = None,
               dry_run: Optional[bool] = None,
               force: Optional[bool] = None,
               force_stop: Optional[bool] = None,
               host_name: Optional[str] = None,
               image_id: Optional[str] = None,
               instance_charge_type: Optional[str] = None,
               instance_name: Optional[str] = None,
               auto_renew: Optional[bool] = None,
               internet_charge_type: Optional[str] = None,
               create_extra_param: Optional[str] = None,
               key_pair_name: Optional[str] = None,
               internet_max_bandwidth_out: Optional[int] = None,
               password: Optional[str] = None,
               period: Optional[int] = None,
               period_unit: Optional[str] = None,
               private_ip_address: Optional[str] = None,
               resource_group_id: Optional[str] = None,
               security_enhancement_strategy: Optional[str] = None,
               security_group_ids: Optional[Sequence[str]] = None,
               spot_strategy: Optional[str] = None,
               status: Optional[str] = None,
               support_case: Optional[str] = None,
               system_disk: Optional[CustomSystemDiskArgs] = None,
               tags: Optional[Mapping[str, str]] = None,
               auto_pay: Optional[bool] = None,
               zone_id: Optional[str] = None)
    func NewCustom(ctx *Context, name string, args CustomArgs, opts ...ResourceOption) (*Custom, error)
    public Custom(string name, CustomArgs args, CustomResourceOptions? opts = null)
    public Custom(String name, CustomArgs args)
    public Custom(String name, CustomArgs args, CustomResourceOptions options)
    
    type: alicloud:rds:Custom
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "alicloud_rds_custom" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args CustomArgs
    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 CustomArgs
    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 CustomArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomArgs
    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 customResource = new AliCloud.Rds.Custom("customResource", new()
    {
        InstanceType = "string",
        VswitchId = "string",
        Direction = "string",
        IoOptimized = "string",
        CreateMode = "string",
        DataDisks = new[]
        {
            new AliCloud.Rds.Inputs.CustomDataDiskArgs
            {
                Category = "string",
                PerformanceLevel = "string",
                Size = 0,
            },
        },
        DeploymentSetId = "string",
        Description = "string",
        Amount = 0,
        DryRun = false,
        Force = false,
        ForceStop = false,
        HostName = "string",
        ImageId = "string",
        InstanceChargeType = "string",
        InstanceName = "string",
        AutoRenew = false,
        InternetChargeType = "string",
        CreateExtraParam = "string",
        KeyPairName = "string",
        InternetMaxBandwidthOut = 0,
        Password = "string",
        Period = 0,
        PeriodUnit = "string",
        PrivateIpAddress = "string",
        ResourceGroupId = "string",
        SecurityEnhancementStrategy = "string",
        SecurityGroupIds = new[]
        {
            "string",
        },
        SpotStrategy = "string",
        Status = "string",
        SupportCase = "string",
        SystemDisk = new AliCloud.Rds.Inputs.CustomSystemDiskArgs
        {
            Category = "string",
            Size = "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
        AutoPay = false,
        ZoneId = "string",
    });
    
    example, err := rds.NewCustom(ctx, "customResource", &rds.CustomArgs{
    	InstanceType: pulumi.String("string"),
    	VswitchId:    pulumi.String("string"),
    	Direction:    pulumi.String("string"),
    	IoOptimized:  pulumi.String("string"),
    	CreateMode:   pulumi.String("string"),
    	DataDisks: rds.CustomDataDiskArray{
    		&rds.CustomDataDiskArgs{
    			Category:         pulumi.String("string"),
    			PerformanceLevel: pulumi.String("string"),
    			Size:             pulumi.Int(0),
    		},
    	},
    	DeploymentSetId:             pulumi.String("string"),
    	Description:                 pulumi.String("string"),
    	Amount:                      pulumi.Int(0),
    	DryRun:                      pulumi.Bool(false),
    	Force:                       pulumi.Bool(false),
    	ForceStop:                   pulumi.Bool(false),
    	HostName:                    pulumi.String("string"),
    	ImageId:                     pulumi.String("string"),
    	InstanceChargeType:          pulumi.String("string"),
    	InstanceName:                pulumi.String("string"),
    	AutoRenew:                   pulumi.Bool(false),
    	InternetChargeType:          pulumi.String("string"),
    	CreateExtraParam:            pulumi.String("string"),
    	KeyPairName:                 pulumi.String("string"),
    	InternetMaxBandwidthOut:     pulumi.Int(0),
    	Password:                    pulumi.String("string"),
    	Period:                      pulumi.Int(0),
    	PeriodUnit:                  pulumi.String("string"),
    	PrivateIpAddress:            pulumi.String("string"),
    	ResourceGroupId:             pulumi.String("string"),
    	SecurityEnhancementStrategy: pulumi.String("string"),
    	SecurityGroupIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SpotStrategy: pulumi.String("string"),
    	Status:       pulumi.String("string"),
    	SupportCase:  pulumi.String("string"),
    	SystemDisk: &rds.CustomSystemDiskArgs{
    		Category: pulumi.String("string"),
    		Size:     pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	AutoPay: pulumi.Bool(false),
    	ZoneId:  pulumi.String("string"),
    })
    
    resource "alicloud_rds_custom" "customResource" {
      instance_type = "string"
      vswitch_id    = "string"
      direction     = "string"
      io_optimized  = "string"
      create_mode   = "string"
      data_disks {
        category          = "string"
        performance_level = "string"
        size              = 0
      }
      deployment_set_id             = "string"
      description                   = "string"
      amount                        = 0
      dry_run                       = false
      force                         = false
      force_stop                    = false
      host_name                     = "string"
      image_id                      = "string"
      instance_charge_type          = "string"
      instance_name                 = "string"
      auto_renew                    = false
      internet_charge_type          = "string"
      create_extra_param            = "string"
      key_pair_name                 = "string"
      internet_max_bandwidth_out    = 0
      password                      = "string"
      period                        = 0
      period_unit                   = "string"
      private_ip_address            = "string"
      resource_group_id             = "string"
      security_enhancement_strategy = "string"
      security_group_ids            = ["string"]
      spot_strategy                 = "string"
      status                        = "string"
      support_case                  = "string"
      system_disk = {
        category = "string"
        size     = "string"
      }
      tags = {
        "string" = "string"
      }
      auto_pay = false
      zone_id  = "string"
    }
    
    var customResource = new Custom("customResource", CustomArgs.builder()
        .instanceType("string")
        .vswitchId("string")
        .direction("string")
        .ioOptimized("string")
        .createMode("string")
        .dataDisks(CustomDataDiskArgs.builder()
            .category("string")
            .performanceLevel("string")
            .size(0)
            .build())
        .deploymentSetId("string")
        .description("string")
        .amount(0)
        .dryRun(false)
        .force(false)
        .forceStop(false)
        .hostName("string")
        .imageId("string")
        .instanceChargeType("string")
        .instanceName("string")
        .autoRenew(false)
        .internetChargeType("string")
        .createExtraParam("string")
        .keyPairName("string")
        .internetMaxBandwidthOut(0)
        .password("string")
        .period(0)
        .periodUnit("string")
        .privateIpAddress("string")
        .resourceGroupId("string")
        .securityEnhancementStrategy("string")
        .securityGroupIds("string")
        .spotStrategy("string")
        .status("string")
        .supportCase("string")
        .systemDisk(CustomSystemDiskArgs.builder()
            .category("string")
            .size("string")
            .build())
        .tags(Map.of("string", "string"))
        .autoPay(false)
        .zoneId("string")
        .build());
    
    custom_resource = alicloud.rds.Custom("customResource",
        instance_type="string",
        vswitch_id="string",
        direction="string",
        io_optimized="string",
        create_mode="string",
        data_disks=[{
            "category": "string",
            "performance_level": "string",
            "size": 0,
        }],
        deployment_set_id="string",
        description="string",
        amount=0,
        dry_run=False,
        force=False,
        force_stop=False,
        host_name="string",
        image_id="string",
        instance_charge_type="string",
        instance_name="string",
        auto_renew=False,
        internet_charge_type="string",
        create_extra_param="string",
        key_pair_name="string",
        internet_max_bandwidth_out=0,
        password="string",
        period=0,
        period_unit="string",
        private_ip_address="string",
        resource_group_id="string",
        security_enhancement_strategy="string",
        security_group_ids=["string"],
        spot_strategy="string",
        status="string",
        support_case="string",
        system_disk={
            "category": "string",
            "size": "string",
        },
        tags={
            "string": "string",
        },
        auto_pay=False,
        zone_id="string")
    
    const customResource = new alicloud.rds.Custom("customResource", {
        instanceType: "string",
        vswitchId: "string",
        direction: "string",
        ioOptimized: "string",
        createMode: "string",
        dataDisks: [{
            category: "string",
            performanceLevel: "string",
            size: 0,
        }],
        deploymentSetId: "string",
        description: "string",
        amount: 0,
        dryRun: false,
        force: false,
        forceStop: false,
        hostName: "string",
        imageId: "string",
        instanceChargeType: "string",
        instanceName: "string",
        autoRenew: false,
        internetChargeType: "string",
        createExtraParam: "string",
        keyPairName: "string",
        internetMaxBandwidthOut: 0,
        password: "string",
        period: 0,
        periodUnit: "string",
        privateIpAddress: "string",
        resourceGroupId: "string",
        securityEnhancementStrategy: "string",
        securityGroupIds: ["string"],
        spotStrategy: "string",
        status: "string",
        supportCase: "string",
        systemDisk: {
            category: "string",
            size: "string",
        },
        tags: {
            string: "string",
        },
        autoPay: false,
        zoneId: "string",
    });
    
    type: alicloud:rds:Custom
    properties:
        amount: 0
        autoPay: false
        autoRenew: false
        createExtraParam: string
        createMode: string
        dataDisks:
            - category: string
              performanceLevel: string
              size: 0
        deploymentSetId: string
        description: string
        direction: string
        dryRun: false
        force: false
        forceStop: false
        hostName: string
        imageId: string
        instanceChargeType: string
        instanceName: string
        instanceType: string
        internetChargeType: string
        internetMaxBandwidthOut: 0
        ioOptimized: string
        keyPairName: string
        password: string
        period: 0
        periodUnit: string
        privateIpAddress: string
        resourceGroupId: string
        securityEnhancementStrategy: string
        securityGroupIds:
            - string
        spotStrategy: string
        status: string
        supportCase: string
        systemDisk:
            category: string
            size: string
        tags:
            string: string
        vswitchId: string
        zoneId: string
    

    Custom Resource Properties

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

    Inputs

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

    The Custom resource accepts the following input properties:

    InstanceType string
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    VswitchId string

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    Amount int

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    AutoPay bool
    Specifies whether to enable automatic payment. Valid values:
    AutoRenew bool
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    CreateExtraParam string
    Reserved parameters are not supported.
    CreateMode string
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    DataDisks List<Pulumi.AliCloud.Rds.Inputs.CustomDataDisk>
    List of data disks. See dataDisk below.
    DeploymentSetId string
    Deployment set ID.
    Description string
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    Direction string

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    DryRun bool
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    Force bool
    Specifies whether to forcibly release a running instance. Valid values:
    ForceStop bool
    Specifies whether to force shut down the instance. Valid values:
    HostName string

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    ImageId string

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    InstanceChargeType string

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    InstanceName string
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    InternetChargeType string

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    InternetMaxBandwidthOut int

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    IoOptimized string

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    KeyPairName string

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    Password string

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    Period int

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    PeriodUnit string

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    PrivateIpAddress string
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    ResourceGroupId string
    The resource group ID. You can call ListResourceGroups to obtain it.
    SecurityEnhancementStrategy string

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    SecurityGroupIds List<string>

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    SpotStrategy string

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    Status string
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    SupportCase string
    The deployment type of RDS Custom. Valid values:
    SystemDisk Pulumi.AliCloud.Rds.Inputs.CustomSystemDisk

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    Tags Dictionary<string, string>
    Details of the queried instances and their tags.
    ZoneId string

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    InstanceType string
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    VswitchId string

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    Amount int

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    AutoPay bool
    Specifies whether to enable automatic payment. Valid values:
    AutoRenew bool
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    CreateExtraParam string
    Reserved parameters are not supported.
    CreateMode string
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    DataDisks []CustomDataDiskArgs
    List of data disks. See dataDisk below.
    DeploymentSetId string
    Deployment set ID.
    Description string
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    Direction string

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    DryRun bool
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    Force bool
    Specifies whether to forcibly release a running instance. Valid values:
    ForceStop bool
    Specifies whether to force shut down the instance. Valid values:
    HostName string

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    ImageId string

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    InstanceChargeType string

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    InstanceName string
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    InternetChargeType string

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    InternetMaxBandwidthOut int

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    IoOptimized string

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    KeyPairName string

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    Password string

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    Period int

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    PeriodUnit string

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    PrivateIpAddress string
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    ResourceGroupId string
    The resource group ID. You can call ListResourceGroups to obtain it.
    SecurityEnhancementStrategy string

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    SecurityGroupIds []string

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    SpotStrategy string

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    Status string
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    SupportCase string
    The deployment type of RDS Custom. Valid values:
    SystemDisk CustomSystemDiskArgs

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    Tags map[string]string
    Details of the queried instances and their tags.
    ZoneId string

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    instance_type string
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    vswitch_id string

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    amount number

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    auto_pay bool
    Specifies whether to enable automatic payment. Valid values:
    auto_renew bool
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    create_extra_param string
    Reserved parameters are not supported.
    create_mode string
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    data_disks list(object)
    List of data disks. See dataDisk below.
    deployment_set_id string
    Deployment set ID.
    description string
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    direction string

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    dry_run bool
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    force bool
    Specifies whether to forcibly release a running instance. Valid values:
    force_stop bool
    Specifies whether to force shut down the instance. Valid values:
    host_name string

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    image_id string

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instance_charge_type string

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instance_name string
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    internet_charge_type string

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    internet_max_bandwidth_out number

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    io_optimized string

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    key_pair_name string

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    password string

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period number

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period_unit string

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    private_ip_address string
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    resource_group_id string
    The resource group ID. You can call ListResourceGroups to obtain it.
    security_enhancement_strategy string

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    security_group_ids list(string)

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    spot_strategy string

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    status string
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    support_case string
    The deployment type of RDS Custom. Valid values:
    system_disk object

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    tags map(string)
    Details of the queried instances and their tags.
    zone_id string

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    instanceType String
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    vswitchId String

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    amount Integer

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    autoPay Boolean
    Specifies whether to enable automatic payment. Valid values:
    autoRenew Boolean
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    createExtraParam String
    Reserved parameters are not supported.
    createMode String
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    dataDisks List<CustomDataDisk>
    List of data disks. See dataDisk below.
    deploymentSetId String
    Deployment set ID.
    description String
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    direction String

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    dryRun Boolean
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    force Boolean
    Specifies whether to forcibly release a running instance. Valid values:
    forceStop Boolean
    Specifies whether to force shut down the instance. Valid values:
    hostName String

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    imageId String

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instanceChargeType String

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instanceName String
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    internetChargeType String

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    internetMaxBandwidthOut Integer

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    ioOptimized String

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    keyPairName String

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    password String

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period Integer

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    periodUnit String

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    privateIpAddress String
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    resourceGroupId String
    The resource group ID. You can call ListResourceGroups to obtain it.
    securityEnhancementStrategy String

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    securityGroupIds List<String>

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    spotStrategy String

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    status String
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    supportCase String
    The deployment type of RDS Custom. Valid values:
    systemDisk CustomSystemDisk

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    tags Map<String,String>
    Details of the queried instances and their tags.
    zoneId String

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    instanceType string
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    vswitchId string

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    amount number

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    autoPay boolean
    Specifies whether to enable automatic payment. Valid values:
    autoRenew boolean
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    createExtraParam string
    Reserved parameters are not supported.
    createMode string
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    dataDisks CustomDataDisk[]
    List of data disks. See dataDisk below.
    deploymentSetId string
    Deployment set ID.
    description string
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    direction string

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    dryRun boolean
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    force boolean
    Specifies whether to forcibly release a running instance. Valid values:
    forceStop boolean
    Specifies whether to force shut down the instance. Valid values:
    hostName string

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    imageId string

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instanceChargeType string

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instanceName string
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    internetChargeType string

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    internetMaxBandwidthOut number

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    ioOptimized string

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    keyPairName string

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    password string

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period number

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    periodUnit string

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    privateIpAddress string
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    resourceGroupId string
    The resource group ID. You can call ListResourceGroups to obtain it.
    securityEnhancementStrategy string

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    securityGroupIds string[]

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    spotStrategy string

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    status string
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    supportCase string
    The deployment type of RDS Custom. Valid values:
    systemDisk CustomSystemDisk

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    tags {[key: string]: string}
    Details of the queried instances and their tags.
    zoneId string

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    instance_type str
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    vswitch_id str

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    amount int

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    auto_pay bool
    Specifies whether to enable automatic payment. Valid values:
    auto_renew bool
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    create_extra_param str
    Reserved parameters are not supported.
    create_mode str
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    data_disks Sequence[CustomDataDiskArgs]
    List of data disks. See dataDisk below.
    deployment_set_id str
    Deployment set ID.
    description str
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    direction str

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    dry_run bool
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    force bool
    Specifies whether to forcibly release a running instance. Valid values:
    force_stop bool
    Specifies whether to force shut down the instance. Valid values:
    host_name str

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    image_id str

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instance_charge_type str

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instance_name str
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    internet_charge_type str

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    internet_max_bandwidth_out int

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    io_optimized str

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    key_pair_name str

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    password str

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period int

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period_unit str

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    private_ip_address str
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    resource_group_id str
    The resource group ID. You can call ListResourceGroups to obtain it.
    security_enhancement_strategy str

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    security_group_ids Sequence[str]

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    spot_strategy str

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    status str
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    support_case str
    The deployment type of RDS Custom. Valid values:
    system_disk CustomSystemDiskArgs

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    tags Mapping[str, str]
    Details of the queried instances and their tags.
    zone_id str

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    instanceType String
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    vswitchId String

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    amount Number

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    autoPay Boolean
    Specifies whether to enable automatic payment. Valid values:
    autoRenew Boolean
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    createExtraParam String
    Reserved parameters are not supported.
    createMode String
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    dataDisks List<Property Map>
    List of data disks. See dataDisk below.
    deploymentSetId String
    Deployment set ID.
    description String
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    direction String

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    dryRun Boolean
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    force Boolean
    Specifies whether to forcibly release a running instance. Valid values:
    forceStop Boolean
    Specifies whether to force shut down the instance. Valid values:
    hostName String

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    imageId String

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instanceChargeType String

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instanceName String
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    internetChargeType String

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    internetMaxBandwidthOut Number

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    ioOptimized String

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    keyPairName String

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    password String

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period Number

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    periodUnit String

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    privateIpAddress String
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    resourceGroupId String
    The resource group ID. You can call ListResourceGroups to obtain it.
    securityEnhancementStrategy String

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    securityGroupIds List<String>

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    spotStrategy String

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    status String
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    supportCase String
    The deployment type of RDS Custom. Valid values:
    systemDisk Property Map

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    tags Map<String>
    Details of the queried instances and their tags.
    zoneId String

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    RegionId string
    The region ID.
    SystemDiskId string
    The ID of the system disk attached to the Custom instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionId string
    The region ID.
    SystemDiskId string
    The ID of the system disk attached to the Custom instance.
    id string
    The provider-assigned unique ID for this managed resource.
    region_id string
    The region ID.
    system_disk_id string
    The ID of the system disk attached to the Custom instance.
    id String
    The provider-assigned unique ID for this managed resource.
    regionId String
    The region ID.
    systemDiskId String
    The ID of the system disk attached to the Custom instance.
    id string
    The provider-assigned unique ID for this managed resource.
    regionId string
    The region ID.
    systemDiskId string
    The ID of the system disk attached to the Custom instance.
    id str
    The provider-assigned unique ID for this managed resource.
    region_id str
    The region ID.
    system_disk_id str
    The ID of the system disk attached to the Custom instance.
    id String
    The provider-assigned unique ID for this managed resource.
    regionId String
    The region ID.
    systemDiskId String
    The ID of the system disk attached to the Custom instance.

    Look up Existing Custom Resource

    Get an existing Custom 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?: CustomState, opts?: CustomResourceOptions): Custom
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            amount: Optional[int] = None,
            auto_pay: Optional[bool] = None,
            auto_renew: Optional[bool] = None,
            create_extra_param: Optional[str] = None,
            create_mode: Optional[str] = None,
            data_disks: Optional[Sequence[CustomDataDiskArgs]] = None,
            deployment_set_id: Optional[str] = None,
            description: Optional[str] = None,
            direction: Optional[str] = None,
            dry_run: Optional[bool] = None,
            force: Optional[bool] = None,
            force_stop: Optional[bool] = None,
            host_name: Optional[str] = None,
            image_id: Optional[str] = None,
            instance_charge_type: Optional[str] = None,
            instance_name: Optional[str] = None,
            instance_type: Optional[str] = None,
            internet_charge_type: Optional[str] = None,
            internet_max_bandwidth_out: Optional[int] = None,
            io_optimized: Optional[str] = None,
            key_pair_name: Optional[str] = None,
            password: Optional[str] = None,
            period: Optional[int] = None,
            period_unit: Optional[str] = None,
            private_ip_address: Optional[str] = None,
            region_id: Optional[str] = None,
            resource_group_id: Optional[str] = None,
            security_enhancement_strategy: Optional[str] = None,
            security_group_ids: Optional[Sequence[str]] = None,
            spot_strategy: Optional[str] = None,
            status: Optional[str] = None,
            support_case: Optional[str] = None,
            system_disk: Optional[CustomSystemDiskArgs] = None,
            system_disk_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            vswitch_id: Optional[str] = None,
            zone_id: Optional[str] = None) -> Custom
    func GetCustom(ctx *Context, name string, id IDInput, state *CustomState, opts ...ResourceOption) (*Custom, error)
    public static Custom Get(string name, Input<string> id, CustomState? state, CustomResourceOptions? opts = null)
    public static Custom get(String name, Output<String> id, CustomState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:rds:Custom    get:      id: ${id}
    import {
      to = alicloud_rds_custom.example
      id = "${id}"
    }
    
    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:
    Amount int

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    AutoPay bool
    Specifies whether to enable automatic payment. Valid values:
    AutoRenew bool
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    CreateExtraParam string
    Reserved parameters are not supported.
    CreateMode string
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    DataDisks List<Pulumi.AliCloud.Rds.Inputs.CustomDataDisk>
    List of data disks. See dataDisk below.
    DeploymentSetId string
    Deployment set ID.
    Description string
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    Direction string

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    DryRun bool
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    Force bool
    Specifies whether to forcibly release a running instance. Valid values:
    ForceStop bool
    Specifies whether to force shut down the instance. Valid values:
    HostName string

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    ImageId string

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    InstanceChargeType string

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    InstanceName string
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    InstanceType string
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    InternetChargeType string

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    InternetMaxBandwidthOut int

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    IoOptimized string

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    KeyPairName string

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    Password string

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    Period int

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    PeriodUnit string

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    PrivateIpAddress string
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    RegionId string
    The region ID.
    ResourceGroupId string
    The resource group ID. You can call ListResourceGroups to obtain it.
    SecurityEnhancementStrategy string

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    SecurityGroupIds List<string>

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    SpotStrategy string

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    Status string
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    SupportCase string
    The deployment type of RDS Custom. Valid values:
    SystemDisk Pulumi.AliCloud.Rds.Inputs.CustomSystemDisk

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    SystemDiskId string
    The ID of the system disk attached to the Custom instance.
    Tags Dictionary<string, string>
    Details of the queried instances and their tags.
    VswitchId string

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    ZoneId string

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    Amount int

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    AutoPay bool
    Specifies whether to enable automatic payment. Valid values:
    AutoRenew bool
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    CreateExtraParam string
    Reserved parameters are not supported.
    CreateMode string
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    DataDisks []CustomDataDiskArgs
    List of data disks. See dataDisk below.
    DeploymentSetId string
    Deployment set ID.
    Description string
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    Direction string

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    DryRun bool
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    Force bool
    Specifies whether to forcibly release a running instance. Valid values:
    ForceStop bool
    Specifies whether to force shut down the instance. Valid values:
    HostName string

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    ImageId string

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    InstanceChargeType string

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    InstanceName string
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    InstanceType string
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    InternetChargeType string

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    InternetMaxBandwidthOut int

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    IoOptimized string

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    KeyPairName string

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    Password string

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    Period int

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    PeriodUnit string

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    PrivateIpAddress string
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    RegionId string
    The region ID.
    ResourceGroupId string
    The resource group ID. You can call ListResourceGroups to obtain it.
    SecurityEnhancementStrategy string

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    SecurityGroupIds []string

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    SpotStrategy string

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    Status string
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    SupportCase string
    The deployment type of RDS Custom. Valid values:
    SystemDisk CustomSystemDiskArgs

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    SystemDiskId string
    The ID of the system disk attached to the Custom instance.
    Tags map[string]string
    Details of the queried instances and their tags.
    VswitchId string

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    ZoneId string

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    amount number

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    auto_pay bool
    Specifies whether to enable automatic payment. Valid values:
    auto_renew bool
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    create_extra_param string
    Reserved parameters are not supported.
    create_mode string
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    data_disks list(object)
    List of data disks. See dataDisk below.
    deployment_set_id string
    Deployment set ID.
    description string
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    direction string

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    dry_run bool
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    force bool
    Specifies whether to forcibly release a running instance. Valid values:
    force_stop bool
    Specifies whether to force shut down the instance. Valid values:
    host_name string

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    image_id string

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instance_charge_type string

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instance_name string
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    instance_type string
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    internet_charge_type string

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    internet_max_bandwidth_out number

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    io_optimized string

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    key_pair_name string

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    password string

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period number

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period_unit string

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    private_ip_address string
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    region_id string
    The region ID.
    resource_group_id string
    The resource group ID. You can call ListResourceGroups to obtain it.
    security_enhancement_strategy string

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    security_group_ids list(string)

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    spot_strategy string

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    status string
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    support_case string
    The deployment type of RDS Custom. Valid values:
    system_disk object

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    system_disk_id string
    The ID of the system disk attached to the Custom instance.
    tags map(string)
    Details of the queried instances and their tags.
    vswitch_id string

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    zone_id string

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    amount Integer

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    autoPay Boolean
    Specifies whether to enable automatic payment. Valid values:
    autoRenew Boolean
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    createExtraParam String
    Reserved parameters are not supported.
    createMode String
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    dataDisks List<CustomDataDisk>
    List of data disks. See dataDisk below.
    deploymentSetId String
    Deployment set ID.
    description String
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    direction String

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    dryRun Boolean
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    force Boolean
    Specifies whether to forcibly release a running instance. Valid values:
    forceStop Boolean
    Specifies whether to force shut down the instance. Valid values:
    hostName String

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    imageId String

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instanceChargeType String

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instanceName String
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    instanceType String
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    internetChargeType String

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    internetMaxBandwidthOut Integer

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    ioOptimized String

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    keyPairName String

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    password String

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period Integer

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    periodUnit String

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    privateIpAddress String
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    regionId String
    The region ID.
    resourceGroupId String
    The resource group ID. You can call ListResourceGroups to obtain it.
    securityEnhancementStrategy String

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    securityGroupIds List<String>

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    spotStrategy String

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    status String
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    supportCase String
    The deployment type of RDS Custom. Valid values:
    systemDisk CustomSystemDisk

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    systemDiskId String
    The ID of the system disk attached to the Custom instance.
    tags Map<String,String>
    Details of the queried instances and their tags.
    vswitchId String

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    zoneId String

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    amount number

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    autoPay boolean
    Specifies whether to enable automatic payment. Valid values:
    autoRenew boolean
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    createExtraParam string
    Reserved parameters are not supported.
    createMode string
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    dataDisks CustomDataDisk[]
    List of data disks. See dataDisk below.
    deploymentSetId string
    Deployment set ID.
    description string
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    direction string

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    dryRun boolean
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    force boolean
    Specifies whether to forcibly release a running instance. Valid values:
    forceStop boolean
    Specifies whether to force shut down the instance. Valid values:
    hostName string

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    imageId string

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instanceChargeType string

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instanceName string
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    instanceType string
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    internetChargeType string

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    internetMaxBandwidthOut number

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    ioOptimized string

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    keyPairName string

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    password string

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period number

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    periodUnit string

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    privateIpAddress string
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    regionId string
    The region ID.
    resourceGroupId string
    The resource group ID. You can call ListResourceGroups to obtain it.
    securityEnhancementStrategy string

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    securityGroupIds string[]

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    spotStrategy string

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    status string
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    supportCase string
    The deployment type of RDS Custom. Valid values:
    systemDisk CustomSystemDisk

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    systemDiskId string
    The ID of the system disk attached to the Custom instance.
    tags {[key: string]: string}
    Details of the queried instances and their tags.
    vswitchId string

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    zoneId string

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    amount int

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    auto_pay bool
    Specifies whether to enable automatic payment. Valid values:
    auto_renew bool
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    create_extra_param str
    Reserved parameters are not supported.
    create_mode str
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    data_disks Sequence[CustomDataDiskArgs]
    List of data disks. See dataDisk below.
    deployment_set_id str
    Deployment set ID.
    description str
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    direction str

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    dry_run bool
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    force bool
    Specifies whether to forcibly release a running instance. Valid values:
    force_stop bool
    Specifies whether to force shut down the instance. Valid values:
    host_name str

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    image_id str

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instance_charge_type str

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instance_name str
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    instance_type str
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    internet_charge_type str

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    internet_max_bandwidth_out int

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    io_optimized str

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    key_pair_name str

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    password str

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period int

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period_unit str

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    private_ip_address str
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    region_id str
    The region ID.
    resource_group_id str
    The resource group ID. You can call ListResourceGroups to obtain it.
    security_enhancement_strategy str

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    security_group_ids Sequence[str]

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    spot_strategy str

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    status str
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    support_case str
    The deployment type of RDS Custom. Valid values:
    system_disk CustomSystemDiskArgs

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    system_disk_id str
    The ID of the system disk attached to the Custom instance.
    tags Mapping[str, str]
    Details of the queried instances and their tags.
    vswitch_id str

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    zone_id str

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    amount Number

    Specifies the number of RDS Custom instances to create. This parameter applies only when creating multiple RDS Custom instances at once. Valid values: 1 to 5. Default value: 1.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    autoPay Boolean
    Specifies whether to enable automatic payment. Valid values:
    autoRenew Boolean
    Specifies whether the instance is automatically renewed. This parameter applies only when you create a subscription instance. Valid values:
    createExtraParam String
    Reserved parameters are not supported.
    createMode String
    Specifies whether the instance can be added to an ACK cluster. When this parameter is set to 1, the created instance can be added to an ACK cluster by using the AttachRCInstances API operation, enabling efficient management of containerized applications.
    dataDisks List<Property Map>
    List of data disks. See dataDisk below.
    deploymentSetId String
    Deployment set ID.
    description String
    The instance description. It must be 2 to 256 characters in length and cannot start with http:// or https://.
    direction String

    The instance specification change type. Valid values:

    NOTE: You do not need to specify this parameter because the system can automatically determine whether to upgrade or downgrade the instance. If you choose to specify it, follow the rules below:

    • Up (default): Upgrade the instance specification. Ensure that your account has sufficient balance.
    • Down: Downgrade the instance specification. Set Direction=Down when the instance type specified by InstanceType is lower than the current instance type.

    NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.

    dryRun Boolean
    Specifies whether to perform a dry run of the instance creation request. Valid values:
    force Boolean
    Specifies whether to forcibly release a running instance. Valid values:
    forceStop Boolean
    Specifies whether to force shut down the instance. Valid values:
    hostName String

    The hostname of the instance.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    imageId String

    The ID of the image used by the instance.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instanceChargeType String

    The billing method. Valid values:

    • Prepaid: subscription.
    • Postpaid: pay-as-you-go.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    instanceName String
    The name must be 2 to 128 characters in length, start with a letter or Chinese character, and can contain letters, Chinese characters, digits, periods (.), underscores (_), colons (:), or hyphens (-). By default, the instance name is the same as the InstanceId. When creating multiple RdsCustom instances, you can specify sequential instance names in batches by using square brackets ([]) and commas (,). For more information, see Create an RDS Custom instance.
    instanceType String
    The target instance type for configuration changes. For the list of instance types supported by RDS Custom instances, see RDS Custom Instance Types.
    internetChargeType String

    Reserved parameter. Not supported currently.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    internetMaxBandwidthOut Number

    The maximum outbound public bandwidth for Custom for SQL Server, measured in Mbit/s. Valid values: 0 to 1024. Default value: 0.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    ioOptimized String

    This parameter is reserved and currently unsupported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    keyPairName String

    The name of the key pair. Only a single key pair name is supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    password String

    The account password for the instance. It must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ()~!@#$%^&*-_+=|{}[]:;',.?/.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    period Number

    The subscription duration of the resource. Default value: 1.

    NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.

    periodUnit String

    The unit of subscription duration for the subscription billing method. Valid values:

    • Year: Year
    • Month (default): Month

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    privateIpAddress String
    The private IP address of the instance. When assigning a private IP address to an ECS instance in a Virtual Private Cloud (VPC), you must select an available IP address from the CIDR block of the specified vSwitch (VSwitchId).
    regionId String
    The region ID.
    resourceGroupId String
    The resource group ID. You can call ListResourceGroups to obtain it.
    securityEnhancementStrategy String

    This is a reserved parameter and is not currently supported.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    securityGroupIds List<String>

    The ID of the security group to which the instance belongs. Instances in the same security group can access each other. The maximum number of instances that a security group can contain depends on the security group type. For more information, see the "Security groups" section in Limits.

    NOTE: The SecurityGroupId determines the network type of the instance. For example, if the specified security group uses the Virtual Private Cloud (VPC) network type, the instance is of the VPC type and you must also specify the VSwitchId parameter.

    spotStrategy String

    The spot strategy for pay-as-you-go instances. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid values:

    • NoSpot: A regular pay-as-you-go instance.
    • SpotAsPriceGo: The system automatically bids based on the current market price.

    Default value: NoSpot.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    status String
    The status of the instance. Valid values:

    • Pending: The instance is being created.
    • Running: The instance is running.
    • Starting: The instance is starting.
    • Stopping: The instance is stopping.
    • Stopped: The instance is stopped.
    supportCase String
    The deployment type of RDS Custom. Valid values:
    systemDisk Property Map

    The system disk specification. See systemDisk below.

    NOTE: Since v1.279.0, systemDisk is treated as a ForceNew field. Any change to this field, including its nested category and size values, will force replacement of the alicloud.rds.Custom resource.

    systemDiskId String
    The ID of the system disk attached to the Custom instance.
    tags Map<String>
    Details of the queried instances and their tags.
    vswitchId String

    The virtual switch ID of the target instance. If you are creating a VPC-type RDS Custom instance, you must specify the virtual switch ID, and the security group and virtual switch must belong to the same Virtual Private Cloud (VPC).

    NOTE: If you specify the VSwitchId parameter, the ZoneId parameter you set must match the zone where the virtual switch is located. Alternatively, you can omit the ZoneId parameter, and the system will automatically select the zone of the specified virtual switch.

    zoneId String

    The zone ID of the instance. You can call DescribeZones to obtain the list of available zones.

    NOTE: If you specify the VSwitchId parameter, the specified ZoneId must match the zone where the vSwitch is located. Alternatively, you can omit ZoneId, and the system will automatically select the zone of the specified vSwitch.

    Supporting Types

    CustomDataDisk, CustomDataDiskArgs

    Category string
    The type of data disk. Valid values:
    PerformanceLevel string
    The performance level for an ESSD cloud disk. For information about performance differences among ESSD cloud disks, see ESSD cloud disks. Valid values:

    • PL0
    • PL1 (default)
    • PL2
    • PL3.
    Size int
    The size of the data disk, in GiB. Valid values:

    • cloud_efficiency: 20 to 32,768.
    • cloud_ssd: 20 to 32,768.
    • cloud_auto: 1 to 65,536.
    • cloud_essd: The valid range depends on the value of DataDisk.PerformanceLevel.
    • PL0: 1 to 65,536.
    • PL1: 20 to 65,536.
    • PL2: 461 to 65,536.
    • PL3: 1,261 to 65,536.
    Category string
    The type of data disk. Valid values:
    PerformanceLevel string
    The performance level for an ESSD cloud disk. For information about performance differences among ESSD cloud disks, see ESSD cloud disks. Valid values:

    • PL0
    • PL1 (default)
    • PL2
    • PL3.
    Size int
    The size of the data disk, in GiB. Valid values:

    • cloud_efficiency: 20 to 32,768.
    • cloud_ssd: 20 to 32,768.
    • cloud_auto: 1 to 65,536.
    • cloud_essd: The valid range depends on the value of DataDisk.PerformanceLevel.
    • PL0: 1 to 65,536.
    • PL1: 20 to 65,536.
    • PL2: 461 to 65,536.
    • PL3: 1,261 to 65,536.
    category string
    The type of data disk. Valid values:
    performance_level string
    The performance level for an ESSD cloud disk. For information about performance differences among ESSD cloud disks, see ESSD cloud disks. Valid values:

    • PL0
    • PL1 (default)
    • PL2
    • PL3.
    size number
    The size of the data disk, in GiB. Valid values:

    • cloud_efficiency: 20 to 32,768.
    • cloud_ssd: 20 to 32,768.
    • cloud_auto: 1 to 65,536.
    • cloud_essd: The valid range depends on the value of DataDisk.PerformanceLevel.
    • PL0: 1 to 65,536.
    • PL1: 20 to 65,536.
    • PL2: 461 to 65,536.
    • PL3: 1,261 to 65,536.
    category String
    The type of data disk. Valid values:
    performanceLevel String
    The performance level for an ESSD cloud disk. For information about performance differences among ESSD cloud disks, see ESSD cloud disks. Valid values:

    • PL0
    • PL1 (default)
    • PL2
    • PL3.
    size Integer
    The size of the data disk, in GiB. Valid values:

    • cloud_efficiency: 20 to 32,768.
    • cloud_ssd: 20 to 32,768.
    • cloud_auto: 1 to 65,536.
    • cloud_essd: The valid range depends on the value of DataDisk.PerformanceLevel.
    • PL0: 1 to 65,536.
    • PL1: 20 to 65,536.
    • PL2: 461 to 65,536.
    • PL3: 1,261 to 65,536.
    category string
    The type of data disk. Valid values:
    performanceLevel string
    The performance level for an ESSD cloud disk. For information about performance differences among ESSD cloud disks, see ESSD cloud disks. Valid values:

    • PL0
    • PL1 (default)
    • PL2
    • PL3.
    size number
    The size of the data disk, in GiB. Valid values:

    • cloud_efficiency: 20 to 32,768.
    • cloud_ssd: 20 to 32,768.
    • cloud_auto: 1 to 65,536.
    • cloud_essd: The valid range depends on the value of DataDisk.PerformanceLevel.
    • PL0: 1 to 65,536.
    • PL1: 20 to 65,536.
    • PL2: 461 to 65,536.
    • PL3: 1,261 to 65,536.
    category str
    The type of data disk. Valid values:
    performance_level str
    The performance level for an ESSD cloud disk. For information about performance differences among ESSD cloud disks, see ESSD cloud disks. Valid values:

    • PL0
    • PL1 (default)
    • PL2
    • PL3.
    size int
    The size of the data disk, in GiB. Valid values:

    • cloud_efficiency: 20 to 32,768.
    • cloud_ssd: 20 to 32,768.
    • cloud_auto: 1 to 65,536.
    • cloud_essd: The valid range depends on the value of DataDisk.PerformanceLevel.
    • PL0: 1 to 65,536.
    • PL1: 20 to 65,536.
    • PL2: 461 to 65,536.
    • PL3: 1,261 to 65,536.
    category String
    The type of data disk. Valid values:
    performanceLevel String
    The performance level for an ESSD cloud disk. For information about performance differences among ESSD cloud disks, see ESSD cloud disks. Valid values:

    • PL0
    • PL1 (default)
    • PL2
    • PL3.
    size Number
    The size of the data disk, in GiB. Valid values:

    • cloud_efficiency: 20 to 32,768.
    • cloud_ssd: 20 to 32,768.
    • cloud_auto: 1 to 65,536.
    • cloud_essd: The valid range depends on the value of DataDisk.PerformanceLevel.
    • PL0: 1 to 65,536.
    • PL1: 20 to 65,536.
    • PL2: 461 to 65,536.
    • PL3: 1,261 to 65,536.

    CustomSystemDisk, CustomSystemDiskArgs

    Category string
    The system disk category. Valid values:
    Size string
    The size of the system disk, in GiB. The value must be greater than or equal to the size of the image specified by the ImageId parameter.
    Category string
    The system disk category. Valid values:
    Size string
    The size of the system disk, in GiB. The value must be greater than or equal to the size of the image specified by the ImageId parameter.
    category string
    The system disk category. Valid values:
    size string
    The size of the system disk, in GiB. The value must be greater than or equal to the size of the image specified by the ImageId parameter.
    category String
    The system disk category. Valid values:
    size String
    The size of the system disk, in GiB. The value must be greater than or equal to the size of the image specified by the ImageId parameter.
    category string
    The system disk category. Valid values:
    size string
    The size of the system disk, in GiB. The value must be greater than or equal to the size of the image specified by the ImageId parameter.
    category str
    The system disk category. Valid values:
    size str
    The size of the system disk, in GiB. The value must be greater than or equal to the size of the image specified by the ImageId parameter.
    category String
    The system disk category. Valid values:
    size String
    The size of the system disk, in GiB. The value must be greater than or equal to the size of the image specified by the ImageId parameter.

    Import

    RDS Custom can be imported using the id, e.g.

    $ pulumi import alicloud:rds/custom:Custom example <instance_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.
    alicloud logo
    Viewing docs for Alibaba Cloud v3.104.0
    published on Thursday, Jun 25, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial