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

coreInstanceType^Required

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.

engine^Required

public readonly engine: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property engine: The type of the service.

Valid values: hbase hbaseue bds

engineVersion^Required

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

nodeCount^Required

public readonly nodeCount: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

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 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. --- ### `zoneId`^Required

  public readonly zoneId: string | IResolvable;
  

  - *Type:* string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The ID of the zone. --- ### `autoRenewPeriod`^Optional

  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. --- ### `clusterName`^Optional

  public readonly clusterName: string | IResolvable;
  

  - *Type:* string | @alicloud/ros-cdk-core.IResolvable 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 readonly coldStorageSize: number | IResolvable;
  

  - *Type:* number | @alicloud/ros-cdk-core.IResolvable 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 readonly deletionProtection: boolean | IResolvable;
  

  - *Type:* boolean | @alicloud/ros-cdk-core.IResolvable Property deletionProtection: Specifies whether to enable the release protection feature for the cluster. Default is false. --- ### `diskSize`^Optional

  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 --- ### `diskType`^Optional

  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 --- ### `encryptionKey`^Optional

  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. --- ### `masterInstanceType`^Optional

  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. --- ### `period`^Optional

  public readonly period: number | IResolvable;
  

  - *Type:* number | @alicloud/ros-cdk-core.IResolvable 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 readonly periodUnit: string | IResolvable;
  

  - *Type:* string | @alicloud/ros-cdk-core.IResolvable 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 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. --- ### `securityIpList`^Optional

  public readonly securityIpList: string | IResolvable;
  

  - *Type:* string | @alicloud/ros-cdk-core.IResolvable 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 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. --- ### `vSwitchId`^Optional

  public readonly vSwitchId: string | IResolvable;
  

  - *Type:* string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The ID of the vSwitch. ---