Cluster

• Implements: ICluster

This class encapsulates and extends the ROS resource type ALIYUN::HBase::Cluster, which is used to create an ApsaraDB for HBase cluster.

Initializers

import com.aliyun.ros.cdk.hbase.Cluster;
Cluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

coreInstanceType^Required

• 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

• 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

• 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

• Type: java.lang.Number OR com.aliyun.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 - *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 - *Type:* java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The ID of the zone. --- ### `autoRenewPeriod`^Optional - *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 - *Type:* java.lang.String OR com.aliyun.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 - *Type:* java.lang.Number OR com.aliyun.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 - *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 - *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 - *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 - *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 - *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 - *Type:* java.lang.Number OR com.aliyun.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 - *Type:* java.lang.String OR com.aliyun.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 - *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 - *Type:* java.lang.String OR com.aliyun.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 - *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 - *Type:* java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of the vSwitch. --- ## Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. | | addCondition | *No description.* | | addCount | *No description.* | | addDependency | *No description.* | | addResourceDesc | *No description.* | | applyRemovalPolicy | *No description.* | | fetchCondition | *No description.* | | fetchDependency | *No description.* | | fetchResourceDesc | *No description.* | | getAtt | *No description.* | | setMetadata | *No description.* | --- ### `toString`

  public java.lang.String toString()
  

  Returns a string representation of this construct. ### `synthesize`

  public void synthesize(ISynthesisSession session)
  

  Allows this construct to emit artifacts into the cloud assembly during synthesis. This method is usually implemented by framework-level constructs such as `Stack` and `Asset` as they participate in synthesizing the cloud assembly. `session`^Required - *Type:* com.aliyun.ros.cdk.core.ISynthesisSession The synthesis session. --- ### `addCondition`

  public void addCondition(RosCondition condition)
  

  `condition`^Required - *Type:* com.aliyun.ros.cdk.core.RosCondition --- ### `addCount`

  public void addCount(java.lang.Number OR IResolvable count)
  

  `count`^Required - *Type:* java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable --- ### `addDependency`

  public void addDependency(Resource resource)
  

  `resource`^Required - *Type:* com.aliyun.ros.cdk.core.Resource --- ### `addResourceDesc`

  public void addResourceDesc(java.lang.String desc)
  

  `desc`^Required - *Type:* java.lang.String --- ### `applyRemovalPolicy`

  public void applyRemovalPolicy(RemovalPolicy policy)
  

  `policy`^Required - *Type:* com.aliyun.ros.cdk.core.RemovalPolicy --- ### `fetchCondition`

  public RosCondition fetchCondition()
  

  ### `fetchDependency`

  public java.util.List<java.lang.String> fetchDependency()
  

  ### `fetchResourceDesc`

  public java.lang.String fetchResourceDesc()
  

  ### `getAtt`

  public IResolvable getAtt(java.lang.String name)
  

  `name`^Required - *Type:* java.lang.String --- ### `setMetadata`

  public void setMetadata(java.lang.String key, java.lang.Object value)
  

  `key`^Required - *Type:* java.lang.String --- `value`^Required - *Type:* java.lang.Object --- ## Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Return whether the given object is a Construct. | --- ### `isConstruct`

  import com.aliyun.ros.cdk.hbase.Cluster;
  Cluster.isConstruct(java.lang.Object x)
  

  Return whether the given object is a Construct. `x`^Required - *Type:* java.lang.Object --- ## Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. | | env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. | | ref | java.lang.String | *No description.* | | stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. | | resource | com.aliyun.ros.cdk.core.RosResource | *No description.* | | attrClusterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ClusterId: The ID of the instance. | | attrServiceConnAddrs | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ServiceConnAddrs: LIST of ServiceConnAddr. | | attrSlbConnAddrs | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SlbConnAddrs: LIST of SlbConnAddr. | | attrThriftConn | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ThriftConn: Thrift Connection address list. | | attrUiProxyConnAddrInfo | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UiProxyConnAddrInfo: WebUI connection information list. | | attrZkConnAddrs | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ZkConnAddrs: List of ZkConnAddr. | | props | [ClusterProps](../Structs/ClusterProps.md) | *No description.* | --- ### `node`^Required

  public ConstructNode getNode();
  

  - *Type:* com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct. --- ### `env`^Required

  public IResourceEnvironment getEnv();
  

  - *Type:* com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ### `ref`^Required

  public java.lang.String getRef();
  

  - *Type:* java.lang.String --- ### `stack`^Required

  public Stack getStack();
  

  - *Type:* com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined. --- ### `resource`^Optional

  public RosResource getResource();
  

  - *Type:* com.aliyun.ros.cdk.core.RosResource --- ### `attrClusterId`^Required

  public java.lang.Object getAttrClusterId();
  

  - *Type:* java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ClusterId: The ID of the instance. --- ### `attrServiceConnAddrs`^Required

  public java.lang.Object getAttrServiceConnAddrs();
  

  - *Type:* java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ServiceConnAddrs: LIST of ServiceConnAddr. --- ### `attrSlbConnAddrs`^Required

  public java.lang.Object getAttrSlbConnAddrs();
  

  - *Type:* java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SlbConnAddrs: LIST of SlbConnAddr. --- ### `attrThriftConn`^Required

  public java.lang.Object getAttrThriftConn();
  

  - *Type:* java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ThriftConn: Thrift Connection address list. --- ### `attrUiProxyConnAddrInfo`^Required

  public java.lang.Object getAttrUiProxyConnAddrInfo();
  

  - *Type:* java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute UiProxyConnAddrInfo: WebUI connection information list. --- ### `attrZkConnAddrs`^Required

  public java.lang.Object getAttrZkConnAddrs();
  

  - *Type:* java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ZkConnAddrs: List of ZkConnAddr. --- ### `props`^Required

  public ClusterProps getProps();
  

  - *Type:* [ClusterProps](../Structs/ClusterProps.md) ---