Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. hbase
  5. Instance
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.hbase.Instance

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

    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 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.
    args 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 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.
    name String
    The unique name of the resource.
    args 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:

    CoreInstanceType string
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    EngineVersion string
    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.
    MasterInstanceType string
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    Account string
    The account of the cluster web ui. Size [0-128].
    AutoRenew bool
    Valid values are true, false, system default to false, valid when pay_type = PrePaid.
    ColdStorageSize int
    0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
    CoreDiskSize int
    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.
    CoreDiskType string
    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).
    CoreInstanceQuantity int
    Default=2, [1-200]. 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, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
    Engine string
    Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0: hbaseue and bds. Single hbase instance need to set engine=hbase, core_instance_quantity=1.
    ImmediateDeleteFlag bool
    The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
    IpWhite string
    The white ip list of the cluster.
    MaintainEndTime string
    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.
    MaintainStartTime string
    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].
    PayType string
    Valid values are PrePaid, PostPaid, System default to PostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+.
    SecurityGroups List<string>
    The security group resource of the cluster.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    VpcId string
    The id of the VPC.
    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. Intl site not support classic network.
    ZoneId string
    The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
    CoreInstanceType string
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    EngineVersion string
    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.
    MasterInstanceType string
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    Account string
    The account of the cluster web ui. Size [0-128].
    AutoRenew bool
    Valid values are true, false, system default to false, valid when pay_type = PrePaid.
    ColdStorageSize int
    0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
    CoreDiskSize int
    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.
    CoreDiskType string
    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).
    CoreInstanceQuantity int
    Default=2, [1-200]. 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, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
    Engine string
    Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0: hbaseue and bds. Single hbase instance need to set engine=hbase, core_instance_quantity=1.
    ImmediateDeleteFlag bool
    The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
    IpWhite string
    The white ip list of the cluster.
    MaintainEndTime string
    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.
    MaintainStartTime string
    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].
    PayType string
    Valid values are PrePaid, PostPaid, System default to PostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+.
    SecurityGroups []string
    The security group resource of the cluster.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    VpcId string
    The id of the VPC.
    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. Intl site not support classic network.
    ZoneId string
    The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
    coreInstanceType String
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    engineVersion String
    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.
    masterInstanceType String
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    account String
    The account of the cluster web ui. Size [0-128].
    autoRenew Boolean
    Valid values are true, false, system default to false, valid when pay_type = PrePaid.
    coldStorageSize Integer
    0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
    coreDiskSize Integer
    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.
    coreDiskType String
    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).
    coreInstanceQuantity Integer
    Default=2, [1-200]. 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 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 String
    Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0: hbaseue and bds. Single hbase instance need to set engine=hbase, core_instance_quantity=1.
    immediateDeleteFlag Boolean
    The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
    ipWhite String
    The white ip list of the cluster.
    maintainEndTime String
    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.
    maintainStartTime String
    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].
    payType String
    Valid values are PrePaid, PostPaid, System default to PostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+.
    securityGroups List<String>
    The security group resource of the cluster.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    vpcId String
    The id of the VPC.
    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. Intl site not support classic network.
    zoneId String
    The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
    coreInstanceType string
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    engineVersion string
    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.
    masterInstanceType string
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    account string
    The account of the cluster web ui. Size [0-128].
    autoRenew boolean
    Valid values are true, false, system default to false, valid when pay_type = PrePaid.
    coldStorageSize number
    0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
    coreDiskSize number
    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.
    coreDiskType string
    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).
    coreInstanceQuantity number
    Default=2, [1-200]. 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, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
    engine string
    Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0: hbaseue and bds. Single hbase instance need to set engine=hbase, core_instance_quantity=1.
    immediateDeleteFlag boolean
    The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
    ipWhite string
    The white ip list of the cluster.
    maintainEndTime string
    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.
    maintainStartTime string
    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].
    payType string
    Valid values are PrePaid, PostPaid, System default to PostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+.
    securityGroups string[]
    The security group resource of the cluster.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    vpcId string
    The id of the VPC.
    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. Intl site not support classic network.
    zoneId string
    The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
    core_instance_type str
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    engine_version str
    HBase major version. hbase:1.1/2.0, hbaseue:2.0, bds:1.0, unsupport other engine temporarily. Value options can refer to the latest docs CreateInstance.
    master_instance_type 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 bool
    Valid values are true, false, system default to false, valid when pay_type = PrePaid.
    cold_storage_size int
    0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
    core_disk_size int
    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 str
    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_quantity int
    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 str
    Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0: hbaseue and bds. Single hbase instance need to set engine=hbase, core_instance_quantity=1.
    immediate_delete_flag bool
    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_time str
    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_time str
    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 to PostPaid. 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.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    vpc_id str
    The id of the VPC.
    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. Intl site not support classic network.
    zone_id str
    The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.
    coreInstanceType String
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    engineVersion String
    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.
    masterInstanceType String
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    account String
    The account of the cluster web ui. Size [0-128].
    autoRenew Boolean
    Valid values are true, false, system default to false, valid when pay_type = PrePaid.
    coldStorageSize Number
    0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
    coreDiskSize Number
    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.
    coreDiskType String
    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).
    coreInstanceQuantity Number
    Default=2, [1-200]. 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, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
    engine String
    Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0: hbaseue and bds. Single hbase instance need to set engine=hbase, core_instance_quantity=1.
    immediateDeleteFlag Boolean
    The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
    ipWhite String
    The white ip list of the cluster.
    maintainEndTime String
    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.
    maintainStartTime String
    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].
    payType String
    Valid values are PrePaid, PostPaid, System default to PostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+.
    securityGroups List<String>
    The security group resource of the cluster.
    tags Map<String>
    A mapping of tags to assign to the resource.
    vpcId String
    The id of the VPC.
    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. Intl site not support classic network.
    zoneId String
    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.
    MasterInstanceQuantity int
    Count nodes of the master node.
    SlbConnAddrs List<Pulumi.AliCloud.Hbase.Outputs.InstanceSlbConnAddr>

    The slb service addresses of the cluster. See slb_conn_addrs below.

    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.

    UiProxyConnAddrs List<Pulumi.AliCloud.Hbase.Outputs.InstanceUiProxyConnAddr>
    The Web UI proxy addresses of the cluster. See ui_proxy_conn_addrs below.
    ZkConnAddrs List<Pulumi.AliCloud.Hbase.Outputs.InstanceZkConnAddr>
    The zookeeper addresses of the cluster. See zk_conn_addrs below.
    Id string
    The provider-assigned unique ID for this managed resource.
    MasterInstanceQuantity int
    Count nodes of the master node.
    SlbConnAddrs []InstanceSlbConnAddr

    The slb service addresses of the cluster. See slb_conn_addrs below.

    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.

    UiProxyConnAddrs []InstanceUiProxyConnAddr
    The Web UI proxy addresses of the cluster. See ui_proxy_conn_addrs below.
    ZkConnAddrs []InstanceZkConnAddr
    The zookeeper addresses of the cluster. See zk_conn_addrs below.
    id String
    The provider-assigned unique ID for this managed resource.
    masterInstanceQuantity Integer
    Count nodes of the master node.
    slbConnAddrs List<InstanceSlbConnAddr>

    The slb service addresses of the cluster. See slb_conn_addrs below.

    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.

    uiProxyConnAddrs List<InstanceUiProxyConnAddr>
    The Web UI proxy addresses of the cluster. See ui_proxy_conn_addrs below.
    zkConnAddrs List<InstanceZkConnAddr>
    The zookeeper addresses of the cluster. See zk_conn_addrs below.
    id string
    The provider-assigned unique ID for this managed resource.
    masterInstanceQuantity number
    Count nodes of the master node.
    slbConnAddrs InstanceSlbConnAddr[]

    The slb service addresses of the cluster. See slb_conn_addrs below.

    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.

    uiProxyConnAddrs InstanceUiProxyConnAddr[]
    The Web UI proxy addresses of the cluster. See ui_proxy_conn_addrs below.
    zkConnAddrs InstanceZkConnAddr[]
    The zookeeper addresses of the cluster. See zk_conn_addrs below.
    id str
    The provider-assigned unique ID for this managed resource.
    master_instance_quantity int
    Count nodes of the master node.
    slb_conn_addrs Sequence[InstanceSlbConnAddr]

    The slb service addresses of the cluster. See slb_conn_addrs below.

    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_conn_addrs Sequence[InstanceUiProxyConnAddr]
    The Web UI proxy addresses of the cluster. See ui_proxy_conn_addrs below.
    zk_conn_addrs Sequence[InstanceZkConnAddr]
    The zookeeper addresses of the cluster. See zk_conn_addrs below.
    id String
    The provider-assigned unique ID for this managed resource.
    masterInstanceQuantity Number
    Count nodes of the master node.
    slbConnAddrs List<Property Map>

    The slb service addresses of the cluster. See slb_conn_addrs below.

    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.

    uiProxyConnAddrs List<Property Map>
    The Web UI proxy addresses of the cluster. See ui_proxy_conn_addrs below.
    zkConnAddrs List<Property Map>
    The zookeeper addresses of the cluster. See zk_conn_addrs below.

    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) -> Instance
    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)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    Account string
    The account of the cluster web ui. Size [0-128].
    AutoRenew bool
    Valid values are true, false, system default to false, valid when pay_type = PrePaid.
    ColdStorageSize int
    0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
    CoreDiskSize int
    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.
    CoreDiskType string
    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).
    CoreInstanceQuantity int
    Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
    CoreInstanceType string
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    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, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
    Engine string
    Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0: hbaseue and bds. Single hbase instance need to set engine=hbase, core_instance_quantity=1.
    EngineVersion string
    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.
    ImmediateDeleteFlag bool
    The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
    IpWhite string
    The white ip list of the cluster.
    MaintainEndTime string
    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.
    MaintainStartTime string
    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.
    MasterInstanceQuantity int
    Count nodes of the master node.
    MasterInstanceType string
    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].
    PayType string
    Valid values are PrePaid, PostPaid, System default to PostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+.
    SecurityGroups List<string>
    The security group resource of the cluster.
    SlbConnAddrs List<Pulumi.AliCloud.Hbase.Inputs.InstanceSlbConnAddr>

    The slb service addresses of the cluster. See slb_conn_addrs below.

    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.

    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    UiProxyConnAddrs List<Pulumi.AliCloud.Hbase.Inputs.InstanceUiProxyConnAddr>
    The Web UI proxy addresses of the cluster. See ui_proxy_conn_addrs below.
    VpcId string
    The id of the VPC.
    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. Intl site not support classic network.
    ZkConnAddrs List<Pulumi.AliCloud.Hbase.Inputs.InstanceZkConnAddr>
    The zookeeper addresses of the cluster. See zk_conn_addrs below.
    ZoneId string
    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].
    AutoRenew bool
    Valid values are true, false, system default to false, valid when pay_type = PrePaid.
    ColdStorageSize int
    0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
    CoreDiskSize int
    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.
    CoreDiskType string
    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).
    CoreInstanceQuantity int
    Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
    CoreInstanceType string
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    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, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
    Engine string
    Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0: hbaseue and bds. Single hbase instance need to set engine=hbase, core_instance_quantity=1.
    EngineVersion string
    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.
    ImmediateDeleteFlag bool
    The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
    IpWhite string
    The white ip list of the cluster.
    MaintainEndTime string
    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.
    MaintainStartTime string
    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.
    MasterInstanceQuantity int
    Count nodes of the master node.
    MasterInstanceType string
    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].
    PayType string
    Valid values are PrePaid, PostPaid, System default to PostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+.
    SecurityGroups []string
    The security group resource of the cluster.
    SlbConnAddrs []InstanceSlbConnAddrArgs

    The slb service addresses of the cluster. See slb_conn_addrs below.

    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.

    Tags map[string]string
    A mapping of tags to assign to the resource.
    UiProxyConnAddrs []InstanceUiProxyConnAddrArgs
    The Web UI proxy addresses of the cluster. See ui_proxy_conn_addrs below.
    VpcId string
    The id of the VPC.
    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. Intl site not support classic network.
    ZkConnAddrs []InstanceZkConnAddrArgs
    The zookeeper addresses of the cluster. See zk_conn_addrs below.
    ZoneId string
    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].
    autoRenew Boolean
    Valid values are true, false, system default to false, valid when pay_type = PrePaid.
    coldStorageSize Integer
    0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
    coreDiskSize Integer
    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.
    coreDiskType String
    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).
    coreInstanceQuantity Integer
    Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
    coreInstanceType String
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    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 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 String
    Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0: hbaseue and bds. Single hbase instance need to set engine=hbase, core_instance_quantity=1.
    engineVersion String
    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.
    immediateDeleteFlag Boolean
    The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
    ipWhite String
    The white ip list of the cluster.
    maintainEndTime String
    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.
    maintainStartTime String
    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.
    masterInstanceQuantity Integer
    Count nodes of the master node.
    masterInstanceType String
    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].
    payType String
    Valid values are PrePaid, PostPaid, System default to PostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+.
    securityGroups List<String>
    The security group resource of the cluster.
    slbConnAddrs List<InstanceSlbConnAddr>

    The slb service addresses of the cluster. See slb_conn_addrs below.

    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.

    tags Map<String,String>
    A mapping of tags to assign to the resource.
    uiProxyConnAddrs List<InstanceUiProxyConnAddr>
    The Web UI proxy addresses of the cluster. See ui_proxy_conn_addrs below.
    vpcId String
    The id of the VPC.
    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. Intl site not support classic network.
    zkConnAddrs List<InstanceZkConnAddr>
    The zookeeper addresses of the cluster. See zk_conn_addrs below.
    zoneId String
    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].
    autoRenew boolean
    Valid values are true, false, system default to false, valid when pay_type = PrePaid.
    coldStorageSize number
    0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
    coreDiskSize number
    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.
    coreDiskType string
    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).
    coreInstanceQuantity number
    Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
    coreInstanceType string
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    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, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
    engine string
    Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0: hbaseue and bds. Single hbase instance need to set engine=hbase, core_instance_quantity=1.
    engineVersion string
    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.
    immediateDeleteFlag boolean
    The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
    ipWhite string
    The white ip list of the cluster.
    maintainEndTime string
    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.
    maintainStartTime string
    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.
    masterInstanceQuantity number
    Count nodes of the master node.
    masterInstanceType string
    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].
    payType string
    Valid values are PrePaid, PostPaid, System default to PostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+.
    securityGroups string[]
    The security group resource of the cluster.
    slbConnAddrs InstanceSlbConnAddr[]

    The slb service addresses of the cluster. See slb_conn_addrs below.

    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.

    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    uiProxyConnAddrs InstanceUiProxyConnAddr[]
    The Web UI proxy addresses of the cluster. See ui_proxy_conn_addrs below.
    vpcId string
    The id of the VPC.
    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. Intl site not support classic network.
    zkConnAddrs InstanceZkConnAddr[]
    The zookeeper addresses of the cluster. See zk_conn_addrs below.
    zoneId string
    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 bool
    Valid values are true, false, system default to false, valid when pay_type = PrePaid.
    cold_storage_size int
    0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
    core_disk_size int
    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 str
    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_quantity int
    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_type str
    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 str
    Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0: hbaseue and bds. Single hbase instance need to set engine=hbase, core_instance_quantity=1.
    engine_version str
    HBase major version. hbase:1.1/2.0, hbaseue:2.0, bds:1.0, unsupport other engine temporarily. Value options can refer to the latest docs CreateInstance.
    immediate_delete_flag bool
    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_time str
    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_time str
    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_quantity int
    Count nodes of the master node.
    master_instance_type str
    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 to PostPaid. 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_addrs Sequence[InstanceSlbConnAddrArgs]

    The slb service addresses of the cluster. See slb_conn_addrs below.

    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.

    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    ui_proxy_conn_addrs Sequence[InstanceUiProxyConnAddrArgs]
    The Web UI proxy addresses of the cluster. See ui_proxy_conn_addrs below.
    vpc_id str
    The id of the VPC.
    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. Intl site not support classic network.
    zk_conn_addrs Sequence[InstanceZkConnAddrArgs]
    The zookeeper addresses of the cluster. See zk_conn_addrs below.
    zone_id str
    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].
    autoRenew Boolean
    Valid values are true, false, system default to false, valid when pay_type = PrePaid.
    coldStorageSize Number
    0 or [800, 100000000], step:10-GB increments. 0 means is_cold_storage = false. [800, 100000000] means is_cold_storage = true.
    coreDiskSize Number
    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.
    coreDiskType String
    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).
    coreInstanceQuantity Number
    Default=2, [1-200]. If core_instance_quantity > 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.
    coreInstanceType String
    Instance specification. See Instance specifications, or you can call describeInstanceType api.
    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, valid when pay_type = PrePaid, unit: month. 12, 24, 36 mean 1, 2, 3 years.
    engine String
    Valid values are "hbase/hbaseue/bds". The following types are supported after v1.73.0: hbaseue and bds. Single hbase instance need to set engine=hbase, core_instance_quantity=1.
    engineVersion String
    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.
    immediateDeleteFlag Boolean
    The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.
    ipWhite String
    The white ip list of the cluster.
    maintainEndTime String
    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.
    maintainStartTime String
    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.
    masterInstanceQuantity Number
    Count nodes of the master node.
    masterInstanceType String
    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].
    payType String
    Valid values are PrePaid, PostPaid, System default to PostPaid. You can also convert PostPaid to PrePaid. And support convert PrePaid to PostPaid from 1.115.0+.
    securityGroups List<String>
    The security group resource of the cluster.
    slbConnAddrs List<Property Map>

    The slb service addresses of the cluster. See slb_conn_addrs below.

    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.

    tags Map<String>
    A mapping of tags to assign to the resource.
    uiProxyConnAddrs List<Property Map>
    The Web UI proxy addresses of the cluster. See ui_proxy_conn_addrs below.
    vpcId String
    The id of the VPC.
    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. Intl site not support classic network.
    zkConnAddrs List<Property Map>
    The zookeeper addresses of the cluster. See zk_conn_addrs below.
    zoneId String
    The Zone to launch the HBase instance. If vswitch_id is not empty, this zone_id can be "" or consistent.

    Supporting Types

    InstanceSlbConnAddr, InstanceSlbConnAddrArgs

    ConnAddr string
    The Phoenix address.
    ConnAddrPort string
    The number of the port over which Phoenix connects to the instance.
    NetType string
    The type of the network. Valid values:
    ConnAddr string
    The Phoenix address.
    ConnAddrPort string
    The number of the port over which Phoenix connects to the instance.
    NetType string
    The type of the network. Valid values:
    connAddr String
    The Phoenix address.
    connAddrPort String
    The number of the port over which Phoenix connects to the instance.
    netType String
    The type of the network. Valid values:
    connAddr string
    The Phoenix address.
    connAddrPort string
    The number of the port over which Phoenix connects to the instance.
    netType string
    The type of the network. Valid values:
    conn_addr str
    The Phoenix address.
    conn_addr_port str
    The number of the port over which Phoenix connects to the instance.
    net_type str
    The type of the network. Valid values:
    connAddr String
    The Phoenix address.
    connAddrPort String
    The number of the port over which Phoenix connects to the instance.
    netType String
    The type of the network. Valid values:

    InstanceUiProxyConnAddr, InstanceUiProxyConnAddrArgs

    ConnAddr string
    The Phoenix address.
    ConnAddrPort string
    The number of the port over which Phoenix connects to the instance.
    NetType string
    The type of the network. Valid values:
    ConnAddr string
    The Phoenix address.
    ConnAddrPort string
    The number of the port over which Phoenix connects to the instance.
    NetType string
    The type of the network. Valid values:
    connAddr String
    The Phoenix address.
    connAddrPort String
    The number of the port over which Phoenix connects to the instance.
    netType String
    The type of the network. Valid values:
    connAddr string
    The Phoenix address.
    connAddrPort string
    The number of the port over which Phoenix connects to the instance.
    netType string
    The type of the network. Valid values:
    conn_addr str
    The Phoenix address.
    conn_addr_port str
    The number of the port over which Phoenix connects to the instance.
    net_type str
    The type of the network. Valid values:
    connAddr String
    The Phoenix address.
    connAddrPort String
    The number of the port over which Phoenix connects to the instance.
    netType String
    The type of the network. Valid values:

    InstanceZkConnAddr, InstanceZkConnAddrArgs

    ConnAddr string
    The Phoenix address.
    ConnAddrPort string
    The number of the port over which Phoenix connects to the instance.
    NetType string
    The type of the network. Valid values:
    ConnAddr string
    The Phoenix address.
    ConnAddrPort string
    The number of the port over which Phoenix connects to the instance.
    NetType string
    The type of the network. Valid values:
    connAddr String
    The Phoenix address.
    connAddrPort String
    The number of the port over which Phoenix connects to the instance.
    netType String
    The type of the network. Valid values:
    connAddr string
    The Phoenix address.
    connAddrPort string
    The number of the port over which Phoenix connects to the instance.
    netType string
    The type of the network. Valid values:
    conn_addr str
    The Phoenix address.
    conn_addr_port str
    The number of the port over which Phoenix connects to the instance.
    net_type str
    The type of the network. Valid values:
    connAddr String
    The Phoenix address.
    connAddrPort String
    The number of the port over which Phoenix connects to the instance.
    netType 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 alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-alicloud