ALIYUN::CDDC::DedicatedHostGroup is used to create a dedicated cluster.

For more information about dedicated clusters, see What is ApsaraDB for MyBase?

Syntax

{
  "Type": "ALIYUN::CDDC::DedicatedHostGroup",
  "Properties": {
    "DiskAllocationRatio": Integer,
    "AllocationPolicy": String,
    "VpcId": String,
    "MemAllocationRatio": Integer,
    "HostReplacePolicy": String,
    "CpuAllocationRatio": Integer,
    "Engine": String,
    "DedicatedHostGroupDesc": String,
    "OpenPermission": String
  }
}

Properties

Property Type Required Editable Description Constraint
DiskAllocationRatio Integer No Yes The storage overcommit ratio of the dedicated cluster. Valid values: 100 to 300. Unit: percentage.

Default value: 200. The default value indicates that the system can allocate twice the provided storage resources. This maximizes resource utilization.

AllocationPolicy String No Yes The policy that is used to allocate resources in the dedicated cluster. Valid values:
  • Evenly: The system preferentially creates instances on the hosts that have the smallest loads. This way, the loads on the hosts in the dedicated cluster can be balanced. This maximizes system stability. This is the default value.
  • Intensively: The system preferentially creates instances on the hosts that are created earlier than other hosts and have consumed more resources than other hosts in the dedicated cluster. This maximizes resource utilization.
VpcId String Yes No The ID of the virtual private cloud (VPC) in which the dedicated cluster resides. N/A
MemAllocationRatio Integer No Yes The maximum memory usage of each host in the dedicated cluster. Valid values: 0 to 100. Unit: percentage.

Default value: 100.

HostReplacePolicy String No Yes The policy that is used to handle host failures. Valid values:
  • Auto: Faulty hosts are automatically replaced. This is the default value.
  • Manual: Faulty hosts are manually replaced.
Note You can select a policy based on your business requirements only if the dedicated cluster runs the MySQL database engine. For dedicated clusters that run other database engines, set the value to Auto.
CpuAllocationRatio Integer No Yes The CPU overcommit ratio of the dedicated cluster. Valid values: 100 to 300. Unit: percentage.

Default value: 200. The default value indicates that the system can allocate twice the provided CPU resources. This maximizes resource utilization.

Engine String Yes No The type of the database engine. Valid values:
  • MySQL
  • SQLServer
  • PostgreSQL
  • Redis
DedicatedHostGroupDesc String No Yes The name of the dedicated cluster. The name must be 1 to 64 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter.
OpenPermission String No Yes Specifies whether to enable the feature that allows you to have OS permissions on the hosts in the dedicated cluster. Valid values:
  • 0: disables the feature.
  • 1: enables the feature. This is the default value.

Response parameters

