Cluster

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();

Name	Type	Description
`scope`	`com.aliyun.ros.cdk.core.Construct`	No description.
`id`	`java.lang.String`	No description.
`enableResourcePropertyConstraint`	`java.lang.Boolean`	No 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.

`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 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

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

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

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 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

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

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 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

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.
`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

`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.
`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`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ClusterId: The ID of the instance.
`attrServiceConnAddrs`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ServiceConnAddrs: LIST of ServiceConnAddr.
`attrSlbConnAddrs`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute SlbConnAddrs: LIST of SlbConnAddr.
`attrThriftConn`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ThriftConn: Thrift Connection address list.
`attrUiProxyConnAddrInfo`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute UiProxyConnAddrInfo: WebUI connection information list.
`attrZkConnAddrs`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ZkConnAddrs: List of ZkConnAddr.

`node`^Required

public ConstructNode getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`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 IResolvable getAttrClusterId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterId: The ID of the instance.

`attrServiceConnAddrs`^Required

public IResolvable getAttrServiceConnAddrs();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ServiceConnAddrs: LIST of ServiceConnAddr.

`attrSlbConnAddrs`^Required

public IResolvable getAttrSlbConnAddrs();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SlbConnAddrs: LIST of SlbConnAddr.

`attrThriftConn`^Required

public IResolvable getAttrThriftConn();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ThriftConn: Thrift Connection address list.

`attrUiProxyConnAddrInfo`^Required

public IResolvable getAttrUiProxyConnAddrInfo();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute UiProxyConnAddrInfo: WebUI connection information list.

`attrZkConnAddrs`^Required

public IResolvable getAttrZkConnAddrs();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ZkConnAddrs: List of ZkConnAddr.

Cluster

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

coreInstanceTypeRequired

engineRequired

engineVersionRequired

nodeCountRequired

payTypeRequired

zoneIdRequired

autoRenewPeriodOptional

clusterNameOptional

coldStorageSizeOptional

deletionProtectionOptional

diskSizeOptional

diskTypeOptional

encryptionKeyOptional

masterInstanceTypeOptional

periodOptional

periodUnitOptional

resourceGroupIdOptional

securityIpListOptional

vpcIdOptional

vSwitchIdOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata