MultiZoneCluster

• Implements: IMultiZoneCluster

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

Initializers

import ros_cdk_hbase
ros_cdk_hbase.MultiZoneCluster(
  scope: Construct,
  id: str,
  arbiter_v_switch_id: typing.Union[str, IResolvable],
  arbiter_zone_id: typing.Union[str, IResolvable],
  arch_version: typing.Union[str, IResolvable],
  core_disk_size: typing.Union[typing.Union[int, float], IResolvable],
  core_disk_type: typing.Union[str, IResolvable],
  core_instance_type: typing.Union[str, IResolvable],
  core_node_count: typing.Union[typing.Union[int, float], IResolvable],
  engine: typing.Union[str, IResolvable],
  engine_version: typing.Union[str, IResolvable],
  log_disk_size: typing.Union[typing.Union[int, float], IResolvable],
  log_disk_type: typing.Union[str, IResolvable],
  log_instance_type: typing.Union[str, IResolvable],
  log_node_count: typing.Union[typing.Union[int, float], IResolvable],
  multi_zone_combination: typing.Union[str, IResolvable],
  pay_type: typing.Union[str, IResolvable],
  primary_v_switch_id: typing.Union[str, IResolvable],
  primary_zone_id: typing.Union[str, IResolvable],
  standby_v_switch_id: typing.Union[str, IResolvable],
  standby_zone_id: typing.Union[str, IResolvable],
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  cluster_name: typing.Union[str, IResolvable] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  master_instance_type: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_ip_list: typing.Union[str, IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

arbiter_v_switch_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property arbiterVSwitchId: Arbitration virtual switch ID.

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

arbiter_zone_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property arbiterZoneId: Arbiter zond id.

arch_version^Required

• Type: typing.Union[str, 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.

core_disk_size^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

The step size is 40 GB.

core_disk_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property coreDiskType: Core node disk type.

Valid values: cloud_efficiency cloud_ssd local_hdd_pro local_ssd_pro

core_instance_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

core_node_count^Required

• Type: typing.Union[typing.Union[int, float], 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: typing.Union[str, ros_cdk_core.IResolvable]

Property engine: Service type.

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

engine_version^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property engineVersion: The version of the engine.

Valid values: hbaseue:2.0

log_disk_size^Required

• Type: typing.Union[typing.Union[int, float], 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.

log_disk_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property logDiskType: Log node disk type.

Valid values: cloud_efficiency cloud_ssd local_hdd_pro local_ssd_pro

log_instance_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property logInstanceType: The node specifications for log nodes.

You can query available specifications by calling the DescribeInstanceType API.

log_node_count^Required

• Type: typing.Union[typing.Union[int, float], 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.

multi_zone_combination^Required

• Type: typing.Union[str, 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.

pay_type^Required

• Type: typing.Union[str, 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.

primary_v_switch_id^Required

• Type: typing.Union[str, 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.

primary_zone_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

standby_v_switch_id^Required

• Type: typing.Union[str, 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.

standby_zone_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property standbyZoneId: Standby zone id.

auto_renew_period^Optional

• Type: typing.Union[typing.Union[int, float], 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.

cluster_name^Optional

• Type: typing.Union[str, 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 (_).

deletion_protection^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

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

Default is false.

master_instance_type^Optional

• Type: typing.Union[str, 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: typing.Union[typing.Union[int, float], 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.

period_unit^Optional

• Type: typing.Union[str, 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.

resource_group_id^Optional

• Type: typing.Union[str, 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.

security_ip_list^Optional

• Type: typing.Union[str, 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.

vpc_id^Optional

• Type: typing.Union[str, 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_hbase
ros_cdk_hbase.MultiZoneCluster.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_cluster_id^Required

attr_cluster_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ClusterId: The ID of the instance.

attr_service_conn_addrs^Required

attr_service_conn_addrs: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ServiceConnAddrs: LIST of ServiceConnAddr.

attr_slb_conn_addrs^Required

attr_slb_conn_addrs: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute SlbConnAddrs: LIST of SlbConnAddr.

attr_thrift_conn^Required

attr_thrift_conn: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ThriftConn: Thrift Connection address list.

attr_ui_proxy_conn_addr_info^Required

attr_ui_proxy_conn_addr_info: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute UiProxyConnAddrInfo: WebUI connection information list.

attr_zk_conn_addrs^Required

attr_zk_conn_addrs: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ZkConnAddrs: List of ZkConnAddr.

props^Required

props: MultiZoneClusterProps

• Type: MultiZoneClusterProps