Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. rds
  5. Custom
Alibaba Cloud v3.67.0 published on Friday, Nov 22, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.rds.Custom

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.67.0 published on Friday, Nov 22, 2024 by Pulumi
pulumi/pulumi-alicloud

    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 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()
{
    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 int
    Represents the number of instances created
    InstanceType string
    The type of the created RDS Custom dedicated host instance.
    VswitchId 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.

    AutoPay bool
    Whether to pay automatically. Value range:
    AutoRenew bool
    Whether the instance is automatically renewed. Valid values: true/false. The default is false.
    CreateMode 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 The AttachRCInstances API to efficiently manage container applications.
    DataDisks List<Pulumi.AliCloud.Rds.Inputs.CustomDataDisk>
    Data disk See data_disk below.
    DeploymentSetId string
    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.
    DryRun 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
    ForceStop bool
    Whether to force shutdown. Value range:
    HostName string
    The instance host name.
    ImageId string
    The ID of the image used by the instance.
    InstanceChargeType string
    The Payment type. Currently, only Prepaid (package year and month) types are supported.
    InternetChargeType string
    Reserved parameters are not supported.
    InternetMaxBandwidthOut int
    Reserved parameters are not supported.
    IoOptimized string
    Reserved parameters are not supported.
    KeyPairName string
    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.
    PeriodUnit string
    The unit of duration of the year-to-month billing method. Value range:

    • Year: Year
    • Month (default): Month
    ResourceGroupId string
    The ID of the resource group
    SecurityEnhancementStrategy string
    Reserved parameters are not supported.
    SecurityGroupIds List<string>
    Security group list
    Status string
    The status of the resource
    SystemDisk Pulumi.AliCloud.Rds.Inputs.CustomSystemDisk
    System disk specifications. See system_disk below.
    Tags Dictionary<string, string>
    The tag of the resource
    ZoneId string
    The zone ID of the resource
    Amount int
    Represents the number of instances created
    InstanceType string
    The type of the created RDS Custom dedicated host instance.
    VswitchId 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.

    AutoPay bool
    Whether to pay automatically. Value range:
    AutoRenew bool
    Whether the instance is automatically renewed. Valid values: true/false. The default is false.
    CreateMode 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 The AttachRCInstances API to efficiently manage container applications.
    DataDisks []CustomDataDiskArgs
    Data disk See data_disk below.
    DeploymentSetId string
    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.
    DryRun 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
    ForceStop bool
    Whether to force shutdown. Value range:
    HostName string
    The instance host name.
    ImageId string
    The ID of the image used by the instance.
    InstanceChargeType string
    The Payment type. Currently, only Prepaid (package year and month) types are supported.
    InternetChargeType string
    Reserved parameters are not supported.
    InternetMaxBandwidthOut int
    Reserved parameters are not supported.
    IoOptimized string
    Reserved parameters are not supported.
    KeyPairName string
    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.
    PeriodUnit string
    The unit of duration of the year-to-month billing method. Value range:

    • Year: Year
    • Month (default): Month
    ResourceGroupId string
    The ID of the resource group
    SecurityEnhancementStrategy string
    Reserved parameters are not supported.
    SecurityGroupIds []string
    Security group list
    Status string
    The status of the resource
    SystemDisk CustomSystemDiskArgs
    System disk specifications. See system_disk below.
    Tags map[string]string
    The tag of the resource
    ZoneId string
    The zone ID of the resource
    amount Integer
    Represents the number of instances created
    instanceType String
    The type of the created RDS Custom dedicated host instance.
    vswitchId 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.

    autoPay Boolean
    Whether to pay automatically. Value range:
    autoRenew Boolean
    Whether the instance is automatically renewed. Valid values: true/false. The default is false.
    createMode 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 The AttachRCInstances API to efficiently manage container applications.
    dataDisks List<CustomDataDisk>
    Data disk See data_disk below.
    deploymentSetId String
    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.
    dryRun 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
    forceStop Boolean
    Whether to force shutdown. Value range:
    hostName String
    The instance host name.
    imageId String
    The ID of the image used by the instance.
    instanceChargeType String
    The Payment type. Currently, only Prepaid (package year and month) types are supported.
    internetChargeType String
    Reserved parameters are not supported.
    internetMaxBandwidthOut Integer
    Reserved parameters are not supported.
    ioOptimized String
    Reserved parameters are not supported.
    keyPairName String
    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.
    periodUnit String
    The unit of duration of the year-to-month billing method. Value range:

    • Year: Year
    • Month (default): Month
    resourceGroupId String
    The ID of the resource group
    securityEnhancementStrategy String
    Reserved parameters are not supported.
    securityGroupIds List<String>
    Security group list
    status String
    The status of the resource
    systemDisk CustomSystemDisk
    System disk specifications. See system_disk below.
    tags Map<String,String>
    The tag of the resource
    zoneId String
    The zone ID of the resource
    amount number
    Represents the number of instances created
    instanceType string
    The type of the created RDS Custom dedicated host instance.
    vswitchId 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.

    autoPay boolean
    Whether to pay automatically. Value range:
    autoRenew boolean
    Whether the instance is automatically renewed. Valid values: true/false. The default is false.
    createMode 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 The AttachRCInstances API to efficiently manage container applications.
    dataDisks CustomDataDisk[]
    Data disk See data_disk below.
    deploymentSetId string
    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.
    dryRun 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
    forceStop boolean
    Whether to force shutdown. Value range:
    hostName string
    The instance host name.
    imageId string
    The ID of the image used by the instance.
    instanceChargeType string
    The Payment type. Currently, only Prepaid (package year and month) types are supported.
    internetChargeType string
    Reserved parameters are not supported.
    internetMaxBandwidthOut number
    Reserved parameters are not supported.
    ioOptimized string
    Reserved parameters are not supported.
    keyPairName string
    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.
    periodUnit string
    The unit of duration of the year-to-month billing method. Value range:

    • Year: Year
    • Month (default): Month
    resourceGroupId string
    The ID of the resource group
    securityEnhancementStrategy string
    Reserved parameters are not supported.
    securityGroupIds string[]
    Security group list
    status string
    The status of the resource
    systemDisk CustomSystemDisk
    System disk specifications. See system_disk below.
    tags {[key: string]: string}
    The tag of the resource
    zoneId string
    The zone ID of the resource
    amount int
    Represents the number of instances created
    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.

    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 The AttachRCInstances API to efficiently manage container applications.
    data_disks Sequence[CustomDataDiskArgs]
    Data disk See data_disk below.
    deployment_set_id str
    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_type str
    The Payment type. Currently, only Prepaid (package year and month) types are supported.
    internet_charge_type str
    Reserved parameters are not supported.
    internet_max_bandwidth_out int
    Reserved parameters are not supported.
    io_optimized str
    Reserved parameters are not supported.
    key_pair_name str
    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: Year
    • Month (default): Month
    resource_group_id str
    The ID of the resource group
    security_enhancement_strategy str
    Reserved parameters are not supported.
    security_group_ids Sequence[str]
    Security group list
    status str
    The status of the resource
    system_disk CustomSystemDiskArgs
    System disk specifications. See system_disk below.
    tags Mapping[str, str]
    The tag of the resource
    zone_id str
    The zone ID of the resource
    amount Number
    Represents the number of instances created
    instanceType String
    The type of the created RDS Custom dedicated host instance.
    vswitchId 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.

    autoPay Boolean
    Whether to pay automatically. Value range:
    autoRenew Boolean
    Whether the instance is automatically renewed. Valid values: true/false. The default is false.
    createMode 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 The AttachRCInstances API to efficiently manage container applications.
    dataDisks List<Property Map>
    Data disk See data_disk below.
    deploymentSetId String
    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.
    dryRun 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
    forceStop Boolean
    Whether to force shutdown. Value range:
    hostName String
    The instance host name.
    imageId String
    The ID of the image used by the instance.
    instanceChargeType String
    The Payment type. Currently, only Prepaid (package year and month) types are supported.
    internetChargeType String
    Reserved parameters are not supported.
    internetMaxBandwidthOut Number
    Reserved parameters are not supported.
    ioOptimized String
    Reserved parameters are not supported.
    keyPairName String
    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.
    periodUnit String
    The unit of duration of the year-to-month billing method. Value range:

    • Year: Year
    • Month (default): Month
    resourceGroupId String
    The ID of the resource group
    securityEnhancementStrategy String
    Reserved parameters are not supported.
    securityGroupIds List<String>
    Security group list
    status String
    The status of the resource
    systemDisk Property Map
    System disk specifications. See system_disk below.
    tags Map<String>
    The tag of the resource
    zoneId 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:

    Id string
    The provider-assigned unique ID for this managed resource.
    RegionId string
    The region ID. Callable DescribeRegions to get.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionId string
    The region ID. Callable DescribeRegions to get.
    id String
    The provider-assigned unique ID for this managed resource.
    regionId String
    The region ID. Callable DescribeRegions to get.
    id string
    The provider-assigned unique ID for this managed resource.
    regionId string
    The region ID. Callable DescribeRegions to get.
    id str
    The provider-assigned unique ID for this managed resource.
    region_id str
    The region ID. Callable DescribeRegions to get.
    id String
    The provider-assigned unique ID for this managed resource.
    regionId String
    The region ID. Callable DescribeRegions to get.

    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) -> 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Amount int
    Represents the number of instances created
    AutoPay bool
    Whether to pay automatically. Value range:
    AutoRenew bool
    Whether the instance is automatically renewed. Valid values: true/false. The default is false.
    CreateMode 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 The AttachRCInstances API to efficiently manage container applications.
    DataDisks List<Pulumi.AliCloud.Rds.Inputs.CustomDataDisk>
    Data disk See data_disk below.
    DeploymentSetId string
    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.
    DryRun 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
    ForceStop bool
    Whether to force shutdown. Value range:
    HostName string
    The instance host name.
    ImageId string
    The ID of the image used by the instance.
    InstanceChargeType string
    The Payment type. Currently, only Prepaid (package year and month) types are supported.
    InstanceType string
    The type of the created RDS Custom dedicated host instance.
    InternetChargeType string
    Reserved parameters are not supported.
    InternetMaxBandwidthOut int
    Reserved parameters are not supported.
    IoOptimized string
    Reserved parameters are not supported.
    KeyPairName string
    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.
    PeriodUnit string
    The unit of duration of the year-to-month billing method. Value range:

    • Year: Year
    • Month (default): Month
    RegionId string
    The region ID. Callable DescribeRegions to get.
    ResourceGroupId string
    The ID of the resource group
    SecurityEnhancementStrategy string
    Reserved parameters are not supported.
    SecurityGroupIds List<string>
    Security group list
    Status string
    The status of the resource
    SystemDisk Pulumi.AliCloud.Rds.Inputs.CustomSystemDisk
    System disk specifications. See system_disk below.
    Tags Dictionary<string, string>
    The tag of the resource
    VswitchId 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.

    ZoneId string
    The zone ID of the resource
    Amount int
    Represents the number of instances created
    AutoPay bool
    Whether to pay automatically. Value range:
    AutoRenew bool
    Whether the instance is automatically renewed. Valid values: true/false. The default is false.
    CreateMode 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 The AttachRCInstances API to efficiently manage container applications.
    DataDisks []CustomDataDiskArgs
    Data disk See data_disk below.
    DeploymentSetId string
    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.
    DryRun 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
    ForceStop bool
    Whether to force shutdown. Value range:
    HostName string
    The instance host name.
    ImageId string
    The ID of the image used by the instance.
    InstanceChargeType string
    The Payment type. Currently, only Prepaid (package year and month) types are supported.
    InstanceType string
    The type of the created RDS Custom dedicated host instance.
    InternetChargeType string
    Reserved parameters are not supported.
    InternetMaxBandwidthOut int
    Reserved parameters are not supported.
    IoOptimized string
    Reserved parameters are not supported.
    KeyPairName string
    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.
    PeriodUnit string
    The unit of duration of the year-to-month billing method. Value range:

    • Year: Year
    • Month (default): Month
    RegionId string
    The region ID. Callable DescribeRegions to get.
    ResourceGroupId string
    The ID of the resource group
    SecurityEnhancementStrategy string
    Reserved parameters are not supported.
    SecurityGroupIds []string
    Security group list
    Status string
    The status of the resource
    SystemDisk CustomSystemDiskArgs
    System disk specifications. See system_disk below.
    Tags map[string]string
    The tag of the resource
    VswitchId 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.

    ZoneId string
    The zone ID of the resource
    amount Integer
    Represents the number of instances created
    autoPay Boolean
    Whether to pay automatically. Value range:
    autoRenew Boolean
    Whether the instance is automatically renewed. Valid values: true/false. The default is false.
    createMode 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 The AttachRCInstances API to efficiently manage container applications.
    dataDisks List<CustomDataDisk>
    Data disk See data_disk below.
    deploymentSetId String
    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.
    dryRun 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
    forceStop Boolean
    Whether to force shutdown. Value range:
    hostName String
    The instance host name.
    imageId String
    The ID of the image used by the instance.
    instanceChargeType String
    The Payment type. Currently, only Prepaid (package year and month) types are supported.
    instanceType String
    The type of the created RDS Custom dedicated host instance.
    internetChargeType String
    Reserved parameters are not supported.
    internetMaxBandwidthOut Integer
    Reserved parameters are not supported.
    ioOptimized String
    Reserved parameters are not supported.
    keyPairName String
    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.
    periodUnit String
    The unit of duration of the year-to-month billing method. Value range:

    • Year: Year
    • Month (default): Month
    regionId String
    The region ID. Callable DescribeRegions to get.
    resourceGroupId String
    The ID of the resource group
    securityEnhancementStrategy String
    Reserved parameters are not supported.
    securityGroupIds List<String>
    Security group list
    status String
    The status of the resource
    systemDisk CustomSystemDisk
    System disk specifications. See system_disk below.
    tags Map<String,String>
    The tag of the resource
    vswitchId 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.

    zoneId String
    The zone ID of the resource
    amount number
    Represents the number of instances created
    autoPay boolean
    Whether to pay automatically. Value range:
    autoRenew boolean
    Whether the instance is automatically renewed. Valid values: true/false. The default is false.
    createMode 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 The AttachRCInstances API to efficiently manage container applications.
    dataDisks CustomDataDisk[]
    Data disk See data_disk below.
    deploymentSetId string
    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.
    dryRun 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
    forceStop boolean
    Whether to force shutdown. Value range:
    hostName string
    The instance host name.
    imageId string
    The ID of the image used by the instance.
    instanceChargeType string
    The Payment type. Currently, only Prepaid (package year and month) types are supported.
    instanceType string
    The type of the created RDS Custom dedicated host instance.
    internetChargeType string
    Reserved parameters are not supported.
    internetMaxBandwidthOut number
    Reserved parameters are not supported.
    ioOptimized string
    Reserved parameters are not supported.
    keyPairName string
    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.
    periodUnit string
    The unit of duration of the year-to-month billing method. Value range:

    • Year: Year
    • Month (default): Month
    regionId string
    The region ID. Callable DescribeRegions to get.
    resourceGroupId string
    The ID of the resource group
    securityEnhancementStrategy string
    Reserved parameters are not supported.
    securityGroupIds string[]
    Security group list
    status string
    The status of the resource
    systemDisk CustomSystemDisk
    System disk specifications. See system_disk below.
    tags {[key: string]: string}
    The tag of the resource
    vswitchId 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.

    zoneId 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_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 The AttachRCInstances API to efficiently manage container applications.
    data_disks Sequence[CustomDataDiskArgs]
    Data disk See data_disk below.
    deployment_set_id str
    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_type str
    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_type str
    Reserved parameters are not supported.
    internet_max_bandwidth_out int
    Reserved parameters are not supported.
    io_optimized str
    Reserved parameters are not supported.
    key_pair_name str
    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: Year
    • Month (default): Month
    region_id str
    The region ID. Callable DescribeRegions to get.
    resource_group_id str
    The ID of the resource group
    security_enhancement_strategy str
    Reserved parameters are not supported.
    security_group_ids Sequence[str]
    Security group list
    status str
    The status of the resource
    system_disk CustomSystemDiskArgs
    System disk specifications. See system_disk below.
    tags 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
    autoPay Boolean
    Whether to pay automatically. Value range:
    autoRenew Boolean
    Whether the instance is automatically renewed. Valid values: true/false. The default is false.
    createMode 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 The AttachRCInstances API to efficiently manage container applications.
    dataDisks List<Property Map>
    Data disk See data_disk below.
    deploymentSetId String
    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.
    dryRun 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
    forceStop Boolean
    Whether to force shutdown. Value range:
    hostName String
    The instance host name.
    imageId String
    The ID of the image used by the instance.
    instanceChargeType String
    The Payment type. Currently, only Prepaid (package year and month) types are supported.
    instanceType String
    The type of the created RDS Custom dedicated host instance.
    internetChargeType String
    Reserved parameters are not supported.
    internetMaxBandwidthOut Number
    Reserved parameters are not supported.
    ioOptimized String
    Reserved parameters are not supported.
    keyPairName String
    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.
    periodUnit String
    The unit of duration of the year-to-month billing method. Value range:

    • Year: Year
    • Month (default): Month
    regionId String
    The region ID. Callable DescribeRegions to get.
    resourceGroupId String
    The ID of the resource group
    securityEnhancementStrategy String
    Reserved parameters are not supported.
    securityGroupIds List<String>
    Security group list
    status String
    The status of the resource
    systemDisk Property Map
    System disk specifications. See system_disk below.
    tags Map<String>
    The tag of the resource
    vswitchId 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.

    zoneId 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

    PerformanceLevel 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

    PerformanceLevel 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

    performanceLevel 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

    performanceLevel 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

    performanceLevel String

    Cloud Disk Performance

    Currently only supports PL1

    size Number
    Instance storage space. Unit: GB.

    CustomSystemDisk, CustomSystemDiskArgs

    Category string
    The cloud disk type of the system disk. Currently, only cloud_essd(ESSD cloud disk) is supported.
    Size string
    System disk size, unit: GiB. Only ESSD PL1 is supported. Valid values range from 20 to 2048.
    Category string
    The cloud disk type of the system disk. Currently, only cloud_essd(ESSD cloud disk) is supported.
    Size string
    System disk size, unit: GiB. Only ESSD PL1 is supported. Valid values range from 20 to 2048.
    category String
    The cloud disk type of the system disk. Currently, only cloud_essd(ESSD cloud disk) is supported.
    size String
    System disk size, unit: GiB. Only ESSD PL1 is supported. Valid values range from 20 to 2048.
    category string
    The cloud disk type of the system disk. Currently, only cloud_essd(ESSD cloud disk) is supported.
    size string
    System disk size, unit: GiB. Only ESSD PL1 is supported. Valid values range from 20 to 2048.
    category str
    The cloud disk type of the system disk. Currently, only cloud_essd(ESSD cloud disk) is supported.
    size str
    System disk size, unit: GiB. Only ESSD PL1 is supported. Valid values range from 20 to 2048.
    category String
    The cloud disk type of the system disk. Currently, only cloud_essd(ESSD cloud disk) is supported.
    size String
    System disk size, unit: GiB. Only ESSD PL1 is supported. Valid values range from 20 to 2048.

    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.
    alicloud logo
    Alibaba Cloud v3.67.0 published on Friday, Nov 22, 2024 by Pulumi
    pulumi/pulumi-alicloud