1. Docs
  2. Reference
  3. API
  4. @pulumi/alicloud
  5. hbase

Module hbase

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.

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.

Resources

Functions

Others

Resources

Resource Instance

class Instance extends CustomResource

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

Example Usage

Create a hbase instance
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const defaultInstance = new alicloud.hbase.Instance("default", {
    coldStorageSize: 0,
    coreDiskSize: 400,
    coreDiskType: "cloudEfficiency",
    coreInstanceQuantity: 2,
    coreInstanceType: "hbase.sn1.large",
    engineVersion: "2.0",
    masterInstanceType: "hbase.sn1.large",
    payType: "PostPaid",
    zoneId: "cn-shenzhen-b",
});

constructor

new Instance(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Instance

Returns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property autoRenew

public autoRenew: pulumi.Output<boolean>;

true, false, System default to false, valid when payType = PrePaid.

property coldStorageSize

public coldStorageSize: pulumi.Output<number>;

0 or 0+. 0 means isColdStorage = false. 0+ means isColdStorage = true

property coreDiskSize

public coreDiskSize: pulumi.Output<number | undefined>;

User-defined HBase instance one core node’s storage space.Unit: GB. Value range: - Custom storage space; value range: [400, 8000] - 40-GB increments.

property coreDiskType

public coreDiskType: pulumi.Output<string>;

Valid values are cloudSsd, cloudEfficiency, localHddPro, localSsdPro. localDisk size is fixed.

property coreInstanceQuantity

public coreInstanceQuantity: pulumi.Output<number | undefined>;

default=2. if coreInstanceQuantity > 1,this is cluster’s instance. if coreInstanceQuantity = 1,this is a single instance.

property coreInstanceType

public coreInstanceType: pulumi.Output<string>;

property deletionProtection

public deletionProtection: pulumi.Output<boolean | undefined>;

the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.

property duration

public duration: pulumi.Output<number>;

1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when payType = PrePaid. unit: month.

property engine

public engine: pulumi.Output<string | undefined>;

property engineVersion

public engineVersion: pulumi.Output<string>;

hbase major version. hbase:1.½.0, hbaseue:2.0, bds:1.0, unsupport other engine temporarily. Value options can refer to the latest docs CreateInstance. * masterInstanceType、coreInstanceType - (Required, ForceNew) Instance specification. see Instance specifications. or you can call describeInstanceType api.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maintainEndTime

public maintainEndTime: pulumi.Output<string>;

The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

property maintainStartTime

public maintainStartTime: pulumi.Output<string>;

The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

property masterInstanceType

public masterInstanceType: pulumi.Output<string>;

property name

public name: pulumi.Output<string>;

HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.

property payType

public payType: pulumi.Output<string | undefined>;

Valid values are PrePaid, PostPaid,System default to PostPaid.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vswitchId

public vswitchId: pulumi.Output<string | undefined>;

if vswitchId is not empty, that mean netType = vpc and has a same region. if vswitchId is empty, net_type_classic

property zoneId

public zoneId: pulumi.Output<string>;

The Zone to launch the HBase instance. if vswitchId is not empty, this zoneId can be “” or consistent.

Functions

Function getInstances

getInstances(args?: GetInstancesArgs, opts?: pulumi.InvokeOptions): Promise<GetInstancesResult>

The alicloud.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+

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const hbase = pulumi.output(alicloud.hbase.getInstances({
    availabilityZone: "cn-shenzhen-b",
    nameRegex: "tf_testAccHBase",
}, { async: true }));

Function getZones

getZones(args?: GetZonesArgs, opts?: pulumi.InvokeOptions): Promise<GetZonesResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const zonesIds = alicloud.hbase.getZones({});
// Create an HBase instance with the first matched zone
const hbase = new alicloud.hbase.Instance("hbase", {zoneId: zonesIds.then(zonesIds => zonesIds.zones[0].id)});
// Other properties...

Others

interface GetInstancesArgs

interface GetInstancesArgs

A collection of arguments for invoking getInstances.

property availabilityZone

availabilityZone?: undefined | string;

Instance availability zone.

property ids

ids?: string[];

The ids list of HBase instances

property nameRegex

nameRegex?: undefined | string;

A regex string to apply to the instance name.

property outputFile

outputFile?: undefined | string;

property tags

tags?: undefined | {[key: string]: any};

A mapping of tags to assign to the resource.

interface GetInstancesResult

interface GetInstancesResult

A collection of values returned by getInstances.

property availabilityZone

availabilityZone?: undefined | string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

The ids list of HBase instances

property instances

instances: GetInstancesInstance[];

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

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

The names list of HBase instances

property outputFile

outputFile?: undefined | string;

property tags

tags?: undefined | {[key: string]: any};

A mapping of tags to assign to the resource.

interface GetZonesArgs

interface GetZonesArgs

A collection of arguments for invoking getZones.

property multi

multi?: undefined | false | true;

Indicate whether the zones can be used in a multi AZ configuration. Default to false. Multi AZ is usually used to launch HBase instances.

property outputFile

outputFile?: undefined | string;

interface GetZonesResult

interface GetZonesResult

A collection of values returned by getZones.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of zone IDs.

property multi

multi?: undefined | false | true;

property outputFile

outputFile?: undefined | string;

property zones

zones: GetZonesZone[];

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

interface InstanceArgs

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property autoRenew

autoRenew?: pulumi.Input<boolean>;

true, false, System default to false, valid when payType = PrePaid.

property coldStorageSize

coldStorageSize?: pulumi.Input<number>;

0 or 0+. 0 means isColdStorage = false. 0+ means isColdStorage = true

property coreDiskSize

coreDiskSize?: pulumi.Input<number>;

User-defined HBase instance one core node’s storage space.Unit: GB. Value range: - Custom storage space; value range: [400, 8000] - 40-GB increments.

property coreDiskType

coreDiskType: pulumi.Input<string>;

Valid values are cloudSsd, cloudEfficiency, localHddPro, localSsdPro. localDisk size is fixed.

property coreInstanceQuantity

coreInstanceQuantity?: pulumi.Input<number>;

default=2. if coreInstanceQuantity > 1,this is cluster’s instance. if coreInstanceQuantity = 1,this is a single instance.

property coreInstanceType

coreInstanceType: pulumi.Input<string>;

property deletionProtection

deletionProtection?: pulumi.Input<boolean>;

the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.

property duration

duration?: pulumi.Input<number>;

1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when payType = PrePaid. unit: month.

property engine

engine?: pulumi.Input<string>;

property engineVersion

engineVersion: pulumi.Input<string>;

hbase major version. hbase:1.½.0, hbaseue:2.0, bds:1.0, unsupport other engine temporarily. Value options can refer to the latest docs CreateInstance. * masterInstanceType、coreInstanceType - (Required, ForceNew) Instance specification. see Instance specifications. or you can call describeInstanceType api.

property maintainEndTime

maintainEndTime?: pulumi.Input<string>;

The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

property maintainStartTime

maintainStartTime?: pulumi.Input<string>;

The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

property masterInstanceType

masterInstanceType: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.

property payType

payType?: pulumi.Input<string>;

Valid values are PrePaid, PostPaid,System default to PostPaid.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property vswitchId

vswitchId?: pulumi.Input<string>;

if vswitchId is not empty, that mean netType = vpc and has a same region. if vswitchId is empty, net_type_classic

property zoneId

zoneId?: pulumi.Input<string>;

The Zone to launch the HBase instance. if vswitchId is not empty, this zoneId can be “” or consistent.

interface InstanceState

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property autoRenew

autoRenew?: pulumi.Input<boolean>;

true, false, System default to false, valid when payType = PrePaid.

property coldStorageSize

coldStorageSize?: pulumi.Input<number>;

0 or 0+. 0 means isColdStorage = false. 0+ means isColdStorage = true

property coreDiskSize

coreDiskSize?: pulumi.Input<number>;

User-defined HBase instance one core node’s storage space.Unit: GB. Value range: - Custom storage space; value range: [400, 8000] - 40-GB increments.

property coreDiskType

coreDiskType?: pulumi.Input<string>;

Valid values are cloudSsd, cloudEfficiency, localHddPro, localSsdPro. localDisk size is fixed.

property coreInstanceQuantity

coreInstanceQuantity?: pulumi.Input<number>;

default=2. if coreInstanceQuantity > 1,this is cluster’s instance. if coreInstanceQuantity = 1,this is a single instance.

property coreInstanceType

coreInstanceType?: pulumi.Input<string>;

property deletionProtection

deletionProtection?: pulumi.Input<boolean>;

the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.

property duration

duration?: pulumi.Input<number>;

1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when payType = PrePaid. unit: month.

property engine

engine?: pulumi.Input<string>;

property engineVersion

engineVersion?: pulumi.Input<string>;

hbase major version. hbase:1.½.0, hbaseue:2.0, bds:1.0, unsupport other engine temporarily. Value options can refer to the latest docs CreateInstance. * masterInstanceType、coreInstanceType - (Required, ForceNew) Instance specification. see Instance specifications. or you can call describeInstanceType api.

property maintainEndTime

maintainEndTime?: pulumi.Input<string>;

The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

property maintainStartTime

maintainStartTime?: pulumi.Input<string>;

The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

property masterInstanceType

masterInstanceType?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.

property payType

payType?: pulumi.Input<string>;

Valid values are PrePaid, PostPaid,System default to PostPaid.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property vswitchId

vswitchId?: pulumi.Input<string>;

if vswitchId is not empty, that mean netType = vpc and has a same region. if vswitchId is empty, net_type_classic

property zoneId

zoneId?: pulumi.Input<string>;

The Zone to launch the HBase instance. if vswitchId is not empty, this zoneId can be “” or consistent.