Fn::GetAtt

  • DeployType: the instance deployment mode.
  • DiskAllocationRatio: the storage overcommit ratio of the host.
  • DiskUsedAmount: the size of disk usage.
  • InstanceNumber: the number of instances on the host.
  • AllocationPolicy: the policy that is used to allocate resources on the host.
  • HostReplacePolicy: the policy that is used to handle host failures.
  • DedicatedHostGroupId: the ID of the dedicated cluster.
  • BastionInstanceId: the ID of the primary instance on the host.
  • MemAllocatedAmount: the size of the allocated memory.
  • OpenPermission: indicates whether the feature that allows you to have OS permissions on the host is enabled.
  • MemAllocateRation: the percentage of the allocated memory.
  • DiskAllocatedAmount: the size of the allocated disk space.
  • Engine: the database engine type of the host.
  • MemUtility: the memory usage.
  • MemAllocationRatio: the memory overcommit ratio of the host.
  • CpuAllocateRation: the percentage of requested CPU cores.
  • Text: the description of the host.
  • MemUsedAmount: the size of memory usage.
  • DedicatedHostGroupDesc: the name of the dedicated cluster to which the host belongs.
  • VpcId: the ID of the VPC in which the host resides.
  • DiskUtility: the disk usage.
  • CpuAllocationRatio: the CPU overcommit ratio of the host.
  • DiskAllocateRation: the disk allocation ratio.
  • HostNumber: the number of hosts.
  • CpuAllocatedAmount: the number of requested CPU cores.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "Description": "VPC ID",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "Engine": {
      "Type": "String",
      "Description": "Database Engine Type",
      "Default": "MySQL"
    }
  },
  "Resources": {
    "CDDCDedicatedHostGroup": {
      "Type": "ALIYUN::CDDC::DedicatedHostGroup",
      "Properties": {
        "VpcId": {
          "Ref": "VpcId"
        },
        "Engine": {
          "Ref": "Engine"
        }
      }
    }
  },
  "Outputs": {
    "DeployType": {
      "Description": "DeployType",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "DeployType"
        ]
      }
    },
    "DiskAllocationRatio": {
      "Description": "Disk Allocation Ratio",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "DiskAllocationRatio"
        ]
      }
    },
    "DiskUsedAmount": {
      "Description": "DiskUsedAmount",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "DiskUsedAmount"
        ]
      }
    },
    "InstanceNumber": {
      "Description": "Total Instance Number",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "InstanceNumber"
        ]
      }
    },
    "AllocationPolicy": {
      "Description": "Allocation Policy",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "AllocationPolicy"
        ]
      }
    },
    "HostReplacePolicy": {
      "Description": "Host Replace Policy",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "HostReplacePolicy"
        ]
      }
    },
    "DedicatedHostGroupId": {
      "Description": "Dedicated Host Group ID",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "DedicatedHostGroupId"
        ]
      }
    },
    "BastionInstanceId": {
      "Description": "BastionInstanceId",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "BastionInstanceId"
        ]
      }
    },
    "MemAllocatedAmount": {
      "Description": "MemAllocatedAmount",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "MemAllocatedAmount"
        ]
      }
    },
    "OpenPermission": {
      "Description": "Whether Open OS Permission",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "OpenPermission"
        ]
      }
    },
    "MemAllocateRation": {
      "Description": "MemAllocateRation",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "MemAllocateRation"
        ]
      }
    },
    "DiskAllocatedAmount": {
      "Description": "DiskAllocatedAmount",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "DiskAllocatedAmount"
        ]
      }
    },
    "Engine": {
      "Description": "Database Engine Type",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "Engine"
        ]
      }
    },
    "MemUtility": {
      "Description": "MemUtility",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "MemUtility"
        ]
      }
    },
    "MemAllocationRatio": {
      "Description": "Memory Allocation Ratio",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "MemAllocationRatio"
        ]
      }
    },
    "CpuAllocateRation": {
      "Description": "CpuAllocateRation",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "CpuAllocateRation"
        ]
      }
    },
    "Text": {
      "Description": "Text",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "Text"
        ]
      }
    },
    "MemUsedAmount": {
      "Description": "MemUsedAmount",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "MemUsedAmount"
        ]
      }
    },
    "DedicatedHostGroupDesc": {
      "Description": "Dedicated Host Group Description",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "DedicatedHostGroupDesc"
        ]
      }
    },
    "VpcId": {
      "Description": "VPC ID",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "VpcId"
        ]
      }
    },
    "DiskUtility": {
      "Description": "DiskUtility",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "DiskUtility"
        ]
      }
    },
    "CpuAllocationRatio": {
      "Description": "Cpu Allocation Ratio",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "CpuAllocationRatio"
        ]
      }
    },
    "DiskAllocateRation": {
      "Description": "DiskAllocateRation",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "DiskAllocateRation"
        ]
      }
    },
    "HostNumber": {
      "Description": "Total Host Number",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "HostNumber"
        ]
      }
    },
    "CpuAllocatedAmount": {
      "Description": "CpuAllocatedAmount",
      "Value": {
        "Fn::GetAtt": [
          "CDDCDedicatedHostGroup",
          "CpuAllocatedAmount"
        ]
      }
    }
  }
}