alicloud.rds.Custom
Explore with Pulumi AI
Provides a RDS Custom resource.
Dedicated RDS User host.
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.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var 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: {}
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,
internet_charge_type: 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,
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,
auto_renew: Optional[bool] = None,
create_extra_param: Optional[str] = None,
amount: Optional[int] = None,
password: Optional[str] = None,
key_pair_name: Optional[str] = None,
internet_max_bandwidth_out: Optional[int] = None,
period: Optional[int] = None,
period_unit: 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.
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",
InternetChargeType = "string",
IoOptimized = "string",
CreateMode = "string",
DataDisks = new[]
{
new AliCloud.Rds.Inputs.CustomDataDiskArgs
{
Category = "string",
PerformanceLevel = "string",
Size = 0,
},
},
DeploymentSetId = "string",
Description = "string",
Direction = "string",
DryRun = false,
Force = false,
ForceStop = false,
HostName = "string",
ImageId = "string",
InstanceChargeType = "string",
AutoRenew = false,
CreateExtraParam = "string",
Amount = 0,
Password = "string",
KeyPairName = "string",
InternetMaxBandwidthOut = 0,
Period = 0,
PeriodUnit = "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"),
InternetChargeType: 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"),
Direction: pulumi.String("string"),
DryRun: pulumi.Bool(false),
Force: pulumi.Bool(false),
ForceStop: pulumi.Bool(false),
HostName: pulumi.String("string"),
ImageId: pulumi.String("string"),
InstanceChargeType: pulumi.String("string"),
AutoRenew: pulumi.Bool(false),
CreateExtraParam: pulumi.String("string"),
Amount: pulumi.Int(0),
Password: pulumi.String("string"),
KeyPairName: pulumi.String("string"),
InternetMaxBandwidthOut: pulumi.Int(0),
Period: pulumi.Int(0),
PeriodUnit: 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"),
})
var customResource = new Custom("customResource", CustomArgs.builder()
.instanceType("string")
.vswitchId("string")
.internetChargeType("string")
.ioOptimized("string")
.createMode("string")
.dataDisks(CustomDataDiskArgs.builder()
.category("string")
.performanceLevel("string")
.size(0)
.build())
.deploymentSetId("string")
.description("string")
.direction("string")
.dryRun(false)
.force(false)
.forceStop(false)
.hostName("string")
.imageId("string")
.instanceChargeType("string")
.autoRenew(false)
.createExtraParam("string")
.amount(0)
.password("string")
.keyPairName("string")
.internetMaxBandwidthOut(0)
.period(0)
.periodUnit("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",
internet_charge_type="string",
io_optimized="string",
create_mode="string",
data_disks=[{
"category": "string",
"performance_level": "string",
"size": 0,
}],
deployment_set_id="string",
description="string",
direction="string",
dry_run=False,
force=False,
force_stop=False,
host_name="string",
image_id="string",
instance_charge_type="string",
auto_renew=False,
create_extra_param="string",
amount=0,
password="string",
key_pair_name="string",
internet_max_bandwidth_out=0,
period=0,
period_unit="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",
internetChargeType: "string",
ioOptimized: "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",
autoRenew: false,
createExtraParam: "string",
amount: 0,
password: "string",
keyPairName: "string",
internetMaxBandwidthOut: 0,
period: 0,
periodUnit: "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
instanceType: string
internetChargeType: string
internetMaxBandwidthOut: 0
ioOptimized: string
keyPairName: string
password: string
period: 0
periodUnit: 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:
- Instance
Type string - The type of the created RDS Custom dedicated host instance.
- Vswitch
Id string - The ID of the virtual switch. The zone in which the vSwitch is located must correspond to the zone ID entered in ZoneId. The network type InstanceNetworkType must be VPC.
- Amount int
- Represents the number of instances created
- Auto
Pay bool - Whether to pay automatically. Value range:
- Auto
Renew bool - Whether the instance is automatically renewed. Valid values: true/false. The default is false.
- Create
Extra stringParam - Reserved parameters are not supported.
- Create
Mode string - Whether to allow joining the ACK cluster. When this parameter is set to
1
, the created instance can be added to the ACK cluster through TheAttachRCInstances
API to efficiently manage container applications. - Data
Disks List<Pulumi.Ali Cloud. Rds. Inputs. Custom Data Disk> - Data disk See
data_disk
below. - Deployment
Set stringId - The ID of the deployment set.
- Description string
- Instance description. It must be 2 to 256 characters in length and cannot start with http:// or https.
- Direction string
Instance configuration type, value range:
NOTE: This parameter does not need to be uploaded, and the system can automatically determine whether to upgrade or downgrade. If you want to upload, please follow the following logic rules.
Up
(default): upgrade the instance specification. Please ensure that your account balance is sufficient.Down
: Downgrade instance specifications. When the instance type set to InstanceType is lower than the current instance type, set Direction = down.
- Dry
Run bool - Whether to pre-check the operation of creating an instance. Valid values:
- Force bool
- Whether to forcibly release the running instance. Value: true/false
- Force
Stop bool - Whether to force shutdown. Value range:
- Host
Name string - The instance host name.
- Image
Id string - The ID of the image used by the instance.
- Instance
Charge stringType - The Payment type. Currently, only
Prepaid
(package year and month) types are supported. - Internet
Charge stringType - Reserved parameters are not supported.
- Internet
Max intBandwidth Out - Reserved parameters are not supported.
- Io
Optimized string - Reserved parameters are not supported.
- Key
Pair stringName - The key pair name. Only flyer names are supported.
- Password string
- The account and password of the instance.
- Period int
- Prepaid renewal duration, unit: Month/Year.
- Period
Unit string - The unit of duration of the year-to-month billing method. Value range:
Year
: YearMonth
(default): Month
- Resource
Group stringId - The ID of the resource group
- Security
Enhancement stringStrategy - Reserved parameters are not supported.
- Security
Group List<string>Ids - Security group list
- Spot
Strategy string The bidding strategy for pay-as-you-go instances. This parameter takes effect when the value of
InstanceChargeType
is set to **PostPaid. Value range:NoSpot
: normal pay-as-you-go instances.SpotAsPriceGo
: The system automatically bids and follows the actual price in the current market.
Default value: **NoSpot * *.
- Status string
- The status of the resource
- Support
Case string - Supported scenarios: createMode:supportCase, for example: NATIVE("0", "eni"),RCK("1", "rck"),ACK_EDGE("1", "edge");
- System
Disk Pulumi.Ali Cloud. Rds. Inputs. Custom System Disk - System disk specifications. See
system_disk
below. - Dictionary<string, string>
- The tag of the resource
- Zone
Id string - The zone ID of the resource
- Instance
Type string - The type of the created RDS Custom dedicated host instance.
- Vswitch
Id string - The ID of the virtual switch. The zone in which the vSwitch is located must correspond to the zone ID entered in ZoneId. The network type InstanceNetworkType must be VPC.
- Amount int
- Represents the number of instances created
- Auto
Pay bool - Whether to pay automatically. Value range:
- Auto
Renew bool - Whether the instance is automatically renewed. Valid values: true/false. The default is false.
- Create
Extra stringParam - Reserved parameters are not supported.
- Create
Mode string - Whether to allow joining the ACK cluster. When this parameter is set to
1
, the created instance can be added to the ACK cluster through TheAttachRCInstances
API to efficiently manage container applications. - Data
Disks []CustomData Disk Args - Data disk See
data_disk
below. - Deployment
Set stringId - The ID of the deployment set.
- Description string
- Instance description. It must be 2 to 256 characters in length and cannot start with http:// or https.
- Direction string
Instance configuration type, value range:
NOTE: This parameter does not need to be uploaded, and the system can automatically determine whether to upgrade or downgrade. If you want to upload, please follow the following logic rules.
Up
(default): upgrade the instance specification. Please ensure that your account balance is sufficient.Down
: Downgrade instance specifications. When the instance type set to InstanceType is lower than the current instance type, set Direction = down.
- Dry
Run bool - Whether to pre-check the operation of creating an instance. Valid values:
- Force bool
- Whether to forcibly release the running instance. Value: true/false
- Force
Stop bool - Whether to force shutdown. Value range:
- Host
Name string - The instance host name.
- Image
Id string - The ID of the image used by the instance.
- Instance
Charge stringType - The Payment type. Currently, only
Prepaid
(package year and month) types are supported. - Internet
Charge stringType - Reserved parameters are not supported.
- Internet
Max intBandwidth Out - Reserved parameters are not supported.
- Io
Optimized string - Reserved parameters are not supported.
- Key
Pair stringName - The key pair name. Only flyer names are supported.
- Password string
- The account and password of the instance.
- Period int
- Prepaid renewal duration, unit: Month/Year.
- Period
Unit string - The unit of duration of the year-to-month billing method. Value range:
Year
: YearMonth
(default): Month
- Resource
Group stringId - The ID of the resource group
- Security
Enhancement stringStrategy - Reserved parameters are not supported.
- Security
Group []stringIds - Security group list
- Spot
Strategy string The bidding strategy for pay-as-you-go instances. This parameter takes effect when the value of
InstanceChargeType
is set to **PostPaid. Value range:NoSpot
: normal pay-as-you-go instances.SpotAsPriceGo
: The system automatically bids and follows the actual price in the current market.
Default value: **NoSpot * *.
- Status string
- The status of the resource
- Support
Case string - Supported scenarios: createMode:supportCase, for example: NATIVE("0", "eni"),RCK("1", "rck"),ACK_EDGE("1", "edge");
- System
Disk CustomSystem Disk Args - System disk specifications. See
system_disk
below. - map[string]string
- The tag of the resource
- Zone
Id string - The zone ID of the resource
- instance
Type String - The type of the created RDS Custom dedicated host instance.
- vswitch
Id String - The ID of the virtual switch. The zone in which the vSwitch is located must correspond to the zone ID entered in ZoneId. The network type InstanceNetworkType must be VPC.
- amount Integer
- Represents the number of instances created
- auto
Pay Boolean - Whether to pay automatically. Value range:
- auto
Renew Boolean - Whether the instance is automatically renewed. Valid values: true/false. The default is false.
- create
Extra StringParam - Reserved parameters are not supported.
- create
Mode String - Whether to allow joining the ACK cluster. When this parameter is set to
1
, the created instance can be added to the ACK cluster through TheAttachRCInstances
API to efficiently manage container applications. - data
Disks List<CustomData Disk> - Data disk See
data_disk
below. - deployment
Set StringId - The ID of the deployment set.
- description String
- Instance description. It must be 2 to 256 characters in length and cannot start with http:// or https.
- direction String
Instance configuration type, value range:
NOTE: This parameter does not need to be uploaded, and the system can automatically determine whether to upgrade or downgrade. If you want to upload, please follow the following logic rules.
Up
(default): upgrade the instance specification. Please ensure that your account balance is sufficient.Down
: Downgrade instance specifications. When the instance type set to InstanceType is lower than the current instance type, set Direction = down.
- dry
Run Boolean - Whether to pre-check the operation of creating an instance. Valid values:
- force Boolean
- Whether to forcibly release the running instance. Value: true/false
- force
Stop Boolean - Whether to force shutdown. Value range:
- host
Name String - The instance host name.
- image
Id String - The ID of the image used by the instance.
- instance
Charge StringType - The Payment type. Currently, only
Prepaid
(package year and month) types are supported. - internet
Charge StringType - Reserved parameters are not supported.
- internet
Max IntegerBandwidth Out - Reserved parameters are not supported.
- io
Optimized String - Reserved parameters are not supported.
- key
Pair StringName - The key pair name. Only flyer names are supported.
- password String
- The account and password of the instance.
- period Integer
- Prepaid renewal duration, unit: Month/Year.
- period
Unit String - The unit of duration of the year-to-month billing method. Value range:
Year
: YearMonth
(default): Month
- resource
Group StringId - The ID of the resource group
- security
Enhancement StringStrategy - Reserved parameters are not supported.
- security
Group List<String>Ids - Security group list
- spot
Strategy String The bidding strategy for pay-as-you-go instances. This parameter takes effect when the value of
InstanceChargeType
is set to **PostPaid. Value range:NoSpot
: normal pay-as-you-go instances.SpotAsPriceGo
: The system automatically bids and follows the actual price in the current market.
Default value: **NoSpot * *.
- status String
- The status of the resource
- support
Case String - Supported scenarios: createMode:supportCase, for example: NATIVE("0", "eni"),RCK("1", "rck"),ACK_EDGE("1", "edge");
- system
Disk CustomSystem Disk - System disk specifications. See
system_disk
below. - Map<String,String>
- The tag of the resource
- zone
Id String - The zone ID of the resource
- instance
Type string - The type of the created RDS Custom dedicated host instance.
- vswitch
Id string - The ID of the virtual switch. The zone in which the vSwitch is located must correspond to the zone ID entered in ZoneId. The network type InstanceNetworkType must be VPC.
- amount number
- Represents the number of instances created
- auto
Pay boolean - Whether to pay automatically. Value range:
- auto
Renew boolean - Whether the instance is automatically renewed. Valid values: true/false. The default is false.
- create
Extra stringParam - Reserved parameters are not supported.
- create
Mode string - Whether to allow joining the ACK cluster. When this parameter is set to
1
, the created instance can be added to the ACK cluster through TheAttachRCInstances
API to efficiently manage container applications. - data
Disks CustomData Disk[] - Data disk See
data_disk
below. - deployment
Set stringId - The ID of the deployment set.
- description string
- Instance description. It must be 2 to 256 characters in length and cannot start with http:// or https.
- direction string
Instance configuration type, value range:
NOTE: This parameter does not need to be uploaded, and the system can automatically determine whether to upgrade or downgrade. If you want to upload, please follow the following logic rules.
Up
(default): upgrade the instance specification. Please ensure that your account balance is sufficient.Down
: Downgrade instance specifications. When the instance type set to InstanceType is lower than the current instance type, set Direction = down.
- dry
Run boolean - Whether to pre-check the operation of creating an instance. Valid values:
- force boolean
- Whether to forcibly release the running instance. Value: true/false
- force
Stop boolean - Whether to force shutdown. Value range:
- host
Name string - The instance host name.
- image
Id string - The ID of the image used by the instance.
- instance
Charge stringType - The Payment type. Currently, only
Prepaid
(package year and month) types are supported. - internet
Charge stringType - Reserved parameters are not supported.
- internet
Max numberBandwidth Out - Reserved parameters are not supported.
- io
Optimized string - Reserved parameters are not supported.
- key
Pair stringName - The key pair name. Only flyer names are supported.
- password string
- The account and password of the instance.
- period number
- Prepaid renewal duration, unit: Month/Year.
- period
Unit string - The unit of duration of the year-to-month billing method. Value range:
Year
: YearMonth
(default): Month
- resource
Group stringId - The ID of the resource group
- security
Enhancement stringStrategy - Reserved parameters are not supported.
- security
Group string[]Ids - Security group list
- spot
Strategy string The bidding strategy for pay-as-you-go instances. This parameter takes effect when the value of
InstanceChargeType
is set to **PostPaid. Value range:NoSpot
: normal pay-as-you-go instances.SpotAsPriceGo
: The system automatically bids and follows the actual price in the current market.
Default value: **NoSpot * *.
- status string
- The status of the resource
- support
Case string - Supported scenarios: createMode:supportCase, for example: NATIVE("0", "eni"),RCK("1", "rck"),ACK_EDGE("1", "edge");
- system
Disk CustomSystem Disk - System disk specifications. See
system_disk
below. - {[key: string]: string}
- The tag of the resource
- zone
Id string - The zone ID of the resource
- instance_
type str - The type of the created RDS Custom dedicated host instance.
- vswitch_
id str - The ID of the virtual switch. The zone in which the vSwitch is located must correspond to the zone ID entered in ZoneId. The network type InstanceNetworkType must be VPC.
- amount int
- Represents the number of instances created
- auto_
pay bool - Whether to pay automatically. Value range:
- auto_
renew bool - Whether the instance is automatically renewed. Valid values: true/false. The default is false.
- create_
extra_ strparam - Reserved parameters are not supported.
- create_
mode str - Whether to allow joining the ACK cluster. When this parameter is set to
1
, the created instance can be added to the ACK cluster through TheAttachRCInstances
API to efficiently manage container applications. - data_
disks Sequence[CustomData Disk Args] - Data disk See
data_disk
below. - deployment_
set_ strid - The ID of the deployment set.
- description str
- Instance description. It must be 2 to 256 characters in length and cannot start with http:// or https.
- direction str
Instance configuration type, value range:
NOTE: This parameter does not need to be uploaded, and the system can automatically determine whether to upgrade or downgrade. If you want to upload, please follow the following logic rules.
Up
(default): upgrade the instance specification. Please ensure that your account balance is sufficient.Down
: Downgrade instance specifications. When the instance type set to InstanceType is lower than the current instance type, set Direction = down.
- dry_
run bool - Whether to pre-check the operation of creating an instance. Valid values:
- force bool
- Whether to forcibly release the running instance. Value: true/false
- force_
stop bool - Whether to force shutdown. Value range:
- host_
name str - The instance host name.
- image_
id str - The ID of the image used by the instance.
- instance_
charge_ strtype - The Payment type. Currently, only
Prepaid
(package year and month) types are supported. - internet_
charge_ strtype - Reserved parameters are not supported.
- internet_
max_ intbandwidth_ out - Reserved parameters are not supported.
- io_
optimized str - Reserved parameters are not supported.
- key_
pair_ strname - The key pair name. Only flyer names are supported.
- password str
- The account and password of the instance.
- period int
- Prepaid renewal duration, unit: Month/Year.
- period_
unit str - The unit of duration of the year-to-month billing method. Value range:
Year
: YearMonth
(default): Month
- resource_
group_ strid - The ID of the resource group
- security_
enhancement_ strstrategy - Reserved parameters are not supported.
- security_
group_ Sequence[str]ids - Security group list
- spot_
strategy str The bidding strategy for pay-as-you-go instances. This parameter takes effect when the value of
InstanceChargeType
is set to **PostPaid. Value range:NoSpot
: normal pay-as-you-go instances.SpotAsPriceGo
: The system automatically bids and follows the actual price in the current market.
Default value: **NoSpot * *.
- status str
- The status of the resource
- support_
case str - Supported scenarios: createMode:supportCase, for example: NATIVE("0", "eni"),RCK("1", "rck"),ACK_EDGE("1", "edge");
- system_
disk CustomSystem Disk Args - System disk specifications. See
system_disk
below. - Mapping[str, str]
- The tag of the resource
- zone_
id str - The zone ID of the resource
- instance
Type String - The type of the created RDS Custom dedicated host instance.
- vswitch
Id String - The ID of the virtual switch. The zone in which the vSwitch is located must correspond to the zone ID entered in ZoneId. The network type InstanceNetworkType must be VPC.
- amount Number
- Represents the number of instances created
- auto
Pay Boolean - Whether to pay automatically. Value range:
- auto
Renew Boolean - Whether the instance is automatically renewed. Valid values: true/false. The default is false.
- create
Extra StringParam - Reserved parameters are not supported.
- create
Mode String - Whether to allow joining the ACK cluster. When this parameter is set to
1
, the created instance can be added to the ACK cluster through TheAttachRCInstances
API to efficiently manage container applications. - data
Disks List<Property Map> - Data disk See
data_disk
below. - deployment
Set StringId - The ID of the deployment set.
- description String
- Instance description. It must be 2 to 256 characters in length and cannot start with http:// or https.
- direction String
Instance configuration type, value range:
NOTE: This parameter does not need to be uploaded, and the system can automatically determine whether to upgrade or downgrade. If you want to upload, please follow the following logic rules.
Up
(default): upgrade the instance specification. Please ensure that your account balance is sufficient.Down
: Downgrade instance specifications. When the instance type set to InstanceType is lower than the current instance type, set Direction = down.
- dry
Run Boolean - Whether to pre-check the operation of creating an instance. Valid values:
- force Boolean
- Whether to forcibly release the running instance. Value: true/false
- force
Stop Boolean - Whether to force shutdown. Value range:
- host
Name String - The instance host name.
- image
Id String - The ID of the image used by the instance.
- instance
Charge StringType - The Payment type. Currently, only
Prepaid
(package year and month) types are supported. - internet
Charge StringType - Reserved parameters are not supported.
- internet
Max NumberBandwidth Out - Reserved parameters are not supported.
- io
Optimized String - Reserved parameters are not supported.
- key
Pair StringName - The key pair name. Only flyer names are supported.
- password String
- The account and password of the instance.
- period Number
- Prepaid renewal duration, unit: Month/Year.
- period
Unit String - The unit of duration of the year-to-month billing method. Value range:
Year
: YearMonth
(default): Month
- resource
Group StringId - The ID of the resource group
- security
Enhancement StringStrategy - Reserved parameters are not supported.
- security
Group List<String>Ids - Security group list
- spot
Strategy String The bidding strategy for pay-as-you-go instances. This parameter takes effect when the value of
InstanceChargeType
is set to **PostPaid. Value range:NoSpot
: normal pay-as-you-go instances.SpotAsPriceGo
: The system automatically bids and follows the actual price in the current market.
Default value: **NoSpot * *.
- status String
- The status of the resource
- support
Case String - Supported scenarios: createMode:supportCase, for example: NATIVE("0", "eni"),RCK("1", "rck"),ACK_EDGE("1", "edge");
- system
Disk Property Map - System disk specifications. See
system_disk
below. - Map<String>
- The tag of the resource
- zone
Id String - The zone ID of the resource
Outputs
All input properties are implicitly available as output properties. Additionally, the Custom resource produces the following output properties:
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_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,
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,
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}
- 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.
- Amount int
- Represents the number of instances created
- Auto
Pay bool - Whether to pay automatically. Value range:
- Auto
Renew bool - Whether the instance is automatically renewed. Valid values: true/false. The default is false.
- Create
Extra stringParam - Reserved parameters are not supported.
- Create
Mode string - Whether to allow joining the ACK cluster. When this parameter is set to
1
, the created instance can be added to the ACK cluster through TheAttachRCInstances
API to efficiently manage container applications. - Data
Disks List<Pulumi.Ali Cloud. Rds. Inputs. Custom Data Disk> - Data disk See
data_disk
below. - Deployment
Set stringId - The ID of the deployment set.
- Description string
- Instance description. It must be 2 to 256 characters in length and cannot start with http:// or https.
- Direction string
Instance configuration type, value range:
NOTE: This parameter does not need to be uploaded, and the system can automatically determine whether to upgrade or downgrade. If you want to upload, please follow the following logic rules.
Up
(default): upgrade the instance specification. Please ensure that your account balance is sufficient.Down
: Downgrade instance specifications. When the instance type set to InstanceType is lower than the current instance type, set Direction = down.
- Dry
Run bool - Whether to pre-check the operation of creating an instance. Valid values:
- Force bool
- Whether to forcibly release the running instance. Value: true/false
- Force
Stop bool - Whether to force shutdown. Value range:
- Host
Name string - The instance host name.
- Image
Id string - The ID of the image used by the instance.
- Instance
Charge stringType - The Payment type. Currently, only
Prepaid
(package year and month) types are supported. - Instance
Type string - The type of the created RDS Custom dedicated host instance.
- Internet
Charge stringType - Reserved parameters are not supported.
- Internet
Max intBandwidth Out - Reserved parameters are not supported.
- Io
Optimized string - Reserved parameters are not supported.
- Key
Pair stringName - The key pair name. Only flyer names are supported.
- Password string
- The account and password of the instance.
- Period int
- Prepaid renewal duration, unit: Month/Year.
- Period
Unit string - The unit of duration of the year-to-month billing method. Value range:
Year
: YearMonth
(default): Month
- Region
Id string - The region ID. Callable DescribeRegions to get.
- Resource
Group stringId - The ID of the resource group
- Security
Enhancement stringStrategy - Reserved parameters are not supported.
- Security
Group List<string>Ids - Security group list
- Spot
Strategy string The bidding strategy for pay-as-you-go instances. This parameter takes effect when the value of
InstanceChargeType
is set to **PostPaid. Value range:NoSpot
: normal pay-as-you-go instances.SpotAsPriceGo
: The system automatically bids and follows the actual price in the current market.
Default value: **NoSpot * *.
- Status string
- The status of the resource
- Support
Case string - Supported scenarios: createMode:supportCase, for example: NATIVE("0", "eni"),RCK("1", "rck"),ACK_EDGE("1", "edge");
- System
Disk Pulumi.Ali Cloud. Rds. Inputs. Custom System Disk - System disk specifications. See
system_disk
below. - Dictionary<string, string>
- The tag of the resource
- Vswitch
Id string - The ID of the virtual switch. The zone in which the vSwitch is located must correspond to the zone ID entered in ZoneId. The network type InstanceNetworkType must be VPC.
- Zone
Id string - The zone ID of the resource
- Amount int
- Represents the number of instances created
- Auto
Pay bool - Whether to pay automatically. Value range:
- Auto
Renew bool - Whether the instance is automatically renewed. Valid values: true/false. The default is false.
- Create
Extra stringParam - Reserved parameters are not supported.
- Create
Mode string - Whether to allow joining the ACK cluster. When this parameter is set to
1
, the created instance can be added to the ACK cluster through TheAttachRCInstances
API to efficiently manage container applications. - Data
Disks []CustomData Disk Args - Data disk See
data_disk
below. - Deployment
Set stringId - The ID of the deployment set.
- Description string
- Instance description. It must be 2 to 256 characters in length and cannot start with http:// or https.
- Direction string
Instance configuration type, value range:
NOTE: This parameter does not need to be uploaded, and the system can automatically determine whether to upgrade or downgrade. If you want to upload, please follow the following logic rules.
Up
(default): upgrade the instance specification. Please ensure that your account balance is sufficient.Down
: Downgrade instance specifications. When the instance type set to InstanceType is lower than the current instance type, set Direction = down.
- Dry
Run bool - Whether to pre-check the operation of creating an instance. Valid values:
- Force bool
- Whether to forcibly release the running instance. Value: true/false
- Force
Stop bool - Whether to force shutdown. Value range:
- Host
Name string - The instance host name.
- Image
Id string - The ID of the image used by the instance.
- Instance
Charge stringType - The Payment type. Currently, only
Prepaid
(package year and month) types are supported. - Instance
Type string - The type of the created RDS Custom dedicated host instance.
- Internet
Charge stringType - Reserved parameters are not supported.
- Internet
Max intBandwidth Out - Reserved parameters are not supported.
- Io
Optimized string - Reserved parameters are not supported.
- Key
Pair stringName - The key pair name. Only flyer names are supported.
- Password string
- The account and password of the instance.
- Period int
- Prepaid renewal duration, unit: Month/Year.
- Period
Unit string - The unit of duration of the year-to-month billing method. Value range:
Year
: YearMonth
(default): Month
- Region
Id string - The region ID. Callable DescribeRegions to get.
- Resource
Group stringId - The ID of the resource group
- Security
Enhancement stringStrategy - Reserved parameters are not supported.
- Security
Group []stringIds - Security group list
- Spot
Strategy string The bidding strategy for pay-as-you-go instances. This parameter takes effect when the value of
InstanceChargeType
is set to **PostPaid. Value range:NoSpot
: normal pay-as-you-go instances.SpotAsPriceGo
: The system automatically bids and follows the actual price in the current market.
Default value: **NoSpot * *.
- Status string
- The status of the resource
- Support
Case string - Supported scenarios: createMode:supportCase, for example: NATIVE("0", "eni"),RCK("1", "rck"),ACK_EDGE("1", "edge");
- System
Disk CustomSystem Disk Args - System disk specifications. See
system_disk
below. - map[string]string
- The tag of the resource
- Vswitch
Id string - The ID of the virtual switch. The zone in which the vSwitch is located must correspond to the zone ID entered in ZoneId. The network type InstanceNetworkType must be VPC.
- Zone
Id string - The zone ID of the resource
- amount Integer
- Represents the number of instances created
- auto
Pay Boolean - Whether to pay automatically. Value range:
- auto
Renew Boolean - Whether the instance is automatically renewed. Valid values: true/false. The default is false.
- create
Extra StringParam - Reserved parameters are not supported.
- create
Mode String - Whether to allow joining the ACK cluster. When this parameter is set to
1
, the created instance can be added to the ACK cluster through TheAttachRCInstances
API to efficiently manage container applications. - data
Disks List<CustomData Disk> - Data disk See
data_disk
below. - deployment
Set StringId - The ID of the deployment set.
- description String
- Instance description. It must be 2 to 256 characters in length and cannot start with http:// or https.
- direction String
Instance configuration type, value range:
NOTE: This parameter does not need to be uploaded, and the system can automatically determine whether to upgrade or downgrade. If you want to upload, please follow the following logic rules.
Up
(default): upgrade the instance specification. Please ensure that your account balance is sufficient.Down
: Downgrade instance specifications. When the instance type set to InstanceType is lower than the current instance type, set Direction = down.
- dry
Run Boolean - Whether to pre-check the operation of creating an instance. Valid values:
- force Boolean
- Whether to forcibly release the running instance. Value: true/false
- force
Stop Boolean - Whether to force shutdown. Value range:
- host
Name String - The instance host name.
- image
Id String - The ID of the image used by the instance.
- instance
Charge StringType - The Payment type. Currently, only
Prepaid
(package year and month) types are supported. - instance
Type String - The type of the created RDS Custom dedicated host instance.
- internet
Charge StringType - Reserved parameters are not supported.
- internet
Max IntegerBandwidth Out - Reserved parameters are not supported.
- io
Optimized String - Reserved parameters are not supported.
- key
Pair StringName - The key pair name. Only flyer names are supported.
- password String
- The account and password of the instance.
- period Integer
- Prepaid renewal duration, unit: Month/Year.
- period
Unit String - The unit of duration of the year-to-month billing method. Value range:
Year
: YearMonth
(default): Month
- region
Id String - The region ID. Callable DescribeRegions to get.
- resource
Group StringId - The ID of the resource group
- security
Enhancement StringStrategy - Reserved parameters are not supported.
- security
Group List<String>Ids - Security group list
- spot
Strategy String The bidding strategy for pay-as-you-go instances. This parameter takes effect when the value of
InstanceChargeType
is set to **PostPaid. Value range:NoSpot
: normal pay-as-you-go instances.SpotAsPriceGo
: The system automatically bids and follows the actual price in the current market.
Default value: **NoSpot * *.
- status String
- The status of the resource
- support
Case String - Supported scenarios: createMode:supportCase, for example: NATIVE("0", "eni"),RCK("1", "rck"),ACK_EDGE("1", "edge");
- system
Disk CustomSystem Disk - System disk specifications. See
system_disk
below. - Map<String,String>
- The tag of the resource
- vswitch
Id String - The ID of the virtual switch. The zone in which the vSwitch is located must correspond to the zone ID entered in ZoneId. The network type InstanceNetworkType must be VPC.
- zone
Id String - The zone ID of the resource
- amount number
- Represents the number of instances created
- auto
Pay boolean - Whether to pay automatically. Value range:
- auto
Renew boolean - Whether the instance is automatically renewed. Valid values: true/false. The default is false.
- create
Extra stringParam - Reserved parameters are not supported.
- create
Mode string - Whether to allow joining the ACK cluster. When this parameter is set to
1
, the created instance can be added to the ACK cluster through TheAttachRCInstances
API to efficiently manage container applications. - data
Disks CustomData Disk[] - Data disk See
data_disk
below. - deployment
Set stringId - The ID of the deployment set.
- description string
- Instance description. It must be 2 to 256 characters in length and cannot start with http:// or https.
- direction string
Instance configuration type, value range:
NOTE: This parameter does not need to be uploaded, and the system can automatically determine whether to upgrade or downgrade. If you want to upload, please follow the following logic rules.
Up
(default): upgrade the instance specification. Please ensure that your account balance is sufficient.Down
: Downgrade instance specifications. When the instance type set to InstanceType is lower than the current instance type, set Direction = down.
- dry
Run boolean - Whether to pre-check the operation of creating an instance. Valid values:
- force boolean
- Whether to forcibly release the running instance. Value: true/false
- force
Stop boolean - Whether to force shutdown. Value range:
- host
Name string - The instance host name.
- image
Id string - The ID of the image used by the instance.
- instance
Charge stringType - The Payment type. Currently, only
Prepaid
(package year and month) types are supported. - instance
Type string - The type of the created RDS Custom dedicated host instance.
- internet
Charge stringType - Reserved parameters are not supported.
- internet
Max numberBandwidth Out - Reserved parameters are not supported.
- io
Optimized string - Reserved parameters are not supported.
- key
Pair stringName - The key pair name. Only flyer names are supported.
- password string
- The account and password of the instance.
- period number
- Prepaid renewal duration, unit: Month/Year.
- period
Unit string - The unit of duration of the year-to-month billing method. Value range:
Year
: YearMonth
(default): Month
- region
Id string - The region ID. Callable DescribeRegions to get.
- resource
Group stringId - The ID of the resource group
- security
Enhancement stringStrategy - Reserved parameters are not supported.
- security
Group string[]Ids - Security group list
- spot
Strategy string The bidding strategy for pay-as-you-go instances. This parameter takes effect when the value of
InstanceChargeType
is set to **PostPaid. Value range:NoSpot
: normal pay-as-you-go instances.SpotAsPriceGo
: The system automatically bids and follows the actual price in the current market.
Default value: **NoSpot * *.
- status string
- The status of the resource
- support
Case string - Supported scenarios: createMode:supportCase, for example: NATIVE("0", "eni"),RCK("1", "rck"),ACK_EDGE("1", "edge");
- system
Disk CustomSystem Disk - System disk specifications. See
system_disk
below. - {[key: string]: string}
- The tag of the resource
- vswitch
Id string - The ID of the virtual switch. The zone in which the vSwitch is located must correspond to the zone ID entered in ZoneId. The network type InstanceNetworkType must be VPC.
- zone
Id string - The zone ID of the resource
- amount int
- Represents the number of instances created
- auto_
pay bool - Whether to pay automatically. Value range:
- auto_
renew bool - Whether the instance is automatically renewed. Valid values: true/false. The default is false.
- create_
extra_ strparam - Reserved parameters are not supported.
- create_
mode str - Whether to allow joining the ACK cluster. When this parameter is set to
1
, the created instance can be added to the ACK cluster through TheAttachRCInstances
API to efficiently manage container applications. - data_
disks Sequence[CustomData Disk Args] - Data disk See
data_disk
below. - deployment_
set_ strid - The ID of the deployment set.
- description str
- Instance description. It must be 2 to 256 characters in length and cannot start with http:// or https.
- direction str
Instance configuration type, value range:
NOTE: This parameter does not need to be uploaded, and the system can automatically determine whether to upgrade or downgrade. If you want to upload, please follow the following logic rules.
Up
(default): upgrade the instance specification. Please ensure that your account balance is sufficient.Down
: Downgrade instance specifications. When the instance type set to InstanceType is lower than the current instance type, set Direction = down.
- dry_
run bool - Whether to pre-check the operation of creating an instance. Valid values:
- force bool
- Whether to forcibly release the running instance. Value: true/false
- force_
stop bool - Whether to force shutdown. Value range:
- host_
name str - The instance host name.
- image_
id str - The ID of the image used by the instance.
- instance_
charge_ strtype - The Payment type. Currently, only
Prepaid
(package year and month) types are supported. - instance_
type str - The type of the created RDS Custom dedicated host instance.
- internet_
charge_ strtype - Reserved parameters are not supported.
- internet_
max_ intbandwidth_ out - Reserved parameters are not supported.
- io_
optimized str - Reserved parameters are not supported.
- key_
pair_ strname - The key pair name. Only flyer names are supported.
- password str
- The account and password of the instance.
- period int
- Prepaid renewal duration, unit: Month/Year.
- period_
unit str - The unit of duration of the year-to-month billing method. Value range:
Year
: YearMonth
(default): Month
- region_
id str - The region ID. Callable DescribeRegions to get.
- resource_
group_ strid - The ID of the resource group
- security_
enhancement_ strstrategy - Reserved parameters are not supported.
- security_
group_ Sequence[str]ids - Security group list
- spot_
strategy str The bidding strategy for pay-as-you-go instances. This parameter takes effect when the value of
InstanceChargeType
is set to **PostPaid. Value range:NoSpot
: normal pay-as-you-go instances.SpotAsPriceGo
: The system automatically bids and follows the actual price in the current market.
Default value: **NoSpot * *.
- status str
- The status of the resource
- support_
case str - Supported scenarios: createMode:supportCase, for example: NATIVE("0", "eni"),RCK("1", "rck"),ACK_EDGE("1", "edge");
- system_
disk CustomSystem Disk Args - System disk specifications. See
system_disk
below. - Mapping[str, str]
- The tag of the resource
- vswitch_
id str - The ID of the virtual switch. The zone in which the vSwitch is located must correspond to the zone ID entered in ZoneId. The network type InstanceNetworkType must be VPC.
- zone_
id str - The zone ID of the resource
- amount Number
- Represents the number of instances created
- auto
Pay Boolean - Whether to pay automatically. Value range:
- auto
Renew Boolean - Whether the instance is automatically renewed. Valid values: true/false. The default is false.
- create
Extra StringParam - Reserved parameters are not supported.
- create
Mode String - Whether to allow joining the ACK cluster. When this parameter is set to
1
, the created instance can be added to the ACK cluster through TheAttachRCInstances
API to efficiently manage container applications. - data
Disks List<Property Map> - Data disk See
data_disk
below. - deployment
Set StringId - The ID of the deployment set.
- description String
- Instance description. It must be 2 to 256 characters in length and cannot start with http:// or https.
- direction String
Instance configuration type, value range:
NOTE: This parameter does not need to be uploaded, and the system can automatically determine whether to upgrade or downgrade. If you want to upload, please follow the following logic rules.
Up
(default): upgrade the instance specification. Please ensure that your account balance is sufficient.Down
: Downgrade instance specifications. When the instance type set to InstanceType is lower than the current instance type, set Direction = down.
- dry
Run Boolean - Whether to pre-check the operation of creating an instance. Valid values:
- force Boolean
- Whether to forcibly release the running instance. Value: true/false
- force
Stop Boolean - Whether to force shutdown. Value range:
- host
Name String - The instance host name.
- image
Id String - The ID of the image used by the instance.
- instance
Charge StringType - The Payment type. Currently, only
Prepaid
(package year and month) types are supported. - instance
Type String - The type of the created RDS Custom dedicated host instance.
- internet
Charge StringType - Reserved parameters are not supported.
- internet
Max NumberBandwidth Out - Reserved parameters are not supported.
- io
Optimized String - Reserved parameters are not supported.
- key
Pair StringName - The key pair name. Only flyer names are supported.
- password String
- The account and password of the instance.
- period Number
- Prepaid renewal duration, unit: Month/Year.
- period
Unit String - The unit of duration of the year-to-month billing method. Value range:
Year
: YearMonth
(default): Month
- region
Id String - The region ID. Callable DescribeRegions to get.
- resource
Group StringId - The ID of the resource group
- security
Enhancement StringStrategy - Reserved parameters are not supported.
- security
Group List<String>Ids - Security group list
- spot
Strategy String The bidding strategy for pay-as-you-go instances. This parameter takes effect when the value of
InstanceChargeType
is set to **PostPaid. Value range:NoSpot
: normal pay-as-you-go instances.SpotAsPriceGo
: The system automatically bids and follows the actual price in the current market.
Default value: **NoSpot * *.
- status String
- The status of the resource
- support
Case String - Supported scenarios: createMode:supportCase, for example: NATIVE("0", "eni"),RCK("1", "rck"),ACK_EDGE("1", "edge");
- system
Disk Property Map - System disk specifications. See
system_disk
below. - Map<String>
- The tag of the resource
- vswitch
Id String - The ID of the virtual switch. The zone in which the vSwitch is located must correspond to the zone ID entered in ZoneId. The network type InstanceNetworkType must be VPC.
- zone
Id String - The zone ID of the resource
Supporting Types
CustomDataDisk, CustomDataDiskArgs
- Category string
- Instance storage type local_ssd: local SSD disk cloud_essd:ESSD PL1 cloud disk
- Performance
Level string - Cloud Disk Performance Currently only supports PL1
- Size int
- Instance storage space. Unit: GB.
- Category string
- Instance storage type local_ssd: local SSD disk cloud_essd:ESSD PL1 cloud disk
- Performance
Level string - Cloud Disk Performance Currently only supports PL1
- Size int
- Instance storage space. Unit: GB.
- category String
- Instance storage type local_ssd: local SSD disk cloud_essd:ESSD PL1 cloud disk
- performance
Level String - Cloud Disk Performance Currently only supports PL1
- size Integer
- Instance storage space. Unit: GB.
- category string
- Instance storage type local_ssd: local SSD disk cloud_essd:ESSD PL1 cloud disk
- performance
Level string - Cloud Disk Performance Currently only supports PL1
- size number
- Instance storage space. Unit: GB.
- category str
- Instance storage type local_ssd: local SSD disk cloud_essd:ESSD PL1 cloud disk
- performance_
level str - Cloud Disk Performance Currently only supports PL1
- size int
- Instance storage space. Unit: GB.
- category String
- Instance storage type local_ssd: local SSD disk cloud_essd:ESSD PL1 cloud disk
- performance
Level String - Cloud Disk Performance Currently only supports PL1
- size Number
- Instance storage space. Unit: GB.
CustomSystemDisk, CustomSystemDiskArgs
Import
RDS Custom can be imported using the id, e.g.
$ pulumi import alicloud:rds/custom:Custom example <id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloud
Terraform Provider.