Skip to content

ClusterProps

Properties for defining a Cluster.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbase-cluster

Initializer

using AlibabaCloud.SDK.ROS.CDK.Hbase;
new ClusterProps {
    object CoreInstanceType,
    object Engine,
    object EngineVersion,
    object NodeCount,
    object PayType,
    object ZoneId,
    object AutoRenewPeriod = null,
    object ClusterName = null,
    object ColdStorageSize = null,
    object DeletionProtection = null,
    object DiskSize = null,
    object DiskType = null,
    object EncryptionKey = null,
    object MasterInstanceType = null,
    object Period = null,
    object PeriodUnit = null,
    object ResourceGroupId = null,
    object SecurityIpList = null,
    object VpcId = null,
    object VSwitchId = null
};

Properties

Name Type Description
CoreInstanceType object Property coreInstanceType: You can call the DescribeAvailableResource operation to obtain the value of this parameter.
Engine object Property engine: The type of the service.
EngineVersion object Property engineVersion: The version of the engine.
NodeCount object Property nodeCount: The number of core nodes.
PayType object Property payType: The billing method.
ZoneId object Property zoneId: The ID of the zone.
AutoRenewPeriod object Property autoRenewPeriod: The auto-renewal period.
ClusterName object Property clusterName: Instance name.
ColdStorageSize object Property coldStorageSize: The cold storage capacity of the instance, in GB.
DeletionProtection object Property deletionProtection: Specifies whether to enable the release protection feature for the cluster.
DiskSize object Property diskSize: The disk size of the node.
DiskType object Property diskType: The type of the disk.
EncryptionKey object Property encryptionKey: The encrypted key ID is empty if the encryption is not enabled.
MasterInstanceType object Property masterInstanceType: The instance type of the master node.
Period object Property period: The subscription duration of a subscription instance.
PeriodUnit object Property periodUnit: The purchase unit for subscription instances.
ResourceGroupId object Property resourceGroupId: The ID of the resource group.
SecurityIpList object Property securityIpList: The IP addresses to add to the instance whitelist.
VpcId object Property vpcId: The ID of the virtual private cloud (VPC).
VSwitchId object Property vSwitchId: The ID of the vSwitch.

CoreInstanceTypeRequired

public object CoreInstanceType { get; set; }
  • Type: object

Property coreInstanceType: You can call the DescribeAvailableResource operation to obtain the value of this parameter.


EngineRequired

public object Engine { get; set; }
  • Type: object

Property engine: The type of the service.

Valid values: hbase hbaseue bds


EngineVersionRequired

public object EngineVersion { get; set; }
  • Type: object

Property engineVersion: The version of the engine.

Valid values: hbase:1.1, 2.0 hbaseue:2.0 bds:1.0


NodeCountRequired

public object NodeCount { get; set; }
  • Type: object

Property nodeCount: The number of core nodes.

Valid values are as follows:

  • If the instance is a single node, the number of core nodes is fixed at 1.<\/li>
  • If the instance uses disks, the number of core nodes ranges from 2 to 100.<\/li>
  • If the instance uses local disks, the number of core nodes ranges from 4 to 100.<\/li> <\/ul> --- ### `PayType`Required
    public object PayType { get; set; }
    
    - *Type:* object Property payType: The billing method. Prepaid: The subscription billing method is used. Postpaid: The pay-as-you-go billing method is used. --- ### `ZoneId`Required
    public object ZoneId { get; set; }
    
    - *Type:* object Property zoneId: The ID of the zone. --- ### `AutoRenewPeriod`Optional
    public object AutoRenewPeriod { get; set; }
    
    - *Type:* object Property autoRenewPeriod: 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. --- ### `ClusterName`Optional
    public object ClusterName { get; set; }
    
    - *Type:* object Property clusterName: Instance name. The naming convention is as follows: * Length must be 2 to 128 characters. * Must start with a letter (uppercase or lowercase) or a Chinese character. * Can contain digits or special characters. Valid special characters include the period (.), hyphen (-), and underscore (_). --- ### `ColdStorageSize`Optional
    public object ColdStorageSize { get; set; }
    
    - *Type:* object Property coldStorageSize: The cold storage capacity of the instance, in GB. Valid values are as follows: * 0: Indicates that cold storage is disabled. * 800 to 1 000 000: Indicates that cold storage is enabled. > Cold storage is effective only when the engine type of the instance is hbaseue. --- ### `DeletionProtection`Optional
    public object DeletionProtection { get; set; }
    
    - *Type:* object Property deletionProtection: Specifies whether to enable the release protection feature for the cluster. Default is false. --- ### `DiskSize`Optional
    public object DiskSize { get; set; }
    
    - *Type:* object Property diskSize: 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 --- ### `DiskType`Optional
    public object DiskType { get; set; }
    
    - *Type:* object Property diskType: The type of the disk. Valid values: cloud_efficiency cloud_ssd local_hdd_pro local_ssd_pro cloud_essd_pl1 --- ### `EncryptionKey`Optional
    public object EncryptionKey { get; set; }
    
    - *Type:* object Property encryptionKey: 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. --- ### `MasterInstanceType`Optional
    public object MasterInstanceType { get; set; }
    
    - *Type:* object Property masterInstanceType: The instance type of the master node. You can call the DescribeAvailableResource operation to obtain the value of this parameter. --- ### `Period`Optional
    public object Period { get; set; }
    
    - *Type:* object Property period: The subscription duration of a subscription instance. Valid values: * When PeriodUnit is year, the value range is 1 to 3. * When PeriodUnit is month, the value range is 1 to 9. > This parameter is required only when the payment type of the instance is > Prepaid. --- ### `PeriodUnit`Optional
    public object PeriodUnit { get; set; }
    
    - *Type:* object Property periodUnit: The purchase unit for subscription instances. Valid values: * year: Year. * month: Month. > This parameter is required only when the payment type of the instance is > Prepaid. --- ### `ResourceGroupId`Optional
    public object ResourceGroupId { get; set; }
    
    - *Type:* object Property resourceGroupId: 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. --- ### `SecurityIpList`Optional
    public object SecurityIpList { get; set; }
    
    - *Type:* object Property securityIpList: The IP addresses to add to the instance whitelist. Separate multiple IP addresses with commas (,). > If the IP address is set to 127.0.0.1, access to the instance from all IP > addresses is denied. For example, if the IP address is set to 192.168.0.0/24, all > IP addresses in the range 192.168.0.XX are allowed to access the instance. --- ### `VpcId`Optional
    public object VpcId { get; set; }
    
    - *Type:* object Property vpcId: 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. --- ### `VSwitchId`Optional
    public object VSwitchId { get; set; }
    
    - *Type:* object Property vSwitchId: The ID of the vSwitch. ---