Use ALIYUN::ECS::DedicatedHost to create dedicated hosts - Resource Orchestration Service

ALIYUN::ECS::DedicatedHost is used to create dedicated hosts.

Syntax

{
  "Type": "ALIYUN::ECS::DedicatedHost",
  "Properties": {
    "DedicatedHostType": String,
    "DedicatedHostName": String,
    "PeriodUnit": String,
    "AutoReleaseTime": String,
    "Description": String,
    "AutoPlacement": String,
    "Tags": List,
    "AutoRenewPeriod": Number,
    "ActionOnMaintenance": String,
    "Period": Number,
    "AutoRenew": String,
    "NetworkAttributesSlbUdpTimeout": Integer,
    "ChargeType": String,
    "ResourceGroupId": String,
    "DedicatedHostClusterId": String,
    "MinQuantity": Integer,
    "CpuOverCommitRatio": Number,
    "ZoneId": String,
    "NetworkAttributesUdpTimeout": Integer,
    "Quantity": Integer
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
DedicatedHostType	String	Yes	No	The type of the dedicated host.	None.
DedicatedHostName	String	No	No	The name of the dedicated host.	The name must be 2 to 128 characters in length, and can contain letters, digits, colons (:), underscores (_), and hyphens (-). It must start with a letter and cannot start with `http://` or `https://`.
PeriodUnit	String	No	No	The unit of the billing cycle.	Valid values: Week Month (default) Year
AutoReleaseTime	String	No	No	The automatic release time.	If you do not specify AutoReleaseTime, the dedicated hosts are not automatically released. The time must be within the range of 30 minutes to 3 years from the current time. If the value of `ss` is not `00`, the start time is automatically rounded down to the nearest minute based on the value of `mm`.
Description	String	No	No	The description of the dedicated host.	None.
AutoRenewPeriod	Number	No	No	The auto-renewal period.	Valid values: 1, 2, 3, 6, and 12. Unit: month.
Period	Number	No	No	The subscription duration.	Valid values when PeriodUnit is set to Week: 1 to 3. Valid values when PeriodUnit is set to Month: 1 to 9. Valid values when PeriodUnit is set to Year: 1 to 5.
DedicatedHostClusterId	String	No	No	The ID of the dedicated host cluster.	None.
MinQuantity	Integer	No	No	The minimum number of dedicated hosts to create.	Valid values: 1 to 100.
CpuOverCommitRatio	Number	No	No	The CPU overcommit ratio.	You can configure CPU overcommit ratios only for the following dedicated host types: g6s, c6s, and r6s. Valid values: 1 to 5. The CPU overcommit ratio affects the number of available vCPUs on a dedicated host. You can use the following formula to calculate the number of available vCPUs on a dedicated host: Number of available vCPUs on a dedicated host = Number of physical CPU cores × 2 × CPU overcommit ratio. For example, the number of physical CPU cores on each g6s dedicated host is 52. If you change the CPU overcommit ratio of a g6s dedicated host to 4, the number of available vCPUs on the created dedicated host is 416. For scenarios that have minimal requirements for CPU stability or where CPU load is not heavy, such as development and test environments, you can increase the number of available vCPUs on a dedicated host by increasing the CPU overcommit ratio. This allows you to deploy more Elastic Compute Service (ECS) instances of the same specifications on the dedicated host and reduce the unit deployment cost.
ZoneId	String	No	No	The ID of the zone in which the dedicated hosts reside.	This property is empty by default. If you leave this property empty, the system automatically selects a zone.
AutoRenew	String	No	No	Specifies whether to enable auto-renewal for the dedicated hosts.	Valid values: True False (default)
ChargeType	String	No	No	The billing method of the dedicated hosts.	Valid values: PrePaid: subscription. If you use this value, make sure that you have available account balance or credit. Otherwise, an `InvalidPayMethod` error is returned. PostPaid: pay-as-you-go.
AutoPlacement	String	No	No	Specifies whether to add a dedicated host to the resource pool for automatic deployment.	Valid values: on (default) off If you do not specify DedicatedHostId when you create an instance on a dedicated host and set AutoPlacement to on, the system automatically selects a dedicated host from the resource pool for the instance. For more information, see Functions and features.
Tags	List	No	No	The custom tags.	You can add up to 20 tags in the `[{"Key": "tagKey", "Value": "tagValue"},{"Key": "tagKey2", "Value": "tagValue2"}]` format. For more information, see Tags properties.
ActionOnMaintenance	String	No	No	The policy that is used to migrate the instances on a dedicated host when the dedicated host fails or needs to be repaired online.	Valid values: Migrate: migrates the instances on the dedicated host to another physical server and restarts the instances. Stop: stops the instances on the dedicated host and checks whether the dedicated host can be repaired. If the dedicated host cannot be repaired, the system migrates the instances to another physical server and restarts the instances. If the dedicated host is attached with cloud disks, the default value of this property is Migrate. If the dedicated host is attached with local disks, the default value of this property is Stop.
NetworkAttributesSlbUdpTimeout	Integer	No	No	The timeout period for a UDP session between a Server Load Balancer (SLB) instance and the dedicated host.	Valid values: 15 to 310. Unit: seconds.
ResourceGroupId	String	No	Yes	The ID of the resource group to which the dedicated hosts belong.	None.
NetworkAttributesUdpTimeout	Integer	No	No	The timeout period for a UDP session between a user and an Alibaba Cloud service on the dedicated host.	Valid values: 15 to 310. Unit: seconds.
Quantity	Integer	No	No	The number of dedicated hosts that you want to create.	Valid values: 1 to 100. Default value: 1.

Tags syntax

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

Tags properties

Property	Type	Required	Editable	Description	Constraint
Key	String	Yes	No	The key of the tag.	The key must be 1 to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `acs:` or `aliyun`.
Value	String	No	No	The value of the tag.	The value can be up to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `acs:` or `aliyun`.

Return values

Fn::GetAtt

OrderId: the ID of the order.
DedicatedHostIds: the IDs of the dedicated hosts.
Arn: the Alibaba Cloud Resource Name (ARN).

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description: Test ECS DedicatedHost
Parameters:
  DedicatedHostType:
    Type: String
    Default: ddh.g6
  DedicatedHostName:
    Type: String
    Default: mytest
Resources:
  DedicatedHost:
    Type: ALIYUN::ECS::DedicatedHost
    Properties:
      DedicatedHostType:
        Ref: DedicatedHostType
      DedicatedHostName:
        Ref: DedicatedHostName
      ChargeType: PostPaid
Outputs:
  OrderId:
    Value:
      Fn::GetAtt:
        - DedicatedHost
        - OrderId
  DedicatedHostIds:
    Value:
      Fn::GetAtt:
        - DedicatedHost
        - DedicatedHostIds

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test ECS DedicatedHost",
  "Parameters": {
    "DedicatedHostType": {
      "Type": "String",
      "Default": "ddh.g6"
    },
    "DedicatedHostName": {
      "Type": "String",
      "Default": "mytest"
    }
  },
  "Resources": {
    "DedicatedHost": {
      "Type": "ALIYUN::ECS::DedicatedHost",
      "Properties": {
        "DedicatedHostType": {
          "Ref": "DedicatedHostType"
        },
        "DedicatedHostName": {
          "Ref": "DedicatedHostName"
        },
        "ChargeType": "PostPaid"
      }
    }
  },
  "Outputs": {
    "OrderId": {
      "Value": {
        "Fn::GetAtt": [
          "DedicatedHost",
          "OrderId"
        ]
      }
    },
    "DedicatedHostIds": {
      "Value": {
        "Fn::GetAtt": [
          "DedicatedHost",
          "DedicatedHostIds"
        ]
      }
    }
  }
}