ClusterProps

Properties for defining a Cluster.

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

Initializer

import com.aliyun.ros.cdk.hbase.ClusterProps;
ClusterProps.builder()
    .coreInstanceType(java.lang.String)
    .coreInstanceType(IResolvable)
    .engine(java.lang.String)
    .engine(IResolvable)
    .engineVersion(java.lang.String)
    .engineVersion(IResolvable)
    .nodeCount(java.lang.Number)
    .nodeCount(IResolvable)
    .payType(java.lang.String)
    .payType(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .clusterName(java.lang.String)
//  .clusterName(IResolvable)
//  .coldStorageSize(java.lang.Number)
//  .coldStorageSize(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .diskSize(java.lang.Number)
//  .diskSize(IResolvable)
//  .diskType(java.lang.String)
//  .diskType(IResolvable)
//  .encryptionKey(java.lang.String)
//  .encryptionKey(IResolvable)
//  .masterInstanceType(java.lang.String)
//  .masterInstanceType(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .securityIpList(java.lang.String)
//  .securityIpList(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
    .build();

Properties

Name	Type	Description
coreInstanceType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property coreInstanceType: You can call the DescribeAvailableResource operation to obtain the value of this parameter.
engine	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property engine: The type of the service.
engineVersion	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property engineVersion: The version of the engine.
nodeCount	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property nodeCount: The number of nodes.
payType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property payType: The billing method.
zoneId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property zoneId: The ID of the zone.
autoRenewPeriod	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property autoRenewPeriod: The auto-renewal period.
clusterName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property clusterName: The name of the instance.
coldStorageSize	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property coldStorageSize: The size of cold data storage.
deletionProtection	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property deletionProtection: Specifies whether to enable the release protection feature for the cluster.
diskSize	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property diskSize: The disk size of the node.
diskType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property diskType: The type of the disk.
encryptionKey	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property encryptionKey: The encrypted key ID is empty if the encryption is not enabled.
masterInstanceType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property masterInstanceType: The instance type of the master node.
period	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property period: The subscription period.
periodUnit	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property periodUnit: The unit of the subscription period.
resourceGroupId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property resourceGroupId: The ID of the resource group.
securityIpList	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property securityIpList: The IP addresses in the whitelist.
vpcId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property vpcId: The ID of the virtual private cloud (VPC).
vSwitchId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property vSwitchId: The ID of the vSwitch.

---

coreInstanceType^Required

public java.lang.Object getCoreInstanceType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

---

engine^Required

public java.lang.Object getEngine();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property engine: The type of the service.

Valid values: hbase hbaseue bds

---

engineVersion^Required

public java.lang.Object getEngineVersion();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getNodeCount();

• Type: java.lang.Number OR com.aliyun.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

---

payType^Required

public java.lang.Object getPayType();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getZoneId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The ID of the zone.

---

autoRenewPeriod^Optional

public java.lang.Object getAutoRenewPeriod();

• Type: java.lang.Number OR com.aliyun.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 java.lang.Object getClusterName();

• Type: java.lang.String OR com.aliyun.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.

---

coldStorageSize^Optional

public java.lang.Object getColdStorageSize();

• Type: java.lang.Number OR com.aliyun.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.

---

deletionProtection^Optional

public java.lang.Object getDeletionProtection();

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property deletionProtection: Specifies whether to enable the release protection feature for the cluster.

Default is false.

---

diskSize^Optional

public java.lang.Object getDiskSize();

• Type: java.lang.Number OR com.aliyun.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 java.lang.Object getDiskType();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getEncryptionKey();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getMasterInstanceType();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getPeriod();

• Type: java.lang.Number OR com.aliyun.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.

---

periodUnit^Optional

public java.lang.Object getPeriodUnit();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property periodUnit: The unit of the subscription period.

Valid values: year month

---

resourceGroupId^Optional

public java.lang.Object getResourceGroupId();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getSecurityIpList();

• Type: java.lang.String OR com.aliyun.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 (,).

---

vpcId^Optional

public java.lang.Object getVpcId();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getVSwitchId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The ID of the vSwitch.

---