MultiZoneCluster

• Implements: IMultiZoneCluster

This class encapsulates and extends the ROS resource type ALIYUN::HBase::MultiZoneCluster.

Initializers

import com.aliyun.ros.cdk.hbase.MultiZoneCluster;
MultiZoneCluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .arbiterVSwitchId(java.lang.String)
    .arbiterVSwitchId(IResolvable)
    .arbiterZoneId(java.lang.String)
    .arbiterZoneId(IResolvable)
    .archVersion(java.lang.String)
    .archVersion(IResolvable)
    .coreDiskSize(java.lang.Number)
    .coreDiskSize(IResolvable)
    .coreDiskType(java.lang.String)
    .coreDiskType(IResolvable)
    .coreInstanceType(java.lang.String)
    .coreInstanceType(IResolvable)
    .coreNodeCount(java.lang.Number)
    .coreNodeCount(IResolvable)
    .engine(java.lang.String)
    .engine(IResolvable)
    .engineVersion(java.lang.String)
    .engineVersion(IResolvable)
    .logDiskSize(java.lang.Number)
    .logDiskSize(IResolvable)
    .logDiskType(java.lang.String)
    .logDiskType(IResolvable)
    .logInstanceType(java.lang.String)
    .logInstanceType(IResolvable)
    .logNodeCount(java.lang.Number)
    .logNodeCount(IResolvable)
    .multiZoneCombination(java.lang.String)
    .multiZoneCombination(IResolvable)
    .payType(java.lang.String)
    .payType(IResolvable)
    .primaryVSwitchId(java.lang.String)
    .primaryVSwitchId(IResolvable)
    .primaryZoneId(java.lang.String)
    .primaryZoneId(IResolvable)
    .standbyVSwitchId(java.lang.String)
    .standbyVSwitchId(IResolvable)
    .standbyZoneId(java.lang.String)
    .standbyZoneId(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .clusterName(java.lang.String)
//  .clusterName(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(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)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

arbiterVSwitchId^Required

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

Property arbiterVSwitchId: Arbitration virtual switch ID.

The switch must be in the availability zone corresponding to ArbiterZoneId.

arbiterZoneId^Required

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

Property arbiterZoneId: Arbiter zond id.

archVersion^Required

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

Property archVersion: Version of the deployment architecture.

Currently, only the hbaseue engine type is supported. The value can be 2.0.

coreDiskSize^Required

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

Property coreDiskSize: The value ranges from 400 GB to 64,000 GB.

The step size is 40 GB.

coreDiskType^Required

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

Property coreDiskType: Core node disk type.

Valid values: cloud_efficiency cloud_ssd local_hdd_pro local_ssd_pro

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.

coreNodeCount^Required

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

Property coreNodeCount: Number of Core nodes.

The value of the number of Core nodes ranges from 2 to 20, and the increment is a multiple of 2.

engine^Required

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

Property engine: Service type.

Currently, only HBase enhanced version is supported. The value can be hbaseue.

engineVersion^Required

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

Property engineVersion: The version of the engine.

Valid values: hbaseue:2.0

logDiskSize^Required

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

Property logDiskSize: log disk size.

The value ranges from 400 GB to 64,000 GB. The step size is 40 GB.

logDiskType^Required

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

Property logDiskType: Log node disk type.

Valid values: cloud_efficiency cloud_ssd local_hdd_pro local_ssd_pro

logInstanceType^Required

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

Property logInstanceType: The node specifications for log nodes.

You can query available specifications by calling the DescribeInstanceType API.

logNodeCount^Required

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

Property logNodeCount: Log number of nodes.

The value of log nodes ranges from 4 to 400 and is a multiple of 4.

multiZoneCombination^Required

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

Property multiZoneCombination: The zone combination.

You can check the supported zone combinations on the buy page or by calling the DescribeMultiZoneAvailableRegions API.

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.

primaryVSwitchId^Required

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

Property primaryVSwitchId: The virtual switch ID of the instance in primary availability zone must be in the availability zone corresponding to PrimaryZoneId.

primaryZoneId^Required

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

Property primaryZoneId: Availability zone ID of the primary availability zone instance.

standbyVSwitchId^Required

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

Property standbyVSwitchId: The virtual switch ID of the standby availability zone instance must be in the corresponding availability zone of StandbyZoneId.

standbyZoneId^Required

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

Property standbyZoneId: Standby zone id.

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 (_).

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.

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.

Methods

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

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

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

• Type: MultiZoneClusterProps