Resource Orchestration Service:ALIYUN::HBase::Cluster

Syntax

{
  "Type": "ALIYUN::HBase::Cluster",
  "Properties": {
    "AutoRenewPeriod": Integer,
    "ColdStorageSize": Integer,
    "EngineVersion": String,
    "ResourceGroupId": String,
    "NodeCount": Integer,
    "ZoneId": String,
    "VSwitchId": String,
    "Period": Integer,
    "EncryptionKey": String,
    "PayType": String,
    "MasterInstanceType": String,
    "DiskType": String,
    "VpcId": String,
    "SecurityIPList": String,
    "CoreInstanceType": String,
    "DiskSize": Integer,
    "ClusterName": String,
    "Engine": String,
    "PeriodUnit": String
  }
}

Properties

Return values

Fn::GetAtt

• UiProxyConnAddrInfo: the addresses of the web console connections.

• ClusterId: the cluster ID.

• ServiceConnAddrs: the addresses of the sub-services.

• ThriftConn: the addresses of the Thrift connections.

• SlbConnAddrs: the addresses of the connections with the Server Load Balancer (SLB) instances.

• ZkConnAddrs: the addresses of the Zookeeper connections.

Examples

• YAML format

  ROSTemplateFormatVersion: '2015-09-01'
  Parameters:
    AutoRenewPeriod:
      Description:
        en: 'The auto-renewal period. Unit: month.
  
          The default value of this parameter is 0. This value indicates that auto-renewal
          is
  
          disabled.
  
          If this parameter is set to 2, the instance is automatically renewed for a
          two-month
  
          subscription after the instance expires.'
      Required: false
      Type: Number
    ClusterName:
      AllowedPattern: ^[a-zA-Z0-9_-]{2,30}$
      Description:
        en: 'The name of the instance.
  
          The name must be 2 to 128 characters in length, and can contain letters, digits,
          periods
  
          (.), underscores (_), and hyphens (-). It must start with a letter.'
      Required: false
      Type: String
    ColdStorageSize:
      Description:
        en: 'The size of cold data storage.
  
          If this parameter is set to 0, cold data storage is disabled.
  
          If this parameter is set to a value greater than 0, cold data storage is enabled.
  
          The storage size ranges from 800 GB to 100,000 GB and the step size is 10
          GB.'
      Required: false
      Type: Number
    CoreInstanceType:
      Description:
        en: You can call the DescribeAvailableResource operation to obtain the value
          of this parameter.
      Required: true
      Type: String
    DiskSize:
      Description:
        en: 'The disk size of the node. Unit: GB.
  
          For ApsaraDB for HBase in single-node mode, the disk size ranges from 20 GB
          to 500
  
          GB and the step size is 1 GB.
  
          For ApsaraDB for HBase that runs in cluster mode and uses disks, the disk
          size ranges
  
          from 400 GB to 64,000 GB and the step size is 40 GB.
  
          For ApsaraDB for HBase that runs in cluster mode and uses local disks, the
          disk size
  
          varies by instance type. The following list provides the mappings between
          disks sizes
  
          and instance types:
  
          hbase.d1.4xlarge =44000
  
          hbase.d1.6xlarge =66000
  
          hbase.d1.8xlarge =88000
  
          hbase.i2.xlarge =894
  
          hbase.i2.2xlarge =1788
  
          hbase.i2.4xlarge =3576
  
          hbase.i2.8xlarge =7152
  
          hbase.d2s.5xlarge =58400
  
          hbase.d2s.10xlarge =109500'
      Required: false
      Type: Number
    DiskType:
      AllowedValues:
      - cloud_efficiency
      - cloud_essd_pl1
      - cloud_ssd
      - local_hdd_pro
      - local_ssd_pro
      Description:
        en: 'The type of the disk. Valid values:
  
          cloud_efficiency
  
          cloud_ssd
  
          local_hdd_pro
  
          local_ssd_pro
  
          cloud_essd_pl1'
      Required: false
      Type: String
    EncryptionKey:
      Description:
        en: 'The encrypted key ID is empty if the encryption is not enabled.
  
          It shows that the current cloud disk version is unable to close after the
          encryption is turned on.'
      Required: false
      Type: String
    Engine:
      AllowedValues:
      - hbase
      - hbaseue
      - bds
      Description:
        en: 'The type of the service. Valid values:
  
          hbase
  
          hbaseue
  
          bds'
      Required: true
      Type: String
    EngineVersion:
      AllowedValues:
      - '1.0'
      - '1.1'
      - '2.0'
      Description:
        en: 'The version of the engine. Valid values:
  
          hbase:1.1, 2.0
  
          hbaseue:2.0
  
          bds:1.0'
      Required: true
      Type: String
    MasterInstanceType:
      Description:
        en: The instance type of the master node. You can call the DescribeAvailableResource
          operation to obtain the value of this parameter.
      Required: false
      Type: String
    NodeCount:
      Description:
        en: 'The number of nodes. Valid values: 1 to 100.
  
          ApsaraDB for HBase in single-node mode: one node
  
          ApsaraDB for HBase that runs in cluster mode and uses disks: at least two
          nodes
  
          ApsaraDB for HBase that runs in cluster mode and uses local disks: at least
          three
  
          nodes'
      Required: true
      Type: Number
    PayType:
      AllowedValues:
      - PayAsYouGo
      - Subscription
      Description:
        en: 'The billing method.
  
          Prepaid: The subscription billing method is used.
  
          Postpaid: The pay-as-you-go billing method is used.'
      Required: true
      Type: String
    Period:
      AssociationProperty: PayPeriod
      Description:
        en: 'The subscription period.
  
          This parameter only takes effect when the PayType parameter is set to Prepaid.
  
          When the PeriodUnit parameter is set to year, the value of the Period parameter
          ranges
  
          from 1 to 5.
  
          When the PeriodUnit parameter is set to month, the value of the Period parameter
          ranges
  
          from 1 to 9.'
      Required: false
      Type: Number
    PeriodUnit:
      AllowedValues:
      - Month
      - Year
      - month
      - year
      AssociationProperty: PayPeriodUnit
      Description:
        en: 'The unit of the subscription period. Valid values:
  
          year
  
          month'
      Required: false
      Type: String
    ResourceGroupId:
      AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
      Description:
        en: 'The ID of the resource group. You can query the group ID in the resource
          group console.
  
          If you leave this parameter empty, the instance is allocated to the default
          resource
  
          group.'
      Required: false
      Type: String
    SecurityIPList:
      Description:
        en: 'The IP addresses in the whitelist. Example: 192.168.*.*/24. The 0.0.0.0/0
          value cannot
  
          be added to the whitelist. Separate multiple IP addresses with commas (,).'
      Required: false
      Type: String
    VSwitchId:
      AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
      AssociationPropertyMetadata:
        VpcId: ${VpcId}
        ZoneId: ${ZoneId}
      Description:
        en: The ID of the vSwitch.
      Required: false
      Type: String
    VpcId:
      AssociationProperty: ALIYUN::ECS::VPC::VPCId
      Description:
        en: 'The ID of the virtual private cloud (VPC). If you leave this parameter
          and the VSwitchId
  
          parameter empty, the classic network type is used. The VPC network type is
          preferred.'
      Required: false
      Type: String
    ZoneId:
      AssociationProperty: ZoneId
      Description:
        en: The ID of the zone.
      Required: true
      Type: String
  Resources:
    Cluster:
      Properties:
        AutoRenewPeriod:
          Ref: AutoRenewPeriod
        ClusterName:
          Ref: ClusterName
        ColdStorageSize:
          Ref: ColdStorageSize
        CoreInstanceType:
          Ref: CoreInstanceType
        DiskSize:
          Ref: DiskSize
        DiskType:
          Ref: DiskType
        EncryptionKey:
          Ref: EncryptionKey
        Engine:
          Ref: Engine
        EngineVersion:
          Ref: EngineVersion
        MasterInstanceType:
          Ref: MasterInstanceType
        NodeCount:
          Ref: NodeCount
        PayType:
          Ref: PayType
        Period:
          Ref: Period
        PeriodUnit:
          Ref: PeriodUnit
        ResourceGroupId:
          Ref: ResourceGroupId
        SecurityIPList:
          Ref: SecurityIPList
        VSwitchId:
          Ref: VSwitchId
        VpcId:
          Ref: VpcId
        ZoneId:
          Ref: ZoneId
      Type: ALIYUN::HBase::Cluster
  Outputs:
    ClusterId:
      Description: The ID of the instance.
      Value:
        Fn::GetAtt:
        - Cluster
        - ClusterId
    ServiceConnAddrs:
      Description: LIST of ServiceConnAddr.
      Value:
        Fn::GetAtt:
        - Cluster
        - ServiceConnAddrs
    SlbConnAddrs:
      Description: LIST of SlbConnAddr.
      Value:
        Fn::GetAtt:
        - Cluster
        - SlbConnAddrs
    ThriftConn:
      Description: Thrift Connection address list.
      Value:
        Fn::GetAtt:
        - Cluster
        - ThriftConn
    UiProxyConnAddrInfo:
      Description: WebUI connection information list.
      Value:
        Fn::GetAtt:
        - Cluster
        - UiProxyConnAddrInfo
    ZkConnAddrs:
      Description: List of ZkConnAddr.
      Value:
        Fn::GetAtt:
        - Cluster
        - ZkConnAddrs
                          

