Skip to content

ClusterProps

Properties for defining a Cluster.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkhbase"
&alicloudroscdkhbase.ClusterProps {
    CoreInstanceType: interface{},
    Engine: interface{},
    EngineVersion: interface{},
    NodeCount: interface{},
    PayType: interface{},
    ZoneId: interface{},
    AutoRenewPeriod: interface{},
    ClusterName: interface{},
    ColdStorageSize: interface{},
    DeletionProtection: interface{},
    DiskSize: interface{},
    DiskType: interface{},
    EncryptionKey: interface{},
    MasterInstanceType: interface{},
    Period: interface{},
    PeriodUnit: interface{},
    ResourceGroupId: interface{},
    SecurityIpList: interface{},
    VpcId: interface{},
    VSwitchId: interface{},
}

Properties

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

CoreInstanceTypeRequired

CoreInstanceType interface{}
  • Type: interface{}

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


EngineRequired

Engine interface{}
  • Type: interface{}

Property engine: The type of the service.

Valid values: hbase hbaseue bds


EngineVersionRequired

EngineVersion interface{}
  • Type: interface{}

Property engineVersion: The version of the engine.

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


NodeCountRequired

NodeCount interface{}
  • Type: interface{}

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
    PayType interface{}
    
    - *Type:* interface{} Property payType: The billing method. Prepaid: The subscription billing method is used. Postpaid: The pay-as-you-go billing method is used. --- ### `ZoneId`Required
    ZoneId interface{}
    
    - *Type:* interface{} Property zoneId: The ID of the zone. --- ### `AutoRenewPeriod`Optional
    AutoRenewPeriod interface{}
    
    - *Type:* interface{} 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
    ClusterName interface{}
    
    - *Type:* interface{} 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
    ColdStorageSize interface{}
    
    - *Type:* interface{} 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
    DeletionProtection interface{}
    
    - *Type:* interface{} Property deletionProtection: Specifies whether to enable the release protection feature for the cluster. Default is false. --- ### `DiskSize`Optional
    DiskSize interface{}
    
    - *Type:* interface{} 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
    DiskType interface{}
    
    - *Type:* interface{} Property diskType: The type of the disk. Valid values: cloud_efficiency cloud_ssd local_hdd_pro local_ssd_pro cloud_essd_pl1 --- ### `EncryptionKey`Optional
    EncryptionKey interface{}
    
    - *Type:* interface{} 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
    MasterInstanceType interface{}
    
    - *Type:* interface{} Property masterInstanceType: The instance type of the master node. You can call the DescribeAvailableResource operation to obtain the value of this parameter. --- ### `Period`Optional
    Period interface{}
    
    - *Type:* interface{} 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
    PeriodUnit interface{}
    
    - *Type:* interface{} 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
    ResourceGroupId interface{}
    
    - *Type:* interface{} 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
    SecurityIpList interface{}
    
    - *Type:* interface{} 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
    VpcId interface{}
    
    - *Type:* interface{} 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
    VSwitchId interface{}
    
    - *Type:* interface{} Property vSwitchId: The ID of the vSwitch. ---