ClusterProps

Properties for defining a Cluster.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbase-cluster

Initializer

import ros_cdk_hbase
ros_cdk_hbase.ClusterProps(
  core_instance_type: typing.Union[str, IResolvable],
  engine: typing.Union[str, IResolvable],
  engine_version: typing.Union[str, IResolvable],
  node_count: typing.Union[typing.Union[int, float], IResolvable],
  pay_type: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  cluster_name: typing.Union[str, IResolvable] = None,
  cold_storage_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  disk_type: typing.Union[str, IResolvable] = None,
  encryption_key: typing.Union[str, 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,
  v_switch_id: typing.Union[str, IResolvable] = None
)

Properties

Name	Type	Description
`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.
`engine`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property engine: The type of the service.
`engine_version`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property engineVersion: The version of the engine.
`node_count`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property nodeCount: The number of nodes.
`pay_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property payType: The billing method.
`zone_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property zoneId: The ID of the zone.
`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.
`cold_storage_size`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property coldStorageSize: The size of cold data storage.
`deletion_protection`	`typing.Union[bool, ros_cdk_core.IResolvable]`	Property deletionProtection: Specifies whether to enable the release protection feature for the cluster.
`disk_size`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property diskSize: The disk size of the node.
`disk_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property diskType: The type of the disk.
`encryption_key`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property encryptionKey: The encrypted key ID is empty if the encryption is not enabled.
`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).
`v_switch_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property vSwitchId: The ID of the vSwitch.

`core_instance_type`^Required

core_instance_type: typing.Union[str, IResolvable]

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

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

`engine`^Required

engine: typing.Union[str, IResolvable]

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

Property engine: The type of the service.

Valid values: hbase hbaseue bds

`engine_version`^Required

engine_version: typing.Union[str, IResolvable]

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

Property engineVersion: The version of the engine.

Valid values: hbase:1.1, 2.0 hbaseue:2.0 bds:1.0

`node_count`^Required

node_count: typing.Union[typing.Union[int, float], IResolvable]

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

`pay_type`^Required

pay_type: typing.Union[str, IResolvable]

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.

`zone_id`^Required

zone_id: typing.Union[str, IResolvable]

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

Property zoneId: The ID of the zone.

`auto_renew_period`^Optional

auto_renew_period: typing.Union[typing.Union[int, float], IResolvable]

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

cluster_name: typing.Union[str, IResolvable]

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.

`cold_storage_size`^Optional

cold_storage_size: typing.Union[typing.Union[int, float], IResolvable]

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

`deletion_protection`^Optional

deletion_protection: typing.Union[bool, IResolvable]

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

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

Default is false.

`disk_size`^Optional

disk_size: typing.Union[typing.Union[int, float], IResolvable]

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

`disk_type`^Optional

disk_type: typing.Union[str, IResolvable]

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

`encryption_key`^Optional

encryption_key: typing.Union[str, IResolvable]

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

`master_instance_type`^Optional

master_instance_type: typing.Union[str, IResolvable]

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

period: typing.Union[typing.Union[int, float], IResolvable]

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_unit`^Optional

period_unit: typing.Union[str, IResolvable]

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

Property periodUnit: The unit of the subscription period.

Valid values: year month

`resource_group_id`^Optional

resource_group_id: typing.Union[str, IResolvable]

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

security_ip_list: typing.Union[str, IResolvable]

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_id`^Optional

vpc_id: typing.Union[str, IResolvable]

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.

`v_switch_id`^Optional

v_switch_id: typing.Union[str, IResolvable]

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

Property vSwitchId: The ID of the vSwitch.

ClusterProps

Initializer

Properties

core_instance_typeRequired

engineRequired

engine_versionRequired

node_countRequired

pay_typeRequired

zone_idRequired

auto_renew_periodOptional

cluster_nameOptional

cold_storage_sizeOptional

deletion_protectionOptional

disk_sizeOptional

disk_typeOptional

encryption_keyOptional

master_instance_typeOptional

periodOptional

period_unitOptional

resource_group_idOptional

security_ip_listOptional

vpc_idOptional

v_switch_idOptional