Docs Home
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
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.235.0.
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,
amount: Optional[int] = None,
vswitch_id: Optional[str] = None,
instance_type: Optional[str] = None,
direction: Optional[str] = None,
internet_max_bandwidth_out: Optional[int] = None,
deployment_set_id: Optional[str] = None,
description: Optional[str] = None,
create_mode: 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,
internet_charge_type: Optional[str] = None,
data_disks: Optional[Sequence[CustomDataDiskArgs]] = 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,
resource_group_id: Optional[str] = None,
security_enhancement_strategy: Optional[str] = None,
security_group_ids: Optional[Sequence[str]] = None,
status: 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
This property is required. string - The unique name of the resource.
- args
This property is required. CustomArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. CustomArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. CustomArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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()
{
Amount = 0,
VswitchId = "string",
InstanceType = "string",
Direction = "string",
InternetMaxBandwidthOut = 0,
DeploymentSetId = "string",
Description = "string",
CreateMode = "string",
DryRun = false,
Force = false,
ForceStop = false,
HostName = "string",
ImageId = "string",
InstanceChargeType = "string",
AutoRenew = false,
InternetChargeType = "string",
DataDisks = new[]
{
new AliCloud.Rds.Inputs.CustomDataDiskArgs
{
Category = "string",
PerformanceLevel = "string",
Size = 0,
},
},
IoOptimized = "string",
KeyPairName = "string",
Password = "string",
Period = 0,
PeriodUnit = "string",
ResourceGroupId = "string",
SecurityEnhancementStrategy = "string",
SecurityGroupIds = new[]
{
"string",
},
Status = "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{
Amount: pulumi.Int(0),
VswitchId: pulumi.String("string"),
InstanceType: pulumi.String("string"),
Direction: pulumi.String("string"),
InternetMaxBandwidthOut: pulumi.Int(0),
DeploymentSetId: pulumi.String("string"),
Description: pulumi.String("string"),
CreateMode: 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),
InternetChargeType: pulumi.String("string"),
DataDisks: rds.CustomDataDiskArray{
&rds.CustomDataDiskArgs{
Category: pulumi.String("string"),
PerformanceLevel: pulumi.String("string"),
Size: pulumi.Int(0),
},
},
IoOptimized: pulumi.String("string"),
KeyPairName: pulumi.String("string"),
Password: pulumi.String("string"),
Period: pulumi.Int(0),
PeriodUnit: pulumi.String("string"),
ResourceGroupId: pulumi.String("string"),
SecurityEnhancementStrategy: pulumi.String("string"),
SecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
Status: 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()
.amount(0)
.vswitchId("string")
.instanceType("string")
.direction("string")
.internetMaxBandwidthOut(0)
.deploymentSetId("string")
.description("string")
.createMode("string")
.dryRun(false)
.force(false)
.forceStop(false)
.hostName("string")
.imageId("string")
.instanceChargeType("string")
.autoRenew(false)
.internetChargeType("string")
.dataDisks(CustomDataDiskArgs.builder()
.category("string")
.performanceLevel("string")
.size(0)
.build())
.ioOptimized("string")
.keyPairName("string")
.password("string")
.period(0)
.periodUnit("string")
.resourceGroupId("string")
.securityEnhancementStrategy("string")
.securityGroupIds("string")
.status("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",
amount=0,
vswitch_id="string",
instance_type="string",
direction="string",
internet_max_bandwidth_out=0,
deployment_set_id="string",
description="string",
create_mode="string",
dry_run=False,
force=False,
force_stop=False,
host_name="string",
image_id="string",
instance_charge_type="string",
auto_renew=False,
internet_charge_type="string",
data_disks=[{
"category": "string",
"performance_level": "string",
"size": 0,
}],
io_optimized="string",
key_pair_name="string",
password="string",
period=0,
period_unit="string",
resource_group_id="string",
security_enhancement_strategy="string",
security_group_ids=["string"],
status="string",
system_disk={
"category": "string",
"size": "string",
},
tags={
"string": "string",
},
auto_pay=False,
zone_id="string")
const customResource = new alicloud.rds.Custom("customResource", {
amount: 0,
vswitchId: "string",
instanceType: "string",
direction: "string",
internetMaxBandwidthOut: 0,
deploymentSetId: "string",
description: "string",
createMode: "string",
dryRun: false,
force: false,
forceStop: false,
hostName: "string",
imageId: "string",
instanceChargeType: "string",
autoRenew: false,
internetChargeType: "string",
dataDisks: [{
category: "string",
performanceLevel: "string",
size: 0,
}],
ioOptimized: "string",
keyPairName: "string",
password: "string",
period: 0,
periodUnit: "string",
resourceGroupId: "string",
securityEnhancementStrategy: "string",
securityGroupIds: ["string"],
status: "string",
systemDisk: {
category: "string",
size: "string",
},
tags: {
string: "string",
},
autoPay: false,
zoneId: "string",
});
type: alicloud:rds:Custom
properties:
amount: 0
autoPay: false
autoRenew: false
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
status: 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:
- Amount
This property is required. int - Represents the number of instances created
- Instance
Type This property is required. string - The type of the created RDS Custom dedicated host instance.
- Vswitch
Id stringThis property is required. 
Changes to this property will trigger replacement. 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.
- 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
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 TheAttachRCInstancesAPI to efficiently manage container applications. - Data
Disks Ali Cloud. Rds. Inputs. Custom Data Disk> - Data disk See
data_diskbelow. - Deployment
Set Id - The ID of the deployment set.
- Description
- 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 Ids - Security group list
- Status string
- The status of the resource
- System
Disk Pulumi.Ali Cloud. Rds. Inputs. Custom System Disk - System disk specifications. See
system_diskbelow. - Dictionary<string, string>
- The tag of the resource
- Zone
Id - The zone ID of the resource
- Amount
This property is required. int - Represents the number of instances created
- Instance
Type This property is required. string - The type of the created RDS Custom dedicated host instance.
- Vswitch
Id stringThis property is required. Changes to this property will trigger replacement. 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.
- 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
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 TheAttachRCInstancesAPI to efficiently manage container applications. - Data
Disks Data Disk Args - Data disk See
data_diskbelow. - Deployment
Set Id - The ID of the deployment set.
- Description
- 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 Ids - Security group list
- Status string
- The status of the resource
- System
Disk CustomSystem Disk Args - System disk specifications. See
system_diskbelow. - map[string]string
- The tag of the resource
- Zone
Id - The zone ID of the resource
- amount
This property is required. Integer - Represents the number of instances created
- instance
Type This property is required. String - The type of the created RDS Custom dedicated host instance.
- vswitch
Id StringThis property is required. Changes to this property will trigger replacement. 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.
- 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
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 TheAttachRCInstancesAPI to efficiently manage container applications. - data
Disks Data Disk> - Data disk See
data_diskbelow. - deployment
Set Id - The ID of the deployment set.
- description
- 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 Ids - Security group list
- status String
- The status of the resource
- system
Disk CustomSystem Disk - System disk specifications. See
system_diskbelow. - Map<String,String>
- The tag of the resource
- zone
Id - The zone ID of the resource
- amount
This property is required. number - Represents the number of instances created
- instance
Type This property is required. string - The type of the created RDS Custom dedicated host instance.
- vswitch
Id stringThis property is required. Changes to this property will trigger replacement. 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.
- 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
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 TheAttachRCInstancesAPI to efficiently manage container applications. - data
Disks Data Disk[] - Data disk See
data_diskbelow. - deployment
Set Id - The ID of the deployment set.
- description
- 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 Ids - Security group list
- status string
- The status of the resource
- system
Disk CustomSystem Disk - System disk specifications. See
system_diskbelow. - {[key: string]: string}
- The tag of the resource
- zone
Id - The zone ID of the resource
- amount
This property is required. int - Represents the number of instances created
- instance_
type This property is required. str - The type of the created RDS Custom dedicated host instance.
- vswitch_
id strThis property is required. Changes to this property will trigger replacement. 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.
- 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_
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 TheAttachRCInstancesAPI to efficiently manage container applications. - data_
disks Data Disk Args] - Data disk See
data_diskbelow. - deployment_
set_ id - The ID of the deployment set.
- description
- 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_ ids - Security group list
- status str
- The status of the resource
- system_
disk CustomSystem Disk Args - System disk specifications. See
system_diskbelow. - Mapping[str, str]
- The tag of the resource
- zone_
id - The zone ID of the resource
- amount
This property is required. Number - Represents the number of instances created
- instance
Type This property is required. String - The type of the created RDS Custom dedicated host instance.
- vswitch
Id StringThis property is required. Changes to this property will trigger replacement. 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.
- 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
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 TheAttachRCInstancesAPI to efficiently manage container applications. - data
Disks - Data disk See
data_diskbelow. - deployment
Set Id - The ID of the deployment set.
- description
- 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 Ids - Security group list
- status String
- The status of the resource
- system
Disk Property Map - System disk specifications. See
system_diskbelow. - Map<String>
- The tag of the resource
- zone
Id - 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_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,
status: Optional[str] = None,
system_disk: Optional[CustomSystemDiskArgs] = None,
tags: Optional[Mapping[str, str]] = None,
vswitch_id: Optional[str] = None,
zone_id: Optional[str] = None) -> Customfunc 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- 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
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 TheAttachRCInstancesAPI to efficiently manage container applications. - Data
Disks Ali Cloud. Rds. Inputs. Custom Data Disk> - Data disk See
data_diskbelow. - Deployment
Set Id - The ID of the deployment set.
- Description
- 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 Ids - Security group list
- Status string
- The status of the resource
- System
Disk Pulumi.Ali Cloud. Rds. Inputs. Custom System Disk - System disk specifications. See
system_diskbelow. - Dictionary<string, string>
- The tag of the resource
- Vswitch
Id 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 - 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
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 TheAttachRCInstancesAPI to efficiently manage container applications. - Data
Disks Data Disk Args - Data disk See
data_diskbelow. - Deployment
Set Id - The ID of the deployment set.
- Description
- 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 Ids - Security group list
- Status string
- The status of the resource
- System
Disk CustomSystem Disk Args - System disk specifications. See
system_diskbelow. - map[string]string
- The tag of the resource
- Vswitch
Id 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 - 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
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 TheAttachRCInstancesAPI to efficiently manage container applications. - data
Disks Data Disk> - Data disk See
data_diskbelow. - deployment
Set Id - The ID of the deployment set.
- description
- 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 Ids - Security group list
- status String
- The status of the resource
- system
Disk CustomSystem Disk - System disk specifications. See
system_diskbelow. - Map<String,String>
- The tag of the resource
- vswitch
Id 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 - 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
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 TheAttachRCInstancesAPI to efficiently manage container applications. - data
Disks Data Disk[] - Data disk See
data_diskbelow. - deployment
Set Id - The ID of the deployment set.
- description
- 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 Ids - Security group list
- status string
- The status of the resource
- system
Disk CustomSystem Disk - System disk specifications. See
system_diskbelow. - {[key: string]: string}
- The tag of the resource
- vswitch
Id 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 - 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_
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 TheAttachRCInstancesAPI to efficiently manage container applications. - data_
disks Data Disk Args] - Data disk See
data_diskbelow. - deployment_
set_ id - The ID of the deployment set.
- description
- 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_ ids - Security group list
- status str
- The status of the resource
- system_
disk CustomSystem Disk Args - System disk specifications. See
system_diskbelow. - Mapping[str, str]
- The tag of the resource
- vswitch_
id 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 - 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
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 TheAttachRCInstancesAPI to efficiently manage container applications. - data
Disks - Data disk See
data_diskbelow. - deployment
Set Id - The ID of the deployment set.
- description
- 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 Ids - Security group list
- status String
- The status of the resource
- system
Disk Property Map - System disk specifications. See
system_diskbelow. - Map<String>
- The tag of the resource
- vswitch
Id 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 - The zone ID of the resource
Supporting Types
CustomDataDisk, CustomDataDiskArgs
, CustomDataDiskArgs
- Category
Instance storage type
local_ssd: local SSD disk
cloud_essd:ESSD PL1 cloud disk
- Performance
Level Cloud Disk Performance
Currently only supports PL1
- Size
- Instance storage space. Unit: GB.
- Category
Instance storage type
local_ssd: local SSD disk
cloud_essd:ESSD PL1 cloud disk
- Performance
Level Cloud Disk Performance
Currently only supports PL1
- Size
- Instance storage space. Unit: GB.
- category
Instance storage type
local_ssd: local SSD disk
cloud_essd:ESSD PL1 cloud disk
- performance
Level Cloud Disk Performance
Currently only supports PL1
- size
- Instance storage space. Unit: GB.
- category
Instance storage type
local_ssd: local SSD disk
cloud_essd:ESSD PL1 cloud disk
- performance
Level Cloud Disk Performance
Currently only supports PL1
- size
- Instance storage space. Unit: GB.
- category
Instance storage type
local_ssd: local SSD disk
cloud_essd:ESSD PL1 cloud disk
- performance_
level Cloud Disk Performance
Currently only supports PL1
- size
- Instance storage space. Unit: GB.
- category
Instance storage type
local_ssd: local SSD disk
cloud_essd:ESSD PL1 cloud disk
- performance
Level Cloud Disk Performance
Currently only supports PL1
- size
- Instance storage space. Unit: GB.
CustomSystemDisk, CustomSystemDiskArgs
, 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
alicloudTerraform Provider.