Skip to content

ClusterProps

Properties for defining a Cluster.

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

Initializer 

import { ClusterProps } from '@alicloud/ros-cdk-hbase'
const clusterProps: ClusterProps = { ... }

Properties

Name Type Description
coreInstanceType string | @alicloud/ros-cdk-core.IResolvable Property coreInstanceType: You can call the DescribeAvailableResource operation to obtain the value of this parameter.
engine string | @alicloud/ros-cdk-core.IResolvable Property engine: The type of the service.
engineVersion string | @alicloud/ros-cdk-core.IResolvable Property engineVersion: The version of the engine.
nodeCount number | @alicloud/ros-cdk-core.IResolvable Property nodeCount: The number of nodes.
payType string | @alicloud/ros-cdk-core.IResolvable Property payType: The billing method.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The ID of the zone.
autoRenewPeriod number | @alicloud/ros-cdk-core.IResolvable Property autoRenewPeriod: The auto-renewal period.
clusterName string | @alicloud/ros-cdk-core.IResolvable Property clusterName: The name of the instance.
coldStorageSize number | @alicloud/ros-cdk-core.IResolvable Property coldStorageSize: The size of cold data storage.
diskSize number | @alicloud/ros-cdk-core.IResolvable Property diskSize: The disk size of the node.
diskType string | @alicloud/ros-cdk-core.IResolvable Property diskType: The type of the disk.
encryptionKey string | @alicloud/ros-cdk-core.IResolvable Property encryptionKey: The encrypted key ID is empty if the encryption is not enabled.
masterInstanceType string | @alicloud/ros-cdk-core.IResolvable Property masterInstanceType: The instance type of the master node.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The subscription period.
periodUnit string | @alicloud/ros-cdk-core.IResolvable Property periodUnit: The unit of the subscription period.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
securityIpList string | @alicloud/ros-cdk-core.IResolvable Property securityIpList: The IP addresses in the whitelist.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The ID of the virtual private cloud (VPC).
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The ID of the vSwitch.

coreInstanceTypeRequired 

public readonly coreInstanceType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

engineRequired 

public readonly engine: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property engine: The type of the service.

Valid values: hbase hbaseue bds

engineVersionRequired 

public readonly engineVersion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property engineVersion: The version of the engine.

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

nodeCountRequired 

public readonly nodeCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property nodeCount: 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

payTypeRequired 

public readonly payType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property payType: The billing method.

Prepaid: The subscription billing method is used. Postpaid: The pay-as-you-go billing method is used.

zoneIdRequired 

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: The ID of the zone.

autoRenewPeriodOptional 

public readonly autoRenewPeriod: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

clusterNameOptional 

public readonly clusterName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property clusterName: 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.

coldStorageSizeOptional 

public readonly coldStorageSize: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property coldStorageSize: 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.

diskSizeOptional 

public readonly diskSize: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

diskTypeOptional 

public readonly diskType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property diskType: The type of the disk.

Valid values: cloud_efficiency cloud_ssd local_hdd_pro local_ssd_pro cloud_essd_pl1

encryptionKeyOptional 

public readonly encryptionKey: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

masterInstanceTypeOptional 

public readonly masterInstanceType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property masterInstanceType: The instance type of the master node.

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

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: 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.

periodUnitOptional 

public readonly periodUnit: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property periodUnit: The unit of the subscription period.

Valid values: year month

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

securityIpListOptional 

public readonly securityIpList: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property securityIpList: 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 (,).

vpcIdOptional 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

vSwitchIdOptional 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The ID of the vSwitch.