• JSON format

  {
    "ROSTemplateFormatVersion": "2015-09-01",
    "Parameters": {
      "ColdStorageSize": {
        "Type": "Number",
        "Description": {
          "en": "The size of cold data storage.\nIf this parameter is set to 0, cold data storage is disabled.\nIf this parameter is set to a value greater than 0, cold data storage is enabled.\nThe storage size ranges from 800 GB to 100,000 GB and the step size is 10 GB."
        },
        "Required": false
      },
      "AutoRenewPeriod": {
        "Type": "Number",
        "Description": {
          "en": "The auto-renewal period. Unit: month.\nThe default value of this parameter is 0. This value indicates that auto-renewal is\ndisabled.\nIf this parameter is set to 2, the instance is automatically renewed for a two-month\nsubscription after the instance expires."
        },
        "Required": false
      },
      "EngineVersion": {
        "Type": "String",
        "Description": {
          "en": "The version of the engine. Valid values:\nhbase:1.1, 2.0\nhbaseue:2.0\nbds:1.0"
        },
        "AllowedValues": [
          "1.0",
          "1.1",
          "2.0"
        ],
        "Required": true
      },
      "ResourceGroupId": {
        "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
        "Type": "String",
        "Description": {
          "en": "The ID of the resource group. You can query the group ID in the resource group console.\nIf you leave this parameter empty, the instance is allocated to the default resource\ngroup."
        },
        "Required": false
      },
      "NodeCount": {
        "Type": "Number",
        "Description": {
          "en": "The number of nodes. Valid values: 1 to 100.\nApsaraDB for HBase in single-node mode: one node\nApsaraDB for HBase that runs in cluster mode and uses disks: at least two nodes\nApsaraDB for HBase that runs in cluster mode and uses local disks: at least three\nnodes"
        },
        "Required": true
      },
      "ZoneId": {
        "AssociationProperty": "ZoneId",
        "Type": "String",
        "Description": {
          "en": "The ID of the zone."
        },
        "Required": true
      },
      "VSwitchId": {
        "AssociationPropertyMetadata": {
          "VpcId": "${VpcId}",
          "ZoneId": "${ZoneId}"
        },
        "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
        "Type": "String",
        "Description": {
          "en": "The ID of the vSwitch."
        },
        "Required": false
      },
      "Period": {
        "AssociationProperty": "PayPeriod",
        "Type": "Number",
        "Description": {
          "en": "The subscription period.\nThis parameter only takes effect when the PayType parameter is set to Prepaid.\nWhen the PeriodUnit parameter is set to year, the value of the Period parameter ranges\nfrom 1 to 5.\nWhen the PeriodUnit parameter is set to month, the value of the Period parameter ranges\nfrom 1 to 9."
        },
        "Required": false
      },
      "EncryptionKey": {
        "Type": "String",
        "Description": {
          "en": "The encrypted key ID is empty if the encryption is not enabled.\nIt shows that the current cloud disk version is unable to close after the encryption is turned on."
        },
        "Required": false
      },
      "PayType": {
        "Type": "String",
        "Description": {
          "en": "The billing method.\nPrepaid: The subscription billing method is used.\nPostpaid: The pay-as-you-go billing method is used."
        },
        "AllowedValues": [
          "PayAsYouGo",
          "Subscription"
        ],
        "Required": true
      },
      "MasterInstanceType": {
        "Type": "String",
        "Description": {
          "en": "The instance type of the master node. You can call the DescribeAvailableResource operation to obtain the value of this parameter."
        },
        "Required": false
      },
      "DiskType": {
        "Type": "String",
        "Description": {
          "en": "The type of the disk. Valid values:\ncloud_efficiency\ncloud_ssd\nlocal_hdd_pro\nlocal_ssd_pro\ncloud_essd_pl1"
        },
        "AllowedValues": [
          "cloud_efficiency",
          "cloud_essd_pl1",
          "cloud_ssd",
          "local_hdd_pro",
          "local_ssd_pro"
        ],
        "Required": false
      },
      "VpcId": {
        "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
        "Type": "String",
        "Description": {
          "en": "The ID of the virtual private cloud (VPC). If you leave this parameter and the VSwitchId\nparameter empty, the classic network type is used. The VPC network type is preferred."
        },
        "Required": false
      },
      "SecurityIPList": {
        "Type": "String",
        "Description": {
          "en": "The IP addresses in the whitelist. Example: 192.168.*.*/24. The 0.0.0.0/0 value cannot\nbe added to the whitelist. Separate multiple IP addresses with commas (,)."
        },
        "Required": false
      },
      "CoreInstanceType": {
        "Type": "String",
        "Description": {
          "en": "You can call the DescribeAvailableResource operation to obtain the value of this parameter."
        },
        "Required": true
      },
      "DiskSize": {
        "Type": "Number",
        "Description": {
          "en": "The disk size of the node. Unit: GB.\nFor ApsaraDB for HBase in single-node mode, the disk size ranges from 20 GB to 500\nGB and the step size is 1 GB.\nFor ApsaraDB for HBase that runs in cluster mode and uses disks, the disk size ranges\nfrom 400 GB to 64,000 GB and the step size is 40 GB.\nFor ApsaraDB for HBase that runs in cluster mode and uses local disks, the disk size\nvaries by instance type. The following list provides the mappings between disks sizes\nand instance types:\nhbase.d1.4xlarge =44000\nhbase.d1.6xlarge =66000\nhbase.d1.8xlarge =88000\nhbase.i2.xlarge =894\nhbase.i2.2xlarge =1788\nhbase.i2.4xlarge =3576\nhbase.i2.8xlarge =7152\nhbase.d2s.5xlarge =58400\nhbase.d2s.10xlarge =109500"
        },
        "Required": false
      },
      "ClusterName": {
        "Type": "String",
        "Description": {
          "en": "The name of the instance.\nThe name must be 2 to 128 characters in length, and can contain letters, digits, periods\n(.), underscores (_), and hyphens (-). It must start with a letter."
        },
        "AllowedPattern": "^[a-zA-Z0-9_-]{2,30}$",
        "Required": false
      },
      "Engine": {
        "Type": "String",
        "Description": {
          "en": "The type of the service. Valid values:\nhbase\nhbaseue\nbds"
        },
        "AllowedValues": [
          "hbase",
          "hbaseue",
          "bds"
        ],
        "Required": true
      },
      "PeriodUnit": {
        "AssociationProperty": "PayPeriodUnit",
        "Type": "String",
        "Description": {
          "en": "The unit of the subscription period. Valid values:\nyear\nmonth"
        },
        "AllowedValues": [
          "Month",
          "Year",
          "month",
          "year"
        ],
        "Required": false
      }
    },
    "Resources": {
      "Cluster": {
        "Type": "ALIYUN::HBase::Cluster",
        "Properties": {
          "ColdStorageSize": {
            "Ref": "ColdStorageSize"
          },
          "AutoRenewPeriod": {
            "Ref": "AutoRenewPeriod"
          },
          "EngineVersion": {
            "Ref": "EngineVersion"
          },
          "ResourceGroupId": {
            "Ref": "ResourceGroupId"
          },
          "NodeCount": {
            "Ref": "NodeCount"
          },
          "ZoneId": {
            "Ref": "ZoneId"
          },
          "VSwitchId": {
            "Ref": "VSwitchId"
          },
          "Period": {
            "Ref": "Period"
          },
          "EncryptionKey": {
            "Ref": "EncryptionKey"
          },
          "PayType": {
            "Ref": "PayType"
          },
          "MasterInstanceType": {
            "Ref": "MasterInstanceType"
          },
          "DiskType": {
            "Ref": "DiskType"
          },
          "VpcId": {
            "Ref": "VpcId"
          },
          "SecurityIPList": {
            "Ref": "SecurityIPList"
          },
          "CoreInstanceType": {
            "Ref": "CoreInstanceType"
          },
          "DiskSize": {
            "Ref": "DiskSize"
          },
          "ClusterName": {
            "Ref": "ClusterName"
          },
          "Engine": {
            "Ref": "Engine"
          },
          "PeriodUnit": {
            "Ref": "PeriodUnit"
          }
        }
      }
    },
    "Outputs": {
      "UiProxyConnAddrInfo": {
        "Description": "WebUI connection information list.",
        "Value": {
          "Fn::GetAtt": [
            "Cluster",
            "UiProxyConnAddrInfo"
          ]
        }
      },
      "ClusterId": {
        "Description": "The ID of the instance.",
        "Value": {
          "Fn::GetAtt": [
            "Cluster",
            "ClusterId"
          ]
        }
      },
      "ServiceConnAddrs": {
        "Description": "LIST of ServiceConnAddr.",
        "Value": {
          "Fn::GetAtt": [
            "Cluster",
            "ServiceConnAddrs"
          ]
        }
      },
      "ThriftConn": {
        "Description": "Thrift Connection address list.",
        "Value": {
          "Fn::GetAtt": [
            "Cluster",
            "ThriftConn"
          ]
        }
      },
      "SlbConnAddrs": {
        "Description": "LIST of SlbConnAddr.",
        "Value": {
          "Fn::GetAtt": [
            "Cluster",
            "SlbConnAddrs"
          ]
        }
      },
      "ZkConnAddrs": {
        "Description": "List of ZkConnAddr.",
        "Value": {
          "Fn::GetAtt": [
            "Cluster",
            "ZkConnAddrs"
          ]
        }
      }
    }
  }