This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

hbase¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.hbase.AwaitableGetInstancesResult(availability_zone=None, id=None, ids=None, instances=None, name_regex=None, names=None, output_file=None, tags=None)¶

class pulumi_alicloud.hbase.AwaitableGetZonesResult(id=None, ids=None, multi=None, output_file=None, zones=None)¶

class pulumi_alicloud.hbase.GetInstancesResult(availability_zone=None, id=None, ids=None, instances=None, name_regex=None, names=None, output_file=None, tags=None)¶

A collection of values returned by getInstances.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: The ids list of HBase instances

instances = None¶: A list of HBase instances. Its every element contains the following attributes:

names = None¶: The names list of HBase instances

tags = None¶: A mapping of tags to assign to the resource.

class pulumi_alicloud.hbase.GetZonesResult(id=None, ids=None, multi=None, output_file=None, zones=None)¶

A collection of values returned by getZones.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of zone IDs.

zones = None¶: A list of availability zones. Each element contains the following attributes:

class pulumi_alicloud.hbase.Instance(resource_name, opts=None, auto_renew=None, cold_storage_size=None, core_disk_size=None, core_disk_type=None, core_instance_quantity=None, core_instance_type=None, deletion_protection=None, duration=None, engine=None, engine_version=None, maintain_end_time=None, maintain_start_time=None, master_instance_type=None, name=None, pay_type=None, tags=None, vswitch_id=None, zone_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a HBase instance resource supports replica set instances only. the HBase provides stable, reliable, and automatic scalable database services. It offers a full range of database solutions, such as disaster recovery, backup, recovery, monitoring, and alarms. You can see detail product introduction here

NOTE: Available in 1.67.0+
NOTE: The following regions don’t support create Classic network HBase instance. [cn-hangzhou,cn-shanghai,cn-qingdao,cn-beijing,cn-shenzhen,ap-southeast-1a,…..] the official website mark more regions. or you can call DescribeRegions
NOTE: Create HBase instance or change instance type and storage would cost 15 minutes. Please make full preparation

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.hbase.Instance("default",
    cold_storage_size=0,
    core_disk_size=400,
    core_disk_type="cloud_efficiency",
    core_instance_quantity=2,
    core_instance_type="hbase.sn1.large",
    engine_version="2.0",
    master_instance_type="hbase.sn1.large",
    pay_type="PostPaid",
    zone_id="cn-shenzhen-b")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
auto_renew (pulumi.Input[bool]) – true, false, System default to false, valid when pay_type = PrePaid.
cold_storage_size (pulumi.Input[float]) – 0 or 0+. 0 means is_cold_storage = false. 0+ means is_cold_storage = true
core_disk_size (pulumi.Input[float]) – User-defined HBase instance one core node’s storage space.Unit: GB. Value range:

- Custom storage space; value range: [400, 8000]
- 40-GB increments.

Parameters

core_disk_type (pulumi.Input[str]) – Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro. local_disk size is fixed.
core_instance_quantity (pulumi.Input[float]) – default=2. if core_instance_quantity > 1,this is cluster’s instance. if core_instance_quantity = 1,this is a single instance.
deletion_protection (pulumi.Input[bool]) – the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.
duration (pulumi.Input[float]) – 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = PrePaid. unit: month.
engine_version (pulumi.Input[str]) – hbase major version. hbase:1.1/2.0, hbaseue:2.0, bds:1.0, unsupport other engine temporarily. Value options can refer to the latest docs CreateInstance.

* `master_instance_type`、`core_instance_type` - (Required, ForceNew) Instance specification. see [Instance specifications](https://help.aliyun.com/document_detail/53532.html). or you can call describeInstanceType api.

Parameters

maintain_end_time (pulumi.Input[str]) – The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintain_start*time (pulumi.Input[str]) –
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name (pulumi.Input[str]) – HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (*), or dash (-) are permitted.
pay_type (pulumi.Input[str]) – Valid values are PrePaid, PostPaid,System default to PostPaid.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
vswitch_id (pulumi.Input[str]) – if vswitch_id is not empty, that mean net_type = vpc and has a same region. if vswitch_id is empty, net_type_classic
zone_id (pulumi.Input[str]) – The Zone to launch the HBase instance. if vswitch_id is not empty, this zone_id can be “” or consistent.

auto_renew: pulumi.Output[bool] = None¶: true, false, System default to false, valid when pay_type = PrePaid.

cold_storage_size: pulumi.Output[float] = None¶: 0 or 0+. 0 means is_cold_storage = false. 0+ means is_cold_storage = true

core_disk_size: pulumi.Output[float] = None¶

User-defined HBase instance one core node’s storage space.Unit: GB. Value range:

Custom storage space; value range: [400, 8000]
40-GB increments.

core_disk_type: pulumi.Output[str] = None¶: Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro. local_disk size is fixed.

core_instance_quantity: pulumi.Output[float] = None¶: default=2. if core_instance_quantity > 1,this is cluster’s instance. if core_instance_quantity = 1,this is a single instance.

deletion_protection: pulumi.Output[bool] = None¶: the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.

duration: pulumi.Output[float] = None¶: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = PrePaid. unit: month.

engine_version: pulumi.Output[str] = None¶

hbase major version. hbase:1.1/2.0, hbaseue:2.0, bds:1.0, unsupport other engine temporarily. Value options can refer to the latest docs CreateInstance.

master_instance_type、core_instance_type - (Required, ForceNew) Instance specification. see Instance specifications. or you can call describeInstanceType api.

maintain_end_time: pulumi.Output[str] = None¶: The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

maintain_start_time: pulumi.Output[str] = None¶: The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

name: pulumi.Output[str] = None¶: HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.

pay_type: pulumi.Output[str] = None¶: Valid values are PrePaid, PostPaid,System default to PostPaid.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

vswitch_id: pulumi.Output[str] = None¶: if vswitch_id is not empty, that mean net_type = vpc and has a same region. if vswitch_id is empty, net_type_classic

zone_id: pulumi.Output[str] = None¶: The Zone to launch the HBase instance. if vswitch_id is not empty, this zone_id can be “” or consistent.

static get(resource_name, id, opts=None, auto_renew=None, cold_storage_size=None, core_disk_size=None, core_disk_type=None, core_instance_quantity=None, core_instance_type=None, deletion_protection=None, duration=None, engine=None, engine_version=None, maintain_end_time=None, maintain_start_time=None, master_instance_type=None, name=None, pay_type=None, tags=None, vswitch_id=None, zone_id=None)¶

Get an existing Instance resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
auto_renew (pulumi.Input[bool]) – true, false, System default to false, valid when pay_type = PrePaid.
cold_storage_size (pulumi.Input[float]) – 0 or 0+. 0 means is_cold_storage = false. 0+ means is_cold_storage = true
core_disk_size (pulumi.Input[float]) – User-defined HBase instance one core node’s storage space.Unit: GB. Value range:

- Custom storage space; value range: [400, 8000]
- 40-GB increments.

Parameters

core_disk_type (pulumi.Input[str]) – Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro. local_disk size is fixed.
core_instance_quantity (pulumi.Input[float]) – default=2. if core_instance_quantity > 1,this is cluster’s instance. if core_instance_quantity = 1,this is a single instance.
deletion_protection (pulumi.Input[bool]) – the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.
duration (pulumi.Input[float]) – 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = PrePaid. unit: month.
engine_version (pulumi.Input[str]) –
hbase major version. hbase:1.1/2.0, hbaseue:2.0, bds:1.0, unsupport other engine temporarily. Value options can refer to the latest docs CreateInstance.

* `master_instance_type`、`core_instance_type` - (Required, ForceNew) Instance specification. see [Instance specifications](https://help.aliyun.com/document_detail/53532.html). or you can call describeInstanceType api.

Parameters

maintain_end_time (pulumi.Input[str]) – The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintain_start*time (pulumi.Input[str]) –
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name (pulumi.Input[str]) – HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (*), or dash (-) are permitted.
pay_type (pulumi.Input[str]) – Valid values are PrePaid, PostPaid,System default to PostPaid.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
vswitch_id (pulumi.Input[str]) – if vswitch_id is not empty, that mean net_type = vpc and has a same region. if vswitch_id is empty, net_type_classic
zone_id (pulumi.Input[str]) – The Zone to launch the HBase instance. if vswitch_id is not empty, this zone_id can be “” or consistent.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_alicloud.hbase.get_instances(availability_zone=None, ids=None, name_regex=None, output_file=None, tags=None, opts=None)¶

The hbase.getInstances data source provides a collection of HBase instances available in Alicloud account. Filters support regular expression for the instance name, ids or availability_zone.

NOTE: Available in 1.67.0+

import pulumi
import pulumi_alicloud as alicloud

hbase = alicloud.hbase.get_instances(availability_zone="cn-shenzhen-b",
    name_regex="tf_testAccHBase")

Parameters

availability_zone (str) – Instance availability zone.
ids (list) – The ids list of HBase instances
name_regex (str) – A regex string to apply to the instance name.
tags (dict) – A mapping of tags to assign to the resource.

pulumi_alicloud.hbase.get_zones(multi=None, output_file=None, opts=None)¶

This data source provides availability zones for HBase that can be accessed by an Alibaba Cloud account within the region configured in the provider.

NOTE: Available in v1.73.0+.

import pulumi
import pulumi_alicloud as alicloud

zones_ids = alicloud.hbase.get_zones()
# Create an HBase instance with the first matched zone
hbase = alicloud.hbase.Instance("hbase", zone_id=zones_ids.zones[0]["id"])
# Other properties...

Parameters: multi (bool) – Indicate whether the zones can be used in a multi AZ configuration. Default to false. Multi AZ is usually used to launch HBase instances.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

hbase¶

On This Page