Instance

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

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var @default = new AliCloud.Hbase.Instance("default", new AliCloud.Hbase.InstanceArgs
        {
            ColdStorageSize = 0,
            CoreDiskSize = 400,
            CoreDiskType = "cloud_efficiency",
            CoreInstanceQuantity = 2,
            CoreInstanceType = "hbase.sn1.large",
            EngineVersion = "2.0",
            MasterInstanceType = "hbase.sn1.large",
            PayType = "PostPaid",
            ZoneId = "cn-shenzhen-b",
        });
    }

}

Coming soon!

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")

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

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

Create a Instance Resource

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

def 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);

func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)

public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Instance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Instance resource accepts the following input properties:

CoreDiskType string: Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro. local_disk size is fixed.
CoreInstanceType string
EngineVersion 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. * master_instance_type、core_instance_type - (Required, ForceNew) Instance specification. see Instance specifications. or you can call describeInstanceType api.
MasterInstanceType string
AutoRenew bool: true, false, System default to false, valid when pay_type = PrePaid.
ColdStorageSize int: 0 or 0+. 0 means is_cold_storage = false. 0+ means is_cold_storage = true
CoreDiskSize int: User-defined HBase instance one core node’s storage space.Unit: GB. Value range: - Custom storage space; value range: [400, 8000] - 40-GB increments.
CoreInstanceQuantity int: default=2. if core_instance_quantity > 1,this is cluster’s instance. if core_instance_quantity = 1,this is a single instance.
DeletionProtection bool: the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.
Duration int: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = PrePaid. unit: month.
Engine string
MaintainEndTime string: The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
MaintainStartTime string: The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
Name string: HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
PayType string: Valid values are PrePaid, PostPaid,System default to PostPaid.
Tags Dictionary<string, object>: A mapping of tags to assign to the resource.
VswitchId string: if vswitch_id is not empty, that mean net_type = vpc and has a same region. if vswitch_id is empty, net_type_classic
ZoneId string: The Zone to launch the HBase instance. if vswitch_id is not empty, this zone_id can be “” or consistent.

CoreDiskType string: Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro. local_disk size is fixed.
CoreInstanceType string
EngineVersion 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. * master_instance_type、core_instance_type - (Required, ForceNew) Instance specification. see Instance specifications. or you can call describeInstanceType api.
MasterInstanceType string
AutoRenew bool: true, false, System default to false, valid when pay_type = PrePaid.
ColdStorageSize int: 0 or 0+. 0 means is_cold_storage = false. 0+ means is_cold_storage = true
CoreDiskSize int: User-defined HBase instance one core node’s storage space.Unit: GB. Value range: - Custom storage space; value range: [400, 8000] - 40-GB increments.
CoreInstanceQuantity int: default=2. if core_instance_quantity > 1,this is cluster’s instance. if core_instance_quantity = 1,this is a single instance.
DeletionProtection bool: the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.
Duration int: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = PrePaid. unit: month.
Engine string
MaintainEndTime string: The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
MaintainStartTime string: The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
Name string: HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
PayType string: Valid values are PrePaid, PostPaid,System default to PostPaid.
Tags map[string]interface{}: A mapping of tags to assign to the resource.
VswitchId string: if vswitch_id is not empty, that mean net_type = vpc and has a same region. if vswitch_id is empty, net_type_classic
ZoneId string: The Zone to launch the HBase instance. if vswitch_id is not empty, this zone_id can be “” or consistent.

coreDiskType string: Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro. local_disk size is fixed.
coreInstanceType string
engineVersion 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. * master_instance_type、core_instance_type - (Required, ForceNew) Instance specification. see Instance specifications. or you can call describeInstanceType api.
masterInstanceType string
autoRenew boolean: true, false, System default to false, valid when pay_type = PrePaid.
coldStorageSize number: 0 or 0+. 0 means is_cold_storage = false. 0+ means is_cold_storage = true
coreDiskSize 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.
coreInstanceQuantity number: default=2. if core_instance_quantity > 1,this is cluster’s instance. if core_instance_quantity = 1,this is a single instance.
deletionProtection boolean: the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.
duration number: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = PrePaid. unit: month.
engine string
maintainEndTime string: The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintainStartTime string: The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name string: HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
payType string: Valid values are PrePaid, PostPaid,System default to PostPaid.
tags {[key: string]: any}: A mapping of tags to assign to the resource.
vswitchId string: if vswitch_id is not empty, that mean net_type = vpc and has a same region. if vswitch_id is empty, net_type_classic
zoneId string: The Zone to launch the HBase instance. if vswitch_id is not empty, this zone_id can be “” or consistent.

core_disk_type str: Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro. local_disk size is fixed.
core_instance_type str
engine_version str: 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. * master_instance_type、core_instance_type - (Required, ForceNew) Instance specification. see Instance specifications. or you can call describeInstanceType api.
master_instance_type str
auto_renew bool: true, false, System default to false, valid when pay_type = PrePaid.
cold_storage_size float: 0 or 0+. 0 means is_cold_storage = false. 0+ means is_cold_storage = true
core_disk_size 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.
core_instance_quantity 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 bool: the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.
duration float: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = PrePaid. unit: month.
engine str
maintain_end_time 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 str: The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name 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 str: Valid values are PrePaid, PostPaid,System default to PostPaid.
tags Dict[str, Any]: A mapping of tags to assign to the resource.
vswitch_id 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 str: The Zone to launch the HBase instance. if vswitch_id is not empty, this zone_id can be “” or consistent.

Outputs

All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Instance Resource

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

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

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, __props__=None);

func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)

public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoRenew bool: true, false, System default to false, valid when pay_type = PrePaid.
ColdStorageSize int: 0 or 0+. 0 means is_cold_storage = false. 0+ means is_cold_storage = true
CoreDiskSize int: User-defined HBase instance one core node’s storage space.Unit: GB. Value range: - Custom storage space; value range: [400, 8000] - 40-GB increments.
CoreDiskType string: Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro. local_disk size is fixed.
CoreInstanceQuantity int: default=2. if core_instance_quantity > 1,this is cluster’s instance. if core_instance_quantity = 1,this is a single instance.
CoreInstanceType string
DeletionProtection bool: the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.
Duration int: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = PrePaid. unit: month.
Engine string
EngineVersion 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. * master_instance_type、core_instance_type - (Required, ForceNew) Instance specification. see Instance specifications. or you can call describeInstanceType api.
MaintainEndTime string: The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
MaintainStartTime string: The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
MasterInstanceType string
Name string: HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
PayType string: Valid values are PrePaid, PostPaid,System default to PostPaid.
Tags Dictionary<string, object>: A mapping of tags to assign to the resource.
VswitchId string: if vswitch_id is not empty, that mean net_type = vpc and has a same region. if vswitch_id is empty, net_type_classic
ZoneId string: The Zone to launch the HBase instance. if vswitch_id is not empty, this zone_id can be “” or consistent.

AutoRenew bool: true, false, System default to false, valid when pay_type = PrePaid.
ColdStorageSize int: 0 or 0+. 0 means is_cold_storage = false. 0+ means is_cold_storage = true
CoreDiskSize int: User-defined HBase instance one core node’s storage space.Unit: GB. Value range: - Custom storage space; value range: [400, 8000] - 40-GB increments.
CoreDiskType string: Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro. local_disk size is fixed.
CoreInstanceQuantity int: default=2. if core_instance_quantity > 1,this is cluster’s instance. if core_instance_quantity = 1,this is a single instance.
CoreInstanceType string
DeletionProtection bool: the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.
Duration int: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = PrePaid. unit: month.
Engine string
EngineVersion 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. * master_instance_type、core_instance_type - (Required, ForceNew) Instance specification. see Instance specifications. or you can call describeInstanceType api.
MaintainEndTime string: The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
MaintainStartTime string: The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
MasterInstanceType string
Name string: HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
PayType string: Valid values are PrePaid, PostPaid,System default to PostPaid.
Tags map[string]interface{}: A mapping of tags to assign to the resource.
VswitchId string: if vswitch_id is not empty, that mean net_type = vpc and has a same region. if vswitch_id is empty, net_type_classic
ZoneId string: The Zone to launch the HBase instance. if vswitch_id is not empty, this zone_id can be “” or consistent.

autoRenew boolean: true, false, System default to false, valid when pay_type = PrePaid.
coldStorageSize number: 0 or 0+. 0 means is_cold_storage = false. 0+ means is_cold_storage = true
coreDiskSize 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.
coreDiskType string: Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro. local_disk size is fixed.
coreInstanceQuantity number: default=2. if core_instance_quantity > 1,this is cluster’s instance. if core_instance_quantity = 1,this is a single instance.
coreInstanceType string
deletionProtection boolean: the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.
duration number: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = PrePaid. unit: month.
engine string
engineVersion 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. * master_instance_type、core_instance_type - (Required, ForceNew) Instance specification. see Instance specifications. or you can call describeInstanceType api.
maintainEndTime string: The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintainStartTime string: The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
masterInstanceType string
name string: HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
payType string: Valid values are PrePaid, PostPaid,System default to PostPaid.
tags {[key: string]: any}: A mapping of tags to assign to the resource.
vswitchId string: if vswitch_id is not empty, that mean net_type = vpc and has a same region. if vswitch_id is empty, net_type_classic
zoneId string: The Zone to launch the HBase instance. if vswitch_id is not empty, this zone_id can be “” or consistent.

auto_renew bool: true, false, System default to false, valid when pay_type = PrePaid.
cold_storage_size float: 0 or 0+. 0 means is_cold_storage = false. 0+ means is_cold_storage = true
core_disk_size 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.
core_disk_type str: Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro. local_disk size is fixed.
core_instance_quantity float: default=2. if core_instance_quantity > 1,this is cluster’s instance. if core_instance_quantity = 1,this is a single instance.
core_instance_type str
deletion_protection bool: the switch of delete protection. true: delete protect, false: no delete protect. you must set false when you want to delete cluster.
duration float: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = PrePaid. unit: month.
engine str
engine_version str: 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. * master_instance_type、core_instance_type - (Required, ForceNew) Instance specification. see Instance specifications. or you can call describeInstanceType api.
maintain_end_time 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 str: The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
master_instance_type str
name 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 str: Valid values are PrePaid, PostPaid,System default to PostPaid.
tags Dict[str, Any]: A mapping of tags to assign to the resource.
vswitch_id 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 str: The Zone to launch the HBase instance. if vswitch_id is not empty, this zone_id can be “” or consistent.

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud