Skip to content

MultiZoneCluster

This class encapsulates and extends the ROS resource type ALIYUN::HBase::MultiZoneCluster, which is used to create an ApsaraDB for HBase cluster that resides in multiple zones.

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
arbiter_v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property arbiterVSwitchId: Arbitration virtual switch ID.
arbiter_zone_id typing.Union[str, ros_cdk_core.IResolvable] Property arbiterZoneId: Arbiter zond id.
arch_version typing.Union[str, ros_cdk_core.IResolvable] Property archVersion: Version of the deployment architecture.
core_disk_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property coreDiskSize: The value ranges from 400 GB to 64,000 GB.
core_disk_type typing.Union[str, ros_cdk_core.IResolvable] Property coreDiskType: Core node disk type.
core_instance_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 typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property coreNodeCount: Number of Core nodes.
engine typing.Union[str, ros_cdk_core.IResolvable] Property engine: Service type.
engine_version typing.Union[str, ros_cdk_core.IResolvable] Property engineVersion: The version of the engine.
log_disk_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property logDiskSize: log disk size.
log_disk_type typing.Union[str, ros_cdk_core.IResolvable] Property logDiskType: Log node disk type.
log_instance_type typing.Union[str, ros_cdk_core.IResolvable] Property logInstanceType: Log instance type.
log_node_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property logNodeCount: Log number of nodes.
multi_zone_combination typing.Union[str, ros_cdk_core.IResolvable] Property multiZoneCombination: Availability zone combination.
pay_type typing.Union[str, ros_cdk_core.IResolvable] Property payType: The billing method.
primary_v_switch_id 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 typing.Union[str, ros_cdk_core.IResolvable] Property primaryZoneId: Availability zone ID of the primary availability zone instance.
standby_v_switch_id 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 typing.Union[str, ros_cdk_core.IResolvable] Property standbyZoneId: Standby zone id.
auto_renew_period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property autoRenewPeriod: The auto-renewal period.
cluster_name typing.Union[str, ros_cdk_core.IResolvable] Property clusterName: The name of the instance.
deletion_protection typing.Union[bool, ros_cdk_core.IResolvable] Property deletionProtection: Specifies whether to enable the release protection feature for the cluster.
master_instance_type typing.Union[str, ros_cdk_core.IResolvable] Property masterInstanceType: The instance type of the master node.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The subscription period.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: The unit of the subscription period.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
security_ip_list typing.Union[str, ros_cdk_core.IResolvable] Property securityIpList: The IP addresses in the whitelist.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the virtual private cloud (VPC).
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

arbiter_v_switch_idRequired

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

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

Property arbiterZoneId: Arbiter zond id.

arch_versionRequired

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

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

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

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

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

engineRequired

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

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

Property engineVersion: The version of the engine.

Valid values: hbaseue:2.0

log_disk_sizeRequired

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

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

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

Property logInstanceType: Log instance type.

log_node_countRequired

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

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

Property multiZoneCombination: Availability zone combination.

pay_typeRequired

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

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

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

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

standby_v_switch_idRequired

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

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

Property standbyZoneId: Standby zone id.

auto_renew_periodOptional

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

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

deletion_protectionOptional

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

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

periodOptional

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

period_unitOptional

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

Property periodUnit: The unit of the subscription period.

Valid values: year month

resource_group_idOptional

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

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

vpc_idOptional

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

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_cluster_id ros_cdk_core.IResolvable Attribute ClusterId: The ID of the instance.
attr_service_conn_addrs ros_cdk_core.IResolvable Attribute ServiceConnAddrs: LIST of ServiceConnAddr.
attr_slb_conn_addrs ros_cdk_core.IResolvable Attribute SlbConnAddrs: LIST of SlbConnAddr.
attr_thrift_conn ros_cdk_core.IResolvable Attribute ThriftConn: Thrift Connection address list.
attr_ui_proxy_conn_addr_info ros_cdk_core.IResolvable Attribute UiProxyConnAddrInfo: WebUI connection information list.
attr_zk_conn_addrs ros_cdk_core.IResolvable Attribute ZkConnAddrs: List of ZkConnAddr.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_cluster_idRequired 

attr_cluster_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ClusterId: The ID of the instance.

attr_service_conn_addrsRequired 

attr_service_conn_addrs: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ServiceConnAddrs: LIST of ServiceConnAddr.

attr_slb_conn_addrsRequired 

attr_slb_conn_addrs: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SlbConnAddrs: LIST of SlbConnAddr.

attr_thrift_connRequired 

attr_thrift_conn: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ThriftConn: Thrift Connection address list.

attr_ui_proxy_conn_addr_infoRequired 

attr_ui_proxy_conn_addr_info: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UiProxyConnAddrInfo: WebUI connection information list.

attr_zk_conn_addrsRequired 

attr_zk_conn_addrs: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZkConnAddrs: List of ZkConnAddr.