Docs Home
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
alicloud.hbase.Instance
Explore with Pulumi AI
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 since v1.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 config = new pulumi.Config();
const name = config.get("name") || "tf-example";
const _default = alicloud.hbase.getZones({});
const defaultGetNetworks = alicloud.vpc.getNetworks({
nameRegex: "^default-NODELETING$",
});
const defaultGetSwitches = Promise.all([defaultGetNetworks, _default]).then(([defaultGetNetworks, _default]) => alicloud.vpc.getSwitches({
vpcId: defaultGetNetworks.ids?.[0],
zoneId: _default.zones?.[1]?.id,
}));
const defaultInstance = new alicloud.hbase.Instance("default", {
name: name,
zoneId: _default.then(_default => _default.zones?.[1]?.id),
vswitchId: defaultGetSwitches.then(defaultGetSwitches => defaultGetSwitches.ids?.[0]),
vpcId: defaultGetNetworks.then(defaultGetNetworks => defaultGetNetworks.ids?.[0]),
engine: "hbaseue",
engineVersion: "2.0",
masterInstanceType: "hbase.sn2.2xlarge",
coreInstanceType: "hbase.sn2.2xlarge",
coreInstanceQuantity: 2,
coreDiskType: "cloud_efficiency",
coreDiskSize: 400,
payType: "PostPaid",
coldStorageSize: 0,
deletionProtection: false,
});
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "tf-example"
default = alicloud.hbase.get_zones()
default_get_networks = alicloud.vpc.get_networks(name_regex="^default-NODELETING$")
default_get_switches = alicloud.vpc.get_switches(vpc_id=default_get_networks.ids[0],
zone_id=default.zones[1].id)
default_instance = alicloud.hbase.Instance("default",
name=name,
zone_id=default.zones[1].id,
vswitch_id=default_get_switches.ids[0],
vpc_id=default_get_networks.ids[0],
engine="hbaseue",
engine_version="2.0",
master_instance_type="hbase.sn2.2xlarge",
core_instance_type="hbase.sn2.2xlarge",
core_instance_quantity=2,
core_disk_type="cloud_efficiency",
core_disk_size=400,
pay_type="PostPaid",
cold_storage_size=0,
deletion_protection=False)
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/hbase"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "tf-example"
if param := cfg.Get("name"); param != "" {
name = param
}
_default, err := hbase.GetZones(ctx, &hbase.GetZonesArgs{}, nil)
if err != nil {
return err
}
defaultGetNetworks, err := vpc.GetNetworks(ctx, &vpc.GetNetworksArgs{
NameRegex: pulumi.StringRef("^default-NODELETING$"),
}, nil)
if err != nil {
return err
}
defaultGetSwitches, err := vpc.GetSwitches(ctx, &vpc.GetSwitchesArgs{
VpcId: pulumi.StringRef(defaultGetNetworks.Ids[0]),
ZoneId: pulumi.StringRef(_default.Zones[1].Id),
}, nil)
if err != nil {
return err
}
_, err = hbase.NewInstance(ctx, "default", &hbase.InstanceArgs{
Name: pulumi.String(name),
ZoneId: pulumi.String(_default.Zones[1].Id),
VswitchId: pulumi.String(defaultGetSwitches.Ids[0]),
VpcId: pulumi.String(defaultGetNetworks.Ids[0]),
Engine: pulumi.String("hbaseue"),
EngineVersion: pulumi.String("2.0"),
MasterInstanceType: pulumi.String("hbase.sn2.2xlarge"),
CoreInstanceType: pulumi.String("hbase.sn2.2xlarge"),
CoreInstanceQuantity: pulumi.Int(2),
CoreDiskType: pulumi.String("cloud_efficiency"),
CoreDiskSize: pulumi.Int(400),
PayType: pulumi.String("PostPaid"),
ColdStorageSize: pulumi.Int(0),
DeletionProtection: pulumi.Bool(false),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "tf-example";
var @default = AliCloud.Hbase.GetZones.Invoke();
var defaultGetNetworks = AliCloud.Vpc.GetNetworks.Invoke(new()
{
NameRegex = "^default-NODELETING$",
});
var defaultGetSwitches = AliCloud.Vpc.GetSwitches.Invoke(new()
{
VpcId = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
ZoneId = @default.Apply(getZonesResult => getZonesResult.Zones[1]?.Id),
});
var defaultInstance = new AliCloud.Hbase.Instance("default", new()
{
Name = name,
ZoneId = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Zones[1]?.Id)),
VswitchId = defaultGetSwitches.Apply(getSwitchesResult => getSwitchesResult.Ids[0]),
VpcId = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
Engine = "hbaseue",
EngineVersion = "2.0",
MasterInstanceType = "hbase.sn2.2xlarge",
CoreInstanceType = "hbase.sn2.2xlarge",
CoreInstanceQuantity = 2,
CoreDiskType = "cloud_efficiency",
CoreDiskSize = 400,
PayType = "PostPaid",
ColdStorageSize = 0,
DeletionProtection = false,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.hbase.HbaseFunctions;
import com.pulumi.alicloud.hbase.inputs.GetZonesArgs;
import com.pulumi.alicloud.vpc.VpcFunctions;
import com.pulumi.alicloud.vpc.inputs.GetNetworksArgs;
import com.pulumi.alicloud.vpc.inputs.GetSwitchesArgs;
import com.pulumi.alicloud.hbase.Instance;
import com.pulumi.alicloud.hbase.InstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var name = config.get("name").orElse("tf-example");
final var default = HbaseFunctions.getZones();
final var defaultGetNetworks = VpcFunctions.getNetworks(GetNetworksArgs.builder()
.nameRegex("^default-NODELETING$")
.build());
final var defaultGetSwitches = VpcFunctions.getSwitches(GetSwitchesArgs.builder()
.vpcId(defaultGetNetworks.applyValue(getNetworksResult -> getNetworksResult.ids()[0]))
.zoneId(default_.zones()[1].id())
.build());
var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
.name(name)
.zoneId(default_.zones()[1].id())
.vswitchId(defaultGetSwitches.applyValue(getSwitchesResult -> getSwitchesResult.ids()[0]))
.vpcId(defaultGetNetworks.applyValue(getNetworksResult -> getNetworksResult.ids()[0]))
.engine("hbaseue")
.engineVersion("2.0")
.masterInstanceType("hbase.sn2.2xlarge")
.coreInstanceType("hbase.sn2.2xlarge")
.coreInstanceQuantity(2)
.coreDiskType("cloud_efficiency")
.coreDiskSize(400)
.payType("PostPaid")
.coldStorageSize(0)
.deletionProtection("false")
.build());
}
}
configuration:
name:
type: string
default: tf-example
resources:
defaultInstance:
type: alicloud:hbase:Instance
name: default
properties:
name: ${name}
zoneId: ${default.zones[1].id}
vswitchId: ${defaultGetSwitches.ids[0]}
vpcId: ${defaultGetNetworks.ids[0]}
engine: hbaseue
engineVersion: '2.0'
masterInstanceType: hbase.sn2.2xlarge
coreInstanceType: hbase.sn2.2xlarge
coreInstanceQuantity: 2
coreDiskType: cloud_efficiency
coreDiskSize: 400
payType: PostPaid
coldStorageSize: 0
deletionProtection: 'false'
variables:
default:
fn::invoke:
function: alicloud:hbase:getZones
arguments: {}
defaultGetNetworks:
fn::invoke:
function: alicloud:vpc:getNetworks
arguments:
nameRegex: ^default-NODELETING$
defaultGetSwitches:
fn::invoke:
function: alicloud:vpc:getSwitches
arguments:
vpcId: ${defaultGetNetworks.ids[0]}
zoneId: ${default.zones[1].id}
this is a example for class netType instance. you can find more detail with the examples/hbase dir.
Create Instance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);@overload
def Instance(resource_name: str,
args: InstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Instance(resource_name: str,
opts: Optional[ResourceOptions] = None,
core_instance_type: Optional[str] = None,
master_instance_type: Optional[str] = None,
engine_version: Optional[str] = None,
ip_white: Optional[str] = None,
maintain_start_time: Optional[str] = None,
core_instance_quantity: Optional[int] = None,
core_disk_size: Optional[int] = None,
deletion_protection: Optional[bool] = None,
duration: Optional[int] = None,
engine: Optional[str] = None,
cold_storage_size: Optional[int] = None,
immediate_delete_flag: Optional[bool] = None,
account: Optional[str] = None,
maintain_end_time: Optional[str] = None,
core_disk_type: Optional[str] = None,
auto_renew: Optional[bool] = None,
name: Optional[str] = None,
password: Optional[str] = None,
pay_type: Optional[str] = None,
security_groups: Optional[Sequence[str]] = None,
tags: Optional[Mapping[str, str]] = None,
vpc_id: Optional[str] = None,
vswitch_id: Optional[str] = None,
zone_id: Optional[str] = None)func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: alicloud:hbase:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. InstanceArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. InstanceArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. InstanceArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. InstanceArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. InstanceArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampleinstanceResourceResourceFromHbaseinstance = new AliCloud.Hbase.Instance("exampleinstanceResourceResourceFromHbaseinstance", new()
{
CoreInstanceType = "string",
MasterInstanceType = "string",
EngineVersion = "string",
IpWhite = "string",
MaintainStartTime = "string",
CoreInstanceQuantity = 0,
CoreDiskSize = 0,
DeletionProtection = false,
Duration = 0,
Engine = "string",
ColdStorageSize = 0,
ImmediateDeleteFlag = false,
Account = "string",
MaintainEndTime = "string",
CoreDiskType = "string",
AutoRenew = false,
Name = "string",
Password = "string",
PayType = "string",
SecurityGroups = new[]
{
"string",
},
Tags =
{
{ "string", "string" },
},
VpcId = "string",
VswitchId = "string",
ZoneId = "string",
});
example, err := hbase.NewInstance(ctx, "exampleinstanceResourceResourceFromHbaseinstance", &hbase.InstanceArgs{
CoreInstanceType: pulumi.String("string"),
MasterInstanceType: pulumi.String("string"),
EngineVersion: pulumi.String("string"),
IpWhite: pulumi.String("string"),
MaintainStartTime: pulumi.String("string"),
CoreInstanceQuantity: pulumi.Int(0),
CoreDiskSize: pulumi.Int(0),
DeletionProtection: pulumi.Bool(false),
Duration: pulumi.Int(0),
Engine: pulumi.String("string"),
ColdStorageSize: pulumi.Int(0),
ImmediateDeleteFlag: pulumi.Bool(false),
Account: pulumi.String("string"),
MaintainEndTime: pulumi.String("string"),
CoreDiskType: pulumi.String("string"),
AutoRenew: pulumi.Bool(false),
Name: pulumi.String("string"),
Password: pulumi.String("string"),
PayType: pulumi.String("string"),
SecurityGroups: pulumi.StringArray{
pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
VpcId: pulumi.String("string"),
VswitchId: pulumi.String("string"),
ZoneId: pulumi.String("string"),
})
var exampleinstanceResourceResourceFromHbaseinstance = new Instance("exampleinstanceResourceResourceFromHbaseinstance", InstanceArgs.builder()
.coreInstanceType("string")
.masterInstanceType("string")
.engineVersion("string")
.ipWhite("string")
.maintainStartTime("string")
.coreInstanceQuantity(0)
.coreDiskSize(0)
.deletionProtection(false)
.duration(0)
.engine("string")
.coldStorageSize(0)
.immediateDeleteFlag(false)
.account("string")
.maintainEndTime("string")
.coreDiskType("string")
.autoRenew(false)
.name("string")
.password("string")
.payType("string")
.securityGroups("string")
.tags(Map.of("string", "string"))
.vpcId("string")
.vswitchId("string")
.zoneId("string")
.build());
exampleinstance_resource_resource_from_hbaseinstance = alicloud.hbase.Instance("exampleinstanceResourceResourceFromHbaseinstance",
core_instance_type="string",
master_instance_type="string",
engine_version="string",
ip_white="string",
maintain_start_time="string",
core_instance_quantity=0,
core_disk_size=0,
deletion_protection=False,
duration=0,
engine="string",
cold_storage_size=0,
immediate_delete_flag=False,
account="string",
maintain_end_time="string",
core_disk_type="string",
auto_renew=False,
name="string",
password="string",
pay_type="string",
security_groups=["string"],
tags={
"string": "string",
},
vpc_id="string",
vswitch_id="string",
zone_id="string")
const exampleinstanceResourceResourceFromHbaseinstance = new alicloud.hbase.Instance("exampleinstanceResourceResourceFromHbaseinstance", {
coreInstanceType: "string",
masterInstanceType: "string",
engineVersion: "string",
ipWhite: "string",
maintainStartTime: "string",
coreInstanceQuantity: 0,
coreDiskSize: 0,
deletionProtection: false,
duration: 0,
engine: "string",
coldStorageSize: 0,
immediateDeleteFlag: false,
account: "string",
maintainEndTime: "string",
coreDiskType: "string",
autoRenew: false,
name: "string",
password: "string",
payType: "string",
securityGroups: ["string"],
tags: {
string: "string",
},
vpcId: "string",
vswitchId: "string",
zoneId: "string",
});
type: alicloud:hbase:Instance
properties:
account: string
autoRenew: false
coldStorageSize: 0
coreDiskSize: 0
coreDiskType: string
coreInstanceQuantity: 0
coreInstanceType: string
deletionProtection: false
duration: 0
engine: string
engineVersion: string
immediateDeleteFlag: false
ipWhite: string
maintainEndTime: string
maintainStartTime: string
masterInstanceType: string
name: string
password: string
payType: string
securityGroups:
- string
tags:
string: string
vpcId: string
vswitchId: string
zoneId: string
Instance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Instance resource accepts the following input properties:
- Core
Instance Type This property is required. string - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- Engine
Version stringThis property is required. 
Changes to this property will trigger replacement. - 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 This property is required. string - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- Account string
- The account of the cluster web ui. Size [0-128].
- Auto
Renew - Valid values are
true,false, system default tofalse, valid when pay_type = PrePaid. - Cold
Storage intSize - 0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
- Core
Disk intSize - User-defined HBase instance one core node's storage. Valid when engine=hbase/hbaseue. Bds engine no need core_disk_size, space.Unit: GB. Value range:
- Custom storage space, value range: [20, 64000].
- Cluster [400, 64000], step:40-GB increments.
- Single [20-500GB], step:1-GB increments.
- Core
Disk Type - Valid values are
cloud_ssd,cloud_essd_pl1,cloud_efficiency,local_hdd_pro,local_ssd_pro，``, local_disk size is fixed. When engine=bds, no need to set disk type(or empty string). - Core
Instance intQuantity - Default=2, [1-200]. 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 int
- 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
- Engine
- Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0:
hbaseueandbds. Single hbase instance need to set engine=hbase, core_instance_quantity=1. - Immediate
Delete boolFlag - The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
- Ip
White string - The white ip list of the cluster.
- Maintain
End stringTime - The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 04:00Z.
- Maintain
Start stringTime - The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 02:00Z.
- Name string
- HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
- Password string
- The password of the cluster web ui account. Size [0-128].
- Pay
Type string - Valid values are
PrePaid,PostPaid, System default toPostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+. - Security
Groups List<string> - The security group resource of the cluster.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Vpc
Id - The id of the VPC.
- Vswitch
Id - If vswitch_id is not empty, that mean net_type = vpc and has a same region. If vswitch_id is empty, net_type=classic. Intl site not support classic network.
- Zone
Id - The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
- Core
Instance Type This property is required. string - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- Engine
Version stringThis property is required. Changes to this property will trigger replacement. - 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 This property is required. string - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- Account string
- The account of the cluster web ui. Size [0-128].
- Auto
Renew - Valid values are
true,false, system default tofalse, valid when pay_type = PrePaid. - Cold
Storage intSize - 0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
- Core
Disk intSize - User-defined HBase instance one core node's storage. Valid when engine=hbase/hbaseue. Bds engine no need core_disk_size, space.Unit: GB. Value range:
- Custom storage space, value range: [20, 64000].
- Cluster [400, 64000], step:40-GB increments.
- Single [20-500GB], step:1-GB increments.
- Core
Disk Type - Valid values are
cloud_ssd,cloud_essd_pl1,cloud_efficiency,local_hdd_pro,local_ssd_pro，``, local_disk size is fixed. When engine=bds, no need to set disk type(or empty string). - Core
Instance intQuantity - Default=2, [1-200]. 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 int
- 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
- Engine
- Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0:
hbaseueandbds. Single hbase instance need to set engine=hbase, core_instance_quantity=1. - Immediate
Delete boolFlag - The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
- Ip
White string - The white ip list of the cluster.
- Maintain
End stringTime - The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 04:00Z.
- Maintain
Start stringTime - The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 02:00Z.
- Name string
- HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
- Password string
- The password of the cluster web ui account. Size [0-128].
- Pay
Type string - Valid values are
PrePaid,PostPaid, System default toPostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+. - Security
Groups []string - The security group resource of the cluster.
- map[string]string
- A mapping of tags to assign to the resource.
- Vpc
Id - The id of the VPC.
- Vswitch
Id - If vswitch_id is not empty, that mean net_type = vpc and has a same region. If vswitch_id is empty, net_type=classic. Intl site not support classic network.
- Zone
Id - The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
- core
Instance Type This property is required. String - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- engine
Version StringThis property is required. Changes to this property will trigger replacement. - 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 This property is required. String - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- account String
- The account of the cluster web ui. Size [0-128].
- auto
Renew - Valid values are
true,false, system default tofalse, valid when pay_type = PrePaid. - cold
Storage IntegerSize - 0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
- core
Disk IntegerSize - User-defined HBase instance one core node's storage. Valid when engine=hbase/hbaseue. Bds engine no need core_disk_size, space.Unit: GB. Value range:
- Custom storage space, value range: [20, 64000].
- Cluster [400, 64000], step:40-GB increments.
- Single [20-500GB], step:1-GB increments.
- core
Disk Type - Valid values are
cloud_ssd,cloud_essd_pl1,cloud_efficiency,local_hdd_pro,local_ssd_pro，``, local_disk size is fixed. When engine=bds, no need to set disk type(or empty string). - core
Instance IntegerQuantity - Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
- deletion
Protection Boolean - The switch of delete protection. True: delete protect, False: no delete protect. You must set false when you want to delete cluster.
- duration Integer
- 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
- engine
- Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0:
hbaseueandbds. Single hbase instance need to set engine=hbase, core_instance_quantity=1. - immediate
Delete BooleanFlag - The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
- ip
White String - The white ip list of the cluster.
- maintain
End StringTime - The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 04:00Z.
- maintain
Start StringTime - The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 02:00Z.
- name String
- HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
- password String
- The password of the cluster web ui account. Size [0-128].
- pay
Type String - Valid values are
PrePaid,PostPaid, System default toPostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+. - security
Groups List<String> - The security group resource of the cluster.
- Map<String,String>
- A mapping of tags to assign to the resource.
- vpc
Id - The id of the VPC.
- vswitch
Id - If vswitch_id is not empty, that mean net_type = vpc and has a same region. If vswitch_id is empty, net_type=classic. Intl site not support classic network.
- zone
Id - The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
- core
Instance Type This property is required. string - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- engine
Version stringThis property is required. Changes to this property will trigger replacement. - 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 This property is required. string - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- account string
- The account of the cluster web ui. Size [0-128].
- auto
Renew - Valid values are
true,false, system default tofalse, valid when pay_type = PrePaid. - cold
Storage numberSize - 0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
- core
Disk numberSize - User-defined HBase instance one core node's storage. Valid when engine=hbase/hbaseue. Bds engine no need core_disk_size, space.Unit: GB. Value range:
- Custom storage space, value range: [20, 64000].
- Cluster [400, 64000], step:40-GB increments.
- Single [20-500GB], step:1-GB increments.
- core
Disk Type - Valid values are
cloud_ssd,cloud_essd_pl1,cloud_efficiency,local_hdd_pro,local_ssd_pro，``, local_disk size is fixed. When engine=bds, no need to set disk type(or empty string). - core
Instance numberQuantity - Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
- deletion
Protection 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, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
- engine
- Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0:
hbaseueandbds. Single hbase instance need to set engine=hbase, core_instance_quantity=1. - immediate
Delete booleanFlag - The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
- ip
White string - The white ip list of the cluster.
- maintain
End stringTime - The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 04:00Z.
- maintain
Start stringTime - The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 02:00Z.
- name string
- HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
- password string
- The password of the cluster web ui account. Size [0-128].
- pay
Type string - Valid values are
PrePaid,PostPaid, System default toPostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+. - security
Groups string[] - The security group resource of the cluster.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- vpc
Id - The id of the VPC.
- vswitch
Id - If vswitch_id is not empty, that mean net_type = vpc and has a same region. If vswitch_id is empty, net_type=classic. Intl site not support classic network.
- zone
Id - The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
- core_
instance_ type This property is required. str - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- engine_
version strThis property is required. Changes to this property will trigger replacement. - 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 This property is required. str - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- account str
- The account of the cluster web ui. Size [0-128].
- auto_
renew - Valid values are
true,false, system default tofalse, valid when pay_type = PrePaid. - cold_
storage_ intsize - 0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
- core_
disk_ intsize - User-defined HBase instance one core node's storage. Valid when engine=hbase/hbaseue. Bds engine no need core_disk_size, space.Unit: GB. Value range:
- Custom storage space, value range: [20, 64000].
- Cluster [400, 64000], step:40-GB increments.
- Single [20-500GB], step:1-GB increments.
- core_
disk_ type - Valid values are
cloud_ssd,cloud_essd_pl1,cloud_efficiency,local_hdd_pro,local_ssd_pro，``, local_disk size is fixed. When engine=bds, no need to set disk type(or empty string). - core_
instance_ intquantity - Default=2, [1-200]. 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 int
- 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
- engine
- Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0:
hbaseueandbds. Single hbase instance need to set engine=hbase, core_instance_quantity=1. - immediate_
delete_ boolflag - The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
- ip_
white str - The white ip list of the cluster.
- maintain_
end_ strtime - The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 04:00Z.
- maintain_
start_ strtime - The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 02:00Z.
- name str
- HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
- password str
- The password of the cluster web ui account. Size [0-128].
- pay_
type str - Valid values are
PrePaid,PostPaid, System default toPostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+. - security_
groups Sequence[str] - The security group resource of the cluster.
- Mapping[str, str]
- A mapping of tags to assign to the resource.
- vpc_
id - The id of the VPC.
- vswitch_
id - If vswitch_id is not empty, that mean net_type = vpc and has a same region. If vswitch_id is empty, net_type=classic. Intl site not support classic network.
- zone_
id - The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
- core
Instance Type This property is required. String - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- engine
Version StringThis property is required. Changes to this property will trigger replacement. - 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 This property is required. String - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- account String
- The account of the cluster web ui. Size [0-128].
- auto
Renew - Valid values are
true,false, system default tofalse, valid when pay_type = PrePaid. - cold
Storage NumberSize - 0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
- core
Disk NumberSize - User-defined HBase instance one core node's storage. Valid when engine=hbase/hbaseue. Bds engine no need core_disk_size, space.Unit: GB. Value range:
- Custom storage space, value range: [20, 64000].
- Cluster [400, 64000], step:40-GB increments.
- Single [20-500GB], step:1-GB increments.
- core
Disk Type - Valid values are
cloud_ssd,cloud_essd_pl1,cloud_efficiency,local_hdd_pro,local_ssd_pro，``, local_disk size is fixed. When engine=bds, no need to set disk type(or empty string). - core
Instance NumberQuantity - Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
- deletion
Protection 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, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
- engine
- Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0:
hbaseueandbds. Single hbase instance need to set engine=hbase, core_instance_quantity=1. - immediate
Delete BooleanFlag - The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
- ip
White String - The white ip list of the cluster.
- maintain
End StringTime - The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 04:00Z.
- maintain
Start StringTime - The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 02:00Z.
- name String
- HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
- password String
- The password of the cluster web ui account. Size [0-128].
- pay
Type String - Valid values are
PrePaid,PostPaid, System default toPostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+. - security
Groups List<String> - The security group resource of the cluster.
- Map<String>
- A mapping of tags to assign to the resource.
- vpc
Id - The id of the VPC.
- vswitch
Id - If vswitch_id is not empty, that mean net_type = vpc and has a same region. If vswitch_id is empty, net_type=classic. Intl site not support classic network.
- zone
Id - 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.
- Master
Instance intQuantity - Count nodes of the master node.
- Slb
Conn List<Pulumi.Addrs Ali Cloud. Hbase. Outputs. Instance Slb Conn Addr> The slb service addresses of the cluster. See
slb_conn_addrsbelow.NOTE: Now only instance name can be change. The others(instance_type, disk_size, core_instance_quantity and so on) will be supported in the furture.
- Ui
Proxy List<Pulumi.Conn Addrs Ali Cloud. Hbase. Outputs. Instance Ui Proxy Conn Addr> - The Web UI proxy addresses of the cluster. See
ui_proxy_conn_addrsbelow. - Zk
Conn List<Pulumi.Addrs Ali Cloud. Hbase. Outputs. Instance Zk Conn Addr> - The zookeeper addresses of the cluster. See
zk_conn_addrsbelow.
- Id string
- The provider-assigned unique ID for this managed resource.
- Master
Instance intQuantity - Count nodes of the master node.
- Slb
Conn []InstanceAddrs Slb Conn Addr The slb service addresses of the cluster. See
slb_conn_addrsbelow.NOTE: Now only instance name can be change. The others(instance_type, disk_size, core_instance_quantity and so on) will be supported in the furture.
- Ui
Proxy []InstanceConn Addrs Ui Proxy Conn Addr - The Web UI proxy addresses of the cluster. See
ui_proxy_conn_addrsbelow. - Zk
Conn []InstanceAddrs Zk Conn Addr - The zookeeper addresses of the cluster. See
zk_conn_addrsbelow.
- id String
- The provider-assigned unique ID for this managed resource.
- master
Instance IntegerQuantity - Count nodes of the master node.
- slb
Conn List<InstanceAddrs Slb Conn Addr> The slb service addresses of the cluster. See
slb_conn_addrsbelow.NOTE: Now only instance name can be change. The others(instance_type, disk_size, core_instance_quantity and so on) will be supported in the furture.
- ui
Proxy List<InstanceConn Addrs Ui Proxy Conn Addr> - The Web UI proxy addresses of the cluster. See
ui_proxy_conn_addrsbelow. - zk
Conn List<InstanceAddrs Zk Conn Addr> - The zookeeper addresses of the cluster. See
zk_conn_addrsbelow.
- id string
- The provider-assigned unique ID for this managed resource.
- master
Instance numberQuantity - Count nodes of the master node.
- slb
Conn InstanceAddrs Slb Conn Addr[] The slb service addresses of the cluster. See
slb_conn_addrsbelow.NOTE: Now only instance name can be change. The others(instance_type, disk_size, core_instance_quantity and so on) will be supported in the furture.
- ui
Proxy InstanceConn Addrs Ui Proxy Conn Addr[] - The Web UI proxy addresses of the cluster. See
ui_proxy_conn_addrsbelow. - zk
Conn InstanceAddrs Zk Conn Addr[] - The zookeeper addresses of the cluster. See
zk_conn_addrsbelow.
- id str
- The provider-assigned unique ID for this managed resource.
- master_
instance_ intquantity - Count nodes of the master node.
- slb_
conn_ Sequence[Instanceaddrs Slb Conn Addr] The slb service addresses of the cluster. See
slb_conn_addrsbelow.NOTE: Now only instance name can be change. The others(instance_type, disk_size, core_instance_quantity and so on) will be supported in the furture.
- ui_
proxy_ Sequence[Instanceconn_ addrs Ui Proxy Conn Addr] - The Web UI proxy addresses of the cluster. See
ui_proxy_conn_addrsbelow. - zk_
conn_ Sequence[Instanceaddrs Zk Conn Addr] - The zookeeper addresses of the cluster. See
zk_conn_addrsbelow.
- id String
- The provider-assigned unique ID for this managed resource.
- master
Instance NumberQuantity - Count nodes of the master node.
- slb
Conn List<Property Map>Addrs The slb service addresses of the cluster. See
slb_conn_addrsbelow.NOTE: Now only instance name can be change. The others(instance_type, disk_size, core_instance_quantity and so on) will be supported in the furture.
- ui
Proxy List<Property Map>Conn Addrs - The Web UI proxy addresses of the cluster. See
ui_proxy_conn_addrsbelow. - zk
Conn List<Property Map>Addrs - The zookeeper addresses of the cluster. See
zk_conn_addrsbelow.
Look up 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@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account: Optional[str] = None,
auto_renew: Optional[bool] = None,
cold_storage_size: Optional[int] = None,
core_disk_size: Optional[int] = None,
core_disk_type: Optional[str] = None,
core_instance_quantity: Optional[int] = None,
core_instance_type: Optional[str] = None,
deletion_protection: Optional[bool] = None,
duration: Optional[int] = None,
engine: Optional[str] = None,
engine_version: Optional[str] = None,
immediate_delete_flag: Optional[bool] = None,
ip_white: Optional[str] = None,
maintain_end_time: Optional[str] = None,
maintain_start_time: Optional[str] = None,
master_instance_quantity: Optional[int] = None,
master_instance_type: Optional[str] = None,
name: Optional[str] = None,
password: Optional[str] = None,
pay_type: Optional[str] = None,
security_groups: Optional[Sequence[str]] = None,
slb_conn_addrs: Optional[Sequence[InstanceSlbConnAddrArgs]] = None,
tags: Optional[Mapping[str, str]] = None,
ui_proxy_conn_addrs: Optional[Sequence[InstanceUiProxyConnAddrArgs]] = None,
vpc_id: Optional[str] = None,
vswitch_id: Optional[str] = None,
zk_conn_addrs: Optional[Sequence[InstanceZkConnAddrArgs]] = None,
zone_id: Optional[str] = None) -> Instancefunc 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)public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)resources: _: type: alicloud:hbase:Instance get: id: ${id}- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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:
- Account string
- The account of the cluster web ui. Size [0-128].
- Auto
Renew - Valid values are
true,false, system default tofalse, valid when pay_type = PrePaid. - Cold
Storage intSize - 0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
- Core
Disk intSize - User-defined HBase instance one core node's storage. Valid when engine=hbase/hbaseue. Bds engine no need core_disk_size, space.Unit: GB. Value range:
- Custom storage space, value range: [20, 64000].
- Cluster [400, 64000], step:40-GB increments.
- Single [20-500GB], step:1-GB increments.
- Core
Disk Type - Valid values are
cloud_ssd,cloud_essd_pl1,cloud_efficiency,local_hdd_pro,local_ssd_pro，``, local_disk size is fixed. When engine=bds, no need to set disk type(or empty string). - Core
Instance intQuantity - Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
- Core
Instance stringType - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- 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 int
- 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
- Engine
- Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0:
hbaseueandbds. Single hbase instance need to set engine=hbase, core_instance_quantity=1. - Engine
Version - 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.
- Immediate
Delete boolFlag - The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
- Ip
White string - The white ip list of the cluster.
- Maintain
End stringTime - The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 04:00Z.
- Maintain
Start stringTime - The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 02:00Z.
- Master
Instance intQuantity - Count nodes of the master node.
- Master
Instance stringType - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- Name string
- HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
- Password string
- The password of the cluster web ui account. Size [0-128].
- Pay
Type string - Valid values are
PrePaid,PostPaid, System default toPostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+. - Security
Groups List<string> - The security group resource of the cluster.
- Slb
Conn List<Pulumi.Addrs Ali Cloud. Hbase. Inputs. Instance Slb Conn Addr> The slb service addresses of the cluster. See
slb_conn_addrsbelow.NOTE: Now only instance name can be change. The others(instance_type, disk_size, core_instance_quantity and so on) will be supported in the furture.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Ui
Proxy List<Pulumi.Conn Addrs Ali Cloud. Hbase. Inputs. Instance Ui Proxy Conn Addr> - The Web UI proxy addresses of the cluster. See
ui_proxy_conn_addrsbelow. - Vpc
Id - The id of the VPC.
- Vswitch
Id - If vswitch_id is not empty, that mean net_type = vpc and has a same region. If vswitch_id is empty, net_type=classic. Intl site not support classic network.
- Zk
Conn List<Pulumi.Addrs Ali Cloud. Hbase. Inputs. Instance Zk Conn Addr> - The zookeeper addresses of the cluster. See
zk_conn_addrsbelow. - Zone
Id - The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
- Account string
- The account of the cluster web ui. Size [0-128].
- Auto
Renew - Valid values are
true,false, system default tofalse, valid when pay_type = PrePaid. - Cold
Storage intSize - 0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
- Core
Disk intSize - User-defined HBase instance one core node's storage. Valid when engine=hbase/hbaseue. Bds engine no need core_disk_size, space.Unit: GB. Value range:
- Custom storage space, value range: [20, 64000].
- Cluster [400, 64000], step:40-GB increments.
- Single [20-500GB], step:1-GB increments.
- Core
Disk Type - Valid values are
cloud_ssd,cloud_essd_pl1,cloud_efficiency,local_hdd_pro,local_ssd_pro，``, local_disk size is fixed. When engine=bds, no need to set disk type(or empty string). - Core
Instance intQuantity - Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
- Core
Instance stringType - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- 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 int
- 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
- Engine
- Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0:
hbaseueandbds. Single hbase instance need to set engine=hbase, core_instance_quantity=1. - Engine
Version - 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.
- Immediate
Delete boolFlag - The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
- Ip
White string - The white ip list of the cluster.
- Maintain
End stringTime - The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 04:00Z.
- Maintain
Start stringTime - The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 02:00Z.
- Master
Instance intQuantity - Count nodes of the master node.
- Master
Instance stringType - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- Name string
- HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
- Password string
- The password of the cluster web ui account. Size [0-128].
- Pay
Type string - Valid values are
PrePaid,PostPaid, System default toPostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+. - Security
Groups []string - The security group resource of the cluster.
- Slb
Conn []InstanceAddrs Slb Conn Addr Args The slb service addresses of the cluster. See
slb_conn_addrsbelow.NOTE: Now only instance name can be change. The others(instance_type, disk_size, core_instance_quantity and so on) will be supported in the furture.
- map[string]string
- A mapping of tags to assign to the resource.
- Ui
Proxy []InstanceConn Addrs Ui Proxy Conn Addr Args - The Web UI proxy addresses of the cluster. See
ui_proxy_conn_addrsbelow. - Vpc
Id - The id of the VPC.
- Vswitch
Id - If vswitch_id is not empty, that mean net_type = vpc and has a same region. If vswitch_id is empty, net_type=classic. Intl site not support classic network.
- Zk
Conn []InstanceAddrs Zk Conn Addr Args - The zookeeper addresses of the cluster. See
zk_conn_addrsbelow. - Zone
Id - The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
- account String
- The account of the cluster web ui. Size [0-128].
- auto
Renew - Valid values are
true,false, system default tofalse, valid when pay_type = PrePaid. - cold
Storage IntegerSize - 0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
- core
Disk IntegerSize - User-defined HBase instance one core node's storage. Valid when engine=hbase/hbaseue. Bds engine no need core_disk_size, space.Unit: GB. Value range:
- Custom storage space, value range: [20, 64000].
- Cluster [400, 64000], step:40-GB increments.
- Single [20-500GB], step:1-GB increments.
- core
Disk Type - Valid values are
cloud_ssd,cloud_essd_pl1,cloud_efficiency,local_hdd_pro,local_ssd_pro，``, local_disk size is fixed. When engine=bds, no need to set disk type(or empty string). - core
Instance IntegerQuantity - Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
- core
Instance StringType - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- deletion
Protection Boolean - The switch of delete protection. True: delete protect, False: no delete protect. You must set false when you want to delete cluster.
- duration Integer
- 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
- engine
- Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0:
hbaseueandbds. Single hbase instance need to set engine=hbase, core_instance_quantity=1. - engine
Version - 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.
- immediate
Delete BooleanFlag - The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
- ip
White String - The white ip list of the cluster.
- maintain
End StringTime - The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 04:00Z.
- maintain
Start StringTime - The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 02:00Z.
- master
Instance IntegerQuantity - Count nodes of the master node.
- master
Instance StringType - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- name String
- HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
- password String
- The password of the cluster web ui account. Size [0-128].
- pay
Type String - Valid values are
PrePaid,PostPaid, System default toPostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+. - security
Groups List<String> - The security group resource of the cluster.
- slb
Conn List<InstanceAddrs Slb Conn Addr> The slb service addresses of the cluster. See
slb_conn_addrsbelow.NOTE: Now only instance name can be change. The others(instance_type, disk_size, core_instance_quantity and so on) will be supported in the furture.
- Map<String,String>
- A mapping of tags to assign to the resource.
- ui
Proxy List<InstanceConn Addrs Ui Proxy Conn Addr> - The Web UI proxy addresses of the cluster. See
ui_proxy_conn_addrsbelow. - vpc
Id - The id of the VPC.
- vswitch
Id - If vswitch_id is not empty, that mean net_type = vpc and has a same region. If vswitch_id is empty, net_type=classic. Intl site not support classic network.
- zk
Conn List<InstanceAddrs Zk Conn Addr> - The zookeeper addresses of the cluster. See
zk_conn_addrsbelow. - zone
Id - The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
- account string
- The account of the cluster web ui. Size [0-128].
- auto
Renew - Valid values are
true,false, system default tofalse, valid when pay_type = PrePaid. - cold
Storage numberSize - 0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
- core
Disk numberSize - User-defined HBase instance one core node's storage. Valid when engine=hbase/hbaseue. Bds engine no need core_disk_size, space.Unit: GB. Value range:
- Custom storage space, value range: [20, 64000].
- Cluster [400, 64000], step:40-GB increments.
- Single [20-500GB], step:1-GB increments.
- core
Disk Type - Valid values are
cloud_ssd,cloud_essd_pl1,cloud_efficiency,local_hdd_pro,local_ssd_pro，``, local_disk size is fixed. When engine=bds, no need to set disk type(or empty string). - core
Instance numberQuantity - Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
- core
Instance stringType - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- deletion
Protection 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, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
- engine
- Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0:
hbaseueandbds. Single hbase instance need to set engine=hbase, core_instance_quantity=1. - engine
Version - 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.
- immediate
Delete booleanFlag - The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
- ip
White string - The white ip list of the cluster.
- maintain
End stringTime - The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 04:00Z.
- maintain
Start stringTime - The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 02:00Z.
- master
Instance numberQuantity - Count nodes of the master node.
- master
Instance stringType - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- name string
- HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
- password string
- The password of the cluster web ui account. Size [0-128].
- pay
Type string - Valid values are
PrePaid,PostPaid, System default toPostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+. - security
Groups string[] - The security group resource of the cluster.
- slb
Conn InstanceAddrs Slb Conn Addr[] The slb service addresses of the cluster. See
slb_conn_addrsbelow.NOTE: Now only instance name can be change. The others(instance_type, disk_size, core_instance_quantity and so on) will be supported in the furture.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- ui
Proxy InstanceConn Addrs Ui Proxy Conn Addr[] - The Web UI proxy addresses of the cluster. See
ui_proxy_conn_addrsbelow. - vpc
Id - The id of the VPC.
- vswitch
Id - If vswitch_id is not empty, that mean net_type = vpc and has a same region. If vswitch_id is empty, net_type=classic. Intl site not support classic network.
- zk
Conn InstanceAddrs Zk Conn Addr[] - The zookeeper addresses of the cluster. See
zk_conn_addrsbelow. - zone
Id - The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
- account str
- The account of the cluster web ui. Size [0-128].
- auto_
renew - Valid values are
true,false, system default tofalse, valid when pay_type = PrePaid. - cold_
storage_ intsize - 0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
- core_
disk_ intsize - User-defined HBase instance one core node's storage. Valid when engine=hbase/hbaseue. Bds engine no need core_disk_size, space.Unit: GB. Value range:
- Custom storage space, value range: [20, 64000].
- Cluster [400, 64000], step:40-GB increments.
- Single [20-500GB], step:1-GB increments.
- core_
disk_ type - Valid values are
cloud_ssd,cloud_essd_pl1,cloud_efficiency,local_hdd_pro,local_ssd_pro，``, local_disk size is fixed. When engine=bds, no need to set disk type(or empty string). - core_
instance_ intquantity - Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
- core_
instance_ strtype - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- 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 int
- 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
- engine
- Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0:
hbaseueandbds. Single hbase instance need to set engine=hbase, core_instance_quantity=1. - engine_
version - 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.
- immediate_
delete_ boolflag - The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
- ip_
white str - The white ip list of the cluster.
- maintain_
end_ strtime - The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 04:00Z.
- maintain_
start_ strtime - The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 02:00Z.
- master_
instance_ intquantity - Count nodes of the master node.
- master_
instance_ strtype - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- name str
- HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
- password str
- The password of the cluster web ui account. Size [0-128].
- pay_
type str - Valid values are
PrePaid,PostPaid, System default toPostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+. - security_
groups Sequence[str] - The security group resource of the cluster.
- slb_
conn_ Sequence[Instanceaddrs Slb Conn Addr Args] The slb service addresses of the cluster. See
slb_conn_addrsbelow.NOTE: Now only instance name can be change. The others(instance_type, disk_size, core_instance_quantity and so on) will be supported in the furture.
- Mapping[str, str]
- A mapping of tags to assign to the resource.
- ui_
proxy_ Sequence[Instanceconn_ addrs Ui Proxy Conn Addr Args] - The Web UI proxy addresses of the cluster. See
ui_proxy_conn_addrsbelow. - vpc_
id - The id of the VPC.
- vswitch_
id - If vswitch_id is not empty, that mean net_type = vpc and has a same region. If vswitch_id is empty, net_type=classic. Intl site not support classic network.
- zk_
conn_ Sequence[Instanceaddrs Zk Conn Addr Args] - The zookeeper addresses of the cluster. See
zk_conn_addrsbelow. - zone_
id - The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
- account String
- The account of the cluster web ui. Size [0-128].
- auto
Renew - Valid values are
true,false, system default tofalse, valid when pay_type = PrePaid. - cold
Storage NumberSize - 0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
- core
Disk NumberSize - User-defined HBase instance one core node's storage. Valid when engine=hbase/hbaseue. Bds engine no need core_disk_size, space.Unit: GB. Value range:
- Custom storage space, value range: [20, 64000].
- Cluster [400, 64000], step:40-GB increments.
- Single [20-500GB], step:1-GB increments.
- core
Disk Type - Valid values are
cloud_ssd,cloud_essd_pl1,cloud_efficiency,local_hdd_pro,local_ssd_pro，``, local_disk size is fixed. When engine=bds, no need to set disk type(or empty string). - core
Instance NumberQuantity - Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
- core
Instance StringType - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- deletion
Protection 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, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
- engine
- Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0:
hbaseueandbds. Single hbase instance need to set engine=hbase, core_instance_quantity=1. - engine
Version - 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.
- immediate
Delete BooleanFlag - The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
- ip
White String - The white ip list of the cluster.
- maintain
End StringTime - The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 04:00Z.
- maintain
Start StringTime - The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time), for example 02:00Z.
- master
Instance NumberQuantity - Count nodes of the master node.
- master
Instance StringType - Instance specification. See Instance specifications, or you can call describeInstanceType api.
- name String
- HBase instance name. Length must be 2-128 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted.
- password String
- The password of the cluster web ui account. Size [0-128].
- pay
Type String - Valid values are
PrePaid,PostPaid, System default toPostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+. - security
Groups List<String> - The security group resource of the cluster.
- slb
Conn List<Property Map>Addrs The slb service addresses of the cluster. See
slb_conn_addrsbelow.NOTE: Now only instance name can be change. The others(instance_type, disk_size, core_instance_quantity and so on) will be supported in the furture.
- Map<String>
- A mapping of tags to assign to the resource.
- ui
Proxy List<Property Map>Conn Addrs - The Web UI proxy addresses of the cluster. See
ui_proxy_conn_addrsbelow. - vpc
Id - The id of the VPC.
- vswitch
Id - If vswitch_id is not empty, that mean net_type = vpc and has a same region. If vswitch_id is empty, net_type=classic. Intl site not support classic network.
- zk
Conn List<Property Map>Addrs - The zookeeper addresses of the cluster. See
zk_conn_addrsbelow. - zone
Id - The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
Supporting Types
InstanceSlbConnAddr, InstanceSlbConnAddrArgs
, InstanceSlbConnAddrArgs
- Conn
Addr string - The Phoenix address.
- Conn
Addr stringPort - The number of the port over which Phoenix connects to the instance.
- Net
Type string - The type of the network. Valid values:
- Conn
Addr string - The Phoenix address.
- Conn
Addr stringPort - The number of the port over which Phoenix connects to the instance.
- Net
Type string - The type of the network. Valid values:
- conn
Addr String - The Phoenix address.
- conn
Addr StringPort - The number of the port over which Phoenix connects to the instance.
- net
Type String - The type of the network. Valid values:
- conn
Addr string - The Phoenix address.
- conn
Addr stringPort - The number of the port over which Phoenix connects to the instance.
- net
Type string - The type of the network. Valid values:
- conn_
addr str - The Phoenix address.
- conn_
addr_ strport - The number of the port over which Phoenix connects to the instance.
- net_
type str - The type of the network. Valid values:
- conn
Addr String - The Phoenix address.
- conn
Addr StringPort - The number of the port over which Phoenix connects to the instance.
- net
Type String - The type of the network. Valid values:
InstanceUiProxyConnAddr, InstanceUiProxyConnAddrArgs
, InstanceUiProxyConnAddrArgs
- Conn
Addr string - The Phoenix address.
- Conn
Addr stringPort - The number of the port over which Phoenix connects to the instance.
- Net
Type string - The type of the network. Valid values:
- Conn
Addr string - The Phoenix address.
- Conn
Addr stringPort - The number of the port over which Phoenix connects to the instance.
- Net
Type string - The type of the network. Valid values:
- conn
Addr String - The Phoenix address.
- conn
Addr StringPort - The number of the port over which Phoenix connects to the instance.
- net
Type String - The type of the network. Valid values:
- conn
Addr string - The Phoenix address.
- conn
Addr stringPort - The number of the port over which Phoenix connects to the instance.
- net
Type string - The type of the network. Valid values:
- conn_
addr str - The Phoenix address.
- conn_
addr_ strport - The number of the port over which Phoenix connects to the instance.
- net_
type str - The type of the network. Valid values:
- conn
Addr String - The Phoenix address.
- conn
Addr StringPort - The number of the port over which Phoenix connects to the instance.
- net
Type String - The type of the network. Valid values:
InstanceZkConnAddr, InstanceZkConnAddrArgs
, InstanceZkConnAddrArgs
- Conn
Addr string - The Phoenix address.
- Conn
Addr stringPort - The number of the port over which Phoenix connects to the instance.
- Net
Type string - The type of the network. Valid values:
- Conn
Addr string - The Phoenix address.
- Conn
Addr stringPort - The number of the port over which Phoenix connects to the instance.
- Net
Type string - The type of the network. Valid values:
- conn
Addr String - The Phoenix address.
- conn
Addr StringPort - The number of the port over which Phoenix connects to the instance.
- net
Type String - The type of the network. Valid values:
- conn
Addr string - The Phoenix address.
- conn
Addr stringPort - The number of the port over which Phoenix connects to the instance.
- net
Type string - The type of the network. Valid values:
- conn_
addr str - The Phoenix address.
- conn_
addr_ strport - The number of the port over which Phoenix connects to the instance.
- net_
type str - The type of the network. Valid values:
- conn
Addr String - The Phoenix address.
- conn
Addr StringPort - The number of the port over which Phoenix connects to the instance.
- net
Type String - The type of the network. Valid values:
Import
HBase can be imported using the id, e.g.
$ pulumi import alicloud:hbase/instance:Instance example hb-wz96815u13k659fvd
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.