Use ALIYUN::CDDC::DedicatedHost to create a host in a dedicated cluster - Resource Orchestration Service

Dedicated clusters are provided by ApsaraDB for MyBase. What is ApsaraDB for MyBase?

Syntax

{
  "Type": "ALIYUN::CDDC::DedicatedHost",
  "Properties": {
    "HostClass": String,
    "OsPassword": String,
    "ZoneId": String,
    "DedicatedHostGroupId": String,
    "AutoRenew": String,
    "VSwitchId": String,
    "UsedTime": String,
    "ImageCategory": String,
    "Period": String,
    "PaymentType": String,
    "HostName": String,
    "Tags": List
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
DedicatedHostGroupId	String	Yes	No	The ID of the dedicated cluster.	None.
HostClass	String	Yes	Yes	The instance type of the host.	Valid types are listed in Instance types of hosts.
PaymentType	String	Yes	No	The billing method of the host.	Only PrePaid (subscription) is supported.
VSwitchId	String	Yes	No	The vSwitch ID.	None.
ZoneId	String	Yes	No	The zone ID.	Example: in `cn-hangzhou-i`, `cn-hangzhou` is the region. Call DescribeRegions to query available regions.
AutoRenew	String	No	No	Whether to enable auto-renewal.	Valid values: true false (default)
HostName	String	No	Yes	The hostname.	1 to 64 characters. Supports letters, digits, underscores (_), and hyphens (-). Must start with a letter.
ImageCategory	String	No	No	The image type of the host.	Valid values: WindowsWithMssqlEntAlwaysonLicense: SQL Server Cluster Edition WindowsWithMssqlStdLicense: SQL Server Standard Edition WindowsWithMssqlEntLicense: SQL Server Enterprise Edition WindowsWithMssqlWebLicense: SQL Server Web Edition AliLinux: other image types
OsPassword	String	No	No	The host password.	Applies only to Proprietary MyBase dedicated clusters. 8 to 30 characters. Must include at least three of: uppercase letters, lowercase letters, digits, and special characters. Supported special characters:`( ) \ ~ ! @ # $ % ^ & * - _ + = \| { } [ ] : ; ' < > , . ? /`.
Period	String	No	No	The subscription period unit.	Valid values: Year Month Week
Tags	List	No	Yes	The tags.	Defined in Tags properties.
UsedTime	String	No	No	The subscription duration.	Valid values when Period is set to Year: 1 to 5. Valid values when Period is set to Month: 1 to 9. Valid values when Period is set to Week: 1 to 3.

Tags syntax

"Tags": [
  {
    "TagKey": String,
    "TagValue": String
  }
]

Tags properties

Property	Type	Required	Editable	Description	Constraint
TagKey	String	No	No	The tag key.	1 to 128 characters. Cannot contain `http://` or `https://`, or start with `aliyun` or `acs:`.
TagValue	String	No	No	The tag value.	Up to 128 characters. Cannot contain `http://` or `https://`, or start with `aliyun` or `acs:`.

Return values

Fn::GetAtt

DiskAllocationRatio: disk usage (%).
DedicatedHostId: host ID in the dedicated cluster.
MemAllocationRatio: memory usage (%).
ZoneId: zone ID.
DedicatedHostGroupId: dedicated cluster ID.
AutoRenew: whether auto-renewal is enabled.
VSwitchId: vSwitch ID.
ImageCategory: host image type.
HostStorage: total host storage (GB).
StorageUsed: storage used (GB).
OpenPermission: whether host OS permission granting is enabled.
HostType: host storage type.
HostClass: host instance type.
HostCpu: host CPU.
VpcId: VPC ID.
EcsClassCode: ECS instance type of the host.
CpuAllocationRatio: CPU utilization.
HostMem: host memory.
PaymentType: billing method.
MemoryUsed: memory used (GB).
IpAddress: host IP address.
CpuUsed: CPU used (cores).
HostName: hostname.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  HostClass:
    Type: String
    Description: Host Class
    Default: rds.i2g.2xlarge
  OsPassword:
    Type: String
    Default: Password123
  ZoneId:
    Type: String
    Description: Zone ID
    Default: cn-hangzhou-i
  DedicatedHostGroupId:
    Type: String
    Description: Dedicated Host Group ID
    Default: dhg-23h5e2axmuf4****
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      ZoneId: ${ZoneId}
  PaymentType:
    Type: String
    Description: Payment Type
    Default: PrePaid
Resources:
  CDDCDedicatedHost:
    Type: ALIYUN::CDDC::DedicatedHost
    Properties:
      HostClass:
        Ref: HostClass
      OsPassword:
        Ref: OsPassword
      ZoneId:
        Ref: ZoneId
      DedicatedHostGroupId:
        Ref: DedicatedHostGroupId
      VSwitchId:
        Ref: VSwitchId
      PaymentType:
        Ref: PaymentType
Outputs:
  DiskAllocationRatio:
    Description: Disk Allocation Ratio
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - DiskAllocationRatio
  DedicatedHostId:
    Description: The first ID of the resource
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - DedicatedHostId
  MemAllocationRatio:
    Description: Memory Allocation Ratio
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - MemAllocationRatio
  ZoneId:
    Description: Zone ID
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - ZoneId
  DedicatedHostGroupId:
    Description: Dedicated Host Group ID
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - DedicatedHostGroupId
  AutoRenew:
    Description: Whether Auto Renew
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - AutoRenew
  VSwitchId:
    Description: VSwitch ID
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - VSwitchId
  ImageCategory:
    Description: Host Image Category
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - ImageCategory
  HostStorage:
    Description: Host Storage
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - HostStorage
  StorageUsed:
    Description: Storage Used
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - StorageUsed
  OpenPermission:
    Description: Whether Open OS Permission
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - OpenPermission
  HostType:
    Description: Host Storage Type
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - HostType
  HostClass:
    Description: Host Class
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - HostClass
  HostCpu:
    Description: Host CPU
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - HostCpu
  VpcId:
    Description: VPC ID
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - VpcId
  EcsClassCode:
    Description: ECS Class Code
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - EcsClassCode
  CpuAllocationRatio:
    Description: CPU Allocation Ratio
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - CpuAllocationRatio
  HostMem:
    Description: Host Memory
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - HostMem
  PaymentType:
    Description: Payment Type
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - PaymentType
  MemoryUsed:
    Description: Host Memory Used
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - MemoryUsed
  IpAddress:
    Description: Host IP Address
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - IpAddress
  CpuUsed:
    Description: CPU Used
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - CpuUsed
  HostName:
    Description: Host Name
    Value:
      Fn::GetAtt:
        - CDDCDedicatedHost
        - HostName

`JSON` format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "HostClass": {
      "Type": "String",
      "Description": "Host Class",
      "Default": "rds.i2g.2xlarge"
    },
    "OsPassword": {
      "Type": "String",
      "Default": "Password123"
    },
    "ZoneId": {
      "Type": "String",
      "Description": "Zone ID",
      "Default": "cn-hangzhou-i"
    },
    "DedicatedHostGroupId": {
      "Type": "String",
      "Description": "Dedicated Host Group ID",
      "Default": "dhg-23h5e2axmuf4****"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "ZoneId": "${ZoneId}"
      }
    },
    "PaymentType": {
      "Type": "String",
      "Description": "Payment Type",
      "Default": "PrePaid"
    }
  },
  "Resources": {
    "CDDCDedicatedHost": {
      "Type": "ALIYUN::CDDC::DedicatedHost",
      "Properties": {
        "HostClass": {
          "Ref": "HostClass"
        },
        "OsPassword": {
          "Ref": "OsPassword"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "DedicatedHostGroupId": {
          "Ref": "DedicatedHostGroupId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "PaymentType": {
          "Ref": "PaymentType"
        }
      }
    }
  },
  "Outputs": {
    "DiskAllocationRatio": {
      "Description": "Disk Allocation Ratio",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "DiskAllocationRatio"
        ]
      }
    },
    "DedicatedHostId": {
      "Description": "The first ID of the resource",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "DedicatedHostId"
        ]
      }
    },
    "MemAllocationRatio": {
      "Description": "Memory Allocation Ratio",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "MemAllocationRatio"
        ]
      }
    },
    "ZoneId": {
      "Description": "Zone ID",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "ZoneId"
        ]
      }
    },
    "DedicatedHostGroupId": {
      "Description": "Dedicated Host Group ID",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "DedicatedHostGroupId"
        ]
      }
    },
    "AutoRenew": {
      "Description": "Whether Auto Renew",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "AutoRenew"
        ]
      }
    },
    "VSwitchId": {
      "Description": "VSwitch ID",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "VSwitchId"
        ]
      }
    },
    "ImageCategory": {
      "Description": "Host Image Category",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "ImageCategory"
        ]
      }
    },
    "HostStorage": {
      "Description": "Host Storage",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "HostStorage"
        ]
      }
    },
    "StorageUsed": {
      "Description": "Storage Used",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "StorageUsed"
        ]
      }
    },
    "OpenPermission": {
      "Description": "Whether Open OS Permission",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "OpenPermission"
        ]
      }
    },
    "HostType": {
      "Description": "Host Storage Type",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "HostType"
        ]
      }
    },
    "HostClass": {
      "Description": "Host Class",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "HostClass"
        ]
      }
    },
    "HostCpu": {
      "Description": "Host CPU",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "HostCpu"
        ]
      }
    },
    "VpcId": {
      "Description": "VPC ID",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "VpcId"
        ]
      }
    },
    "EcsClassCode": {
      "Description": "ECS Class Code",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "EcsClassCode"
        ]
      }
    },
    "CpuAllocationRatio": {
      "Description": "CPU Allocation Ratio",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "CpuAllocationRatio"
        ]
      }
    },
    "HostMem": {
      "Description": "Host Memory",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "HostMem"
        ]
      }
    },
    "PaymentType": {
      "Description": "Payment Type",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "PaymentType"
        ]
      }
    },
    "MemoryUsed": {
      "Description": "Host Memory Used",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "MemoryUsed"
        ]
      }
    },
    "IpAddress": {
      "Description": "Host IP Address",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "IpAddress"
        ]
      }
    },
    "CpuUsed": {
      "Description": "CPU Used",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "CpuUsed"
        ]
      }
    },
    "HostName": {
      "Description": "Host Name",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHost",
          "HostName"
        ]
      }
    }
  }
}

Syntax

Properties

Tags syntax

Tags properties

Return values

Examples

YAML format

JSON format

`JSON` format