1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. hbase
  6. Instance
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.hbase.Instance

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Table Database HBase Edition is a fully managed NoSQL service based on Apache HBase, compatible with the standard HBase access protocol, offering advantages such as low-cost storage and high scalability throughput.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const hBaseInstanceDemo = new volcenginecc.hbase.Instance("HBaseInstanceDemo", {
    regionId: "cn-beijing",
    multiAz: false,
    zoneId: "cn-beijing-a",
    instanceName: "HBaseInstanceDemo",
    engineVersion: "HBase_2.0",
    instanceType: "Standard",
    masterSpec: "hbase.x1.medium",
    rsCount: 2,
    rsSpec: "hbase.x1.large",
    storageCapacity: 20000,
    vpcId: "vpc-rrco37ovjq4gv0x5xxxxx",
    projectName: "default",
    chargeType: "PrePaid",
    purchaseMonths: 1,
    autoRenew: false,
    subnetId: "subnet-rrwqhg3qzxfkv0x57xxxxx",
    deletionProtection: "disabled",
    enableCloudStorage: false,
    tags: [{
        key: "env",
        value: "test",
    }],
    storageType: "HdfsSsd",
    enableAuth: true,
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

h_base_instance_demo = volcenginecc.hbase.Instance("HBaseInstanceDemo",
    region_id="cn-beijing",
    multi_az=False,
    zone_id="cn-beijing-a",
    instance_name="HBaseInstanceDemo",
    engine_version="HBase_2.0",
    instance_type="Standard",
    master_spec="hbase.x1.medium",
    rs_count=2,
    rs_spec="hbase.x1.large",
    storage_capacity=20000,
    vpc_id="vpc-rrco37ovjq4gv0x5xxxxx",
    project_name="default",
    charge_type="PrePaid",
    purchase_months=1,
    auto_renew=False,
    subnet_id="subnet-rrwqhg3qzxfkv0x57xxxxx",
    deletion_protection="disabled",
    enable_cloud_storage=False,
    tags=[{
        "key": "env",
        "value": "test",
    }],
    storage_type="HdfsSsd",
    enable_auth=True)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/hbase"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hbase.NewInstance(ctx, "HBaseInstanceDemo", &hbase.InstanceArgs{
			RegionId:           pulumi.String("cn-beijing"),
			MultiAz:            pulumi.Bool(false),
			ZoneId:             pulumi.String("cn-beijing-a"),
			InstanceName:       pulumi.String("HBaseInstanceDemo"),
			EngineVersion:      pulumi.String("HBase_2.0"),
			InstanceType:       pulumi.String("Standard"),
			MasterSpec:         pulumi.String("hbase.x1.medium"),
			RsCount:            pulumi.Int(2),
			RsSpec:             pulumi.String("hbase.x1.large"),
			StorageCapacity:    pulumi.Int(20000),
			VpcId:              pulumi.String("vpc-rrco37ovjq4gv0x5xxxxx"),
			ProjectName:        pulumi.String("default"),
			ChargeType:         pulumi.String("PrePaid"),
			PurchaseMonths:     pulumi.Int(1),
			AutoRenew:          pulumi.Bool(false),
			SubnetId:           pulumi.String("subnet-rrwqhg3qzxfkv0x57xxxxx"),
			DeletionProtection: pulumi.String("disabled"),
			EnableCloudStorage: pulumi.Bool(false),
			Tags: hbase.InstanceTagArray{
				&hbase.InstanceTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
			StorageType: pulumi.String("HdfsSsd"),
			EnableAuth:  pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var hBaseInstanceDemo = new Volcenginecc.Hbase.Instance("HBaseInstanceDemo", new()
    {
        RegionId = "cn-beijing",
        MultiAz = false,
        ZoneId = "cn-beijing-a",
        InstanceName = "HBaseInstanceDemo",
        EngineVersion = "HBase_2.0",
        InstanceType = "Standard",
        MasterSpec = "hbase.x1.medium",
        RsCount = 2,
        RsSpec = "hbase.x1.large",
        StorageCapacity = 20000,
        VpcId = "vpc-rrco37ovjq4gv0x5xxxxx",
        ProjectName = "default",
        ChargeType = "PrePaid",
        PurchaseMonths = 1,
        AutoRenew = false,
        SubnetId = "subnet-rrwqhg3qzxfkv0x57xxxxx",
        DeletionProtection = "disabled",
        EnableCloudStorage = false,
        Tags = new[]
        {
            new Volcenginecc.Hbase.Inputs.InstanceTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
        StorageType = "HdfsSsd",
        EnableAuth = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.hbase.Instance;
import com.volcengine.volcenginecc.hbase.InstanceArgs;
import com.pulumi.volcenginecc.hbase.inputs.InstanceTagArgs;
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) {
        var hBaseInstanceDemo = new Instance("hBaseInstanceDemo", InstanceArgs.builder()
            .regionId("cn-beijing")
            .multiAz(false)
            .zoneId("cn-beijing-a")
            .instanceName("HBaseInstanceDemo")
            .engineVersion("HBase_2.0")
            .instanceType("Standard")
            .masterSpec("hbase.x1.medium")
            .rsCount(2)
            .rsSpec("hbase.x1.large")
            .storageCapacity(20000)
            .vpcId("vpc-rrco37ovjq4gv0x5xxxxx")
            .projectName("default")
            .chargeType("PrePaid")
            .purchaseMonths(1)
            .autoRenew(false)
            .subnetId("subnet-rrwqhg3qzxfkv0x57xxxxx")
            .deletionProtection("disabled")
            .enableCloudStorage(false)
            .tags(InstanceTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .storageType("HdfsSsd")
            .enableAuth(true)
            .build());

    }
}

    resources:
  hBaseInstanceDemo:
    type: volcenginecc:hbase:Instance
    name: HBaseInstanceDemo
    properties:
      regionId: cn-beijing
      multiAz: false
      zoneId: cn-beijing-a
      instanceName: HBaseInstanceDemo
      engineVersion: HBase_2.0
      instanceType: Standard
      masterSpec: hbase.x1.medium
      rsCount: 2
      rsSpec: hbase.x1.large
      storageCapacity: 20000
      vpcId: vpc-rrco37ovjq4gv0x5xxxxx
      projectName: default
      chargeType: PrePaid
      purchaseMonths: 1
      autoRenew: false
      subnetId: subnet-rrwqhg3qzxfkv0x57xxxxx
      deletionProtection: disabled
      enableCloudStorage: false
      tags:
        - key: env
          value: test
      storageType: HdfsSsd
      enableAuth: true

    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,
             rs_count: Optional[int] = None,
             engine_version: Optional[str] = None,
             zone_id: Optional[str] = None,
             vpc_id: Optional[str] = None,
             subnet_id: Optional[str] = None,
             storage_type: Optional[str] = None,
             master_spec: Optional[str] = None,
             storage_capacity: Optional[int] = None,
             rs_spec: Optional[str] = None,
             region_id: Optional[str] = None,
             charge_type: Optional[str] = None,
             endpoints: Optional[Sequence[InstanceEndpointArgs]] = None,
             instance_name: Optional[str] = None,
             purchase_months: Optional[int] = None,
             instance_type: Optional[str] = None,
             auto_renew: Optional[bool] = None,
             multi_az: Optional[bool] = None,
             project_name: Optional[str] = None,
             enable_cloud_storage: Optional[bool] = None,
             enable_auth: Optional[bool] = None,
             tags: Optional[Sequence[InstanceTagArgs]] = None,
             deletion_protection: Optional[str] = None,
             cold_storage: Optional[int] = 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: volcenginecc: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.

    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:

    ChargeType string
    Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).
    EngineVersion string
    HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0
    MasterSpec string
    Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.
    RegionId string
    Region ID of the instance.
    RsCount int
    Number of RegionServer nodes
    RsSpec string
    RegionServer node specification code.
    StorageCapacity int
    Total storage capacity of the instance, unit: GiB.
    StorageType string
    Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.
    SubnetId string
    Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included
    VpcId string
    Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.
    ZoneId string
    Zone ID of the instance
    AutoRenew bool
    Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.
    ColdStorage int
    Total capacity-type storage space for the instance, in GiB.
    DeletionProtection string
    Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.
    EnableAuth bool
    Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.
    EnableCloudStorage bool
    Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).
    Endpoints List<Volcengine.InstanceEndpoint>
    InstanceName string
    Instance name
    InstanceType string
    Instance type. Currently, only Standard is supported. The default value is Standard
    MultiAz bool
    Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.
    ProjectName string
    Project name of the instance
    PurchaseMonths int
    Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required
    Tags List<Volcengine.InstanceTag>
    ChargeType string
    Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).
    EngineVersion string
    HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0
    MasterSpec string
    Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.
    RegionId string
    Region ID of the instance.
    RsCount int
    Number of RegionServer nodes
    RsSpec string
    RegionServer node specification code.
    StorageCapacity int
    Total storage capacity of the instance, unit: GiB.
    StorageType string
    Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.
    SubnetId string
    Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included
    VpcId string
    Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.
    ZoneId string
    Zone ID of the instance
    AutoRenew bool
    Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.
    ColdStorage int
    Total capacity-type storage space for the instance, in GiB.
    DeletionProtection string
    Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.
    EnableAuth bool
    Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.
    EnableCloudStorage bool
    Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).
    Endpoints []InstanceEndpointArgs
    InstanceName string
    Instance name
    InstanceType string
    Instance type. Currently, only Standard is supported. The default value is Standard
    MultiAz bool
    Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.
    ProjectName string
    Project name of the instance
    PurchaseMonths int
    Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required
    Tags []InstanceTagArgs
    chargeType String
    Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).
    engineVersion String
    HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0
    masterSpec String
    Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.
    regionId String
    Region ID of the instance.
    rsCount Integer
    Number of RegionServer nodes
    rsSpec String
    RegionServer node specification code.
    storageCapacity Integer
    Total storage capacity of the instance, unit: GiB.
    storageType String
    Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.
    subnetId String
    Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included
    vpcId String
    Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.
    zoneId String
    Zone ID of the instance
    autoRenew Boolean
    Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.
    coldStorage Integer
    Total capacity-type storage space for the instance, in GiB.
    deletionProtection String
    Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.
    enableAuth Boolean
    Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.
    enableCloudStorage Boolean
    Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).
    endpoints List<InstanceEndpoint>
    instanceName String
    Instance name
    instanceType String
    Instance type. Currently, only Standard is supported. The default value is Standard
    multiAz Boolean
    Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.
    projectName String
    Project name of the instance
    purchaseMonths Integer
    Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required
    tags List<InstanceTag>
    chargeType string
    Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).
    engineVersion string
    HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0
    masterSpec string
    Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.
    regionId string
    Region ID of the instance.
    rsCount number
    Number of RegionServer nodes
    rsSpec string
    RegionServer node specification code.
    storageCapacity number
    Total storage capacity of the instance, unit: GiB.
    storageType string
    Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.
    subnetId string
    Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included
    vpcId string
    Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.
    zoneId string
    Zone ID of the instance
    autoRenew boolean
    Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.
    coldStorage number
    Total capacity-type storage space for the instance, in GiB.
    deletionProtection string
    Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.
    enableAuth boolean
    Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.
    enableCloudStorage boolean
    Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).
    endpoints InstanceEndpoint[]
    instanceName string
    Instance name
    instanceType string
    Instance type. Currently, only Standard is supported. The default value is Standard
    multiAz boolean
    Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.
    projectName string
    Project name of the instance
    purchaseMonths number
    Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required
    tags InstanceTag[]
    charge_type str
    Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).
    engine_version str
    HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0
    master_spec str
    Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.
    region_id str
    Region ID of the instance.
    rs_count int
    Number of RegionServer nodes
    rs_spec str
    RegionServer node specification code.
    storage_capacity int
    Total storage capacity of the instance, unit: GiB.
    storage_type str
    Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.
    subnet_id str
    Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included
    vpc_id str
    Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.
    zone_id str
    Zone ID of the instance
    auto_renew bool
    Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.
    cold_storage int
    Total capacity-type storage space for the instance, in GiB.
    deletion_protection str
    Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.
    enable_auth bool
    Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.
    enable_cloud_storage bool
    Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).
    endpoints Sequence[InstanceEndpointArgs]
    instance_name str
    Instance name
    instance_type str
    Instance type. Currently, only Standard is supported. The default value is Standard
    multi_az bool
    Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.
    project_name str
    Project name of the instance
    purchase_months int
    Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required
    tags Sequence[InstanceTagArgs]
    chargeType String
    Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).
    engineVersion String
    HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0
    masterSpec String
    Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.
    regionId String
    Region ID of the instance.
    rsCount Number
    Number of RegionServer nodes
    rsSpec String
    RegionServer node specification code.
    storageCapacity Number
    Total storage capacity of the instance, unit: GiB.
    storageType String
    Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.
    subnetId String
    Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included
    vpcId String
    Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.
    zoneId String
    Zone ID of the instance
    autoRenew Boolean
    Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.
    coldStorage Number
    Total capacity-type storage space for the instance, in GiB.
    deletionProtection String
    Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.
    enableAuth Boolean
    Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.
    enableCloudStorage Boolean
    Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).
    endpoints List<Property Map>
    instanceName String
    Instance name
    instanceType String
    Instance type. Currently, only Standard is supported. The default value is Standard
    multiAz Boolean
    Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.
    projectName String
    Project name of the instance
    purchaseMonths Number
    Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required
    tags List<Property Map>

    Outputs

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

    ChargeStatus string
    Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.
    CreateTime string
    Instance creation time (UTC).
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID
    MasterCount int
    Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default
    PrimarySubnetId string
    Real-time primary availability zone subnet ID.
    PrimaryZoneId string
    Real-time primary zone ID
    StandbySubnetId string
    Real-time standby availability zone subnet ID.
    StandbyZoneId string
    Real-time standby zone ID
    Status string
    Current status of the instance. For more details about instance status, see Instance Status Description
    UsedColdStorage int
    Capacity-type storage space used by the instance, in MiB
    UsedStorage double
    Storage capacity used by the primary instance, in MiB
    VpcName string
    Name of the private network to which the instance belongs.
    ZoneName string
    Name of the availability zone to which the instance belongs.
    ChargeStatus string
    Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.
    CreateTime string
    Instance creation time (UTC).
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID
    MasterCount int
    Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default
    PrimarySubnetId string
    Real-time primary availability zone subnet ID.
    PrimaryZoneId string
    Real-time primary zone ID
    StandbySubnetId string
    Real-time standby availability zone subnet ID.
    StandbyZoneId string
    Real-time standby zone ID
    Status string
    Current status of the instance. For more details about instance status, see Instance Status Description
    UsedColdStorage int
    Capacity-type storage space used by the instance, in MiB
    UsedStorage float64
    Storage capacity used by the primary instance, in MiB
    VpcName string
    Name of the private network to which the instance belongs.
    ZoneName string
    Name of the availability zone to which the instance belongs.
    chargeStatus String
    Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.
    createTime String
    Instance creation time (UTC).
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID
    masterCount Integer
    Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default
    primarySubnetId String
    Real-time primary availability zone subnet ID.
    primaryZoneId String
    Real-time primary zone ID
    standbySubnetId String
    Real-time standby availability zone subnet ID.
    standbyZoneId String
    Real-time standby zone ID
    status String
    Current status of the instance. For more details about instance status, see Instance Status Description
    usedColdStorage Integer
    Capacity-type storage space used by the instance, in MiB
    usedStorage Double
    Storage capacity used by the primary instance, in MiB
    vpcName String
    Name of the private network to which the instance belongs.
    zoneName String
    Name of the availability zone to which the instance belongs.
    chargeStatus string
    Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.
    createTime string
    Instance creation time (UTC).
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    Instance ID
    masterCount number
    Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default
    primarySubnetId string
    Real-time primary availability zone subnet ID.
    primaryZoneId string
    Real-time primary zone ID
    standbySubnetId string
    Real-time standby availability zone subnet ID.
    standbyZoneId string
    Real-time standby zone ID
    status string
    Current status of the instance. For more details about instance status, see Instance Status Description
    usedColdStorage number
    Capacity-type storage space used by the instance, in MiB
    usedStorage number
    Storage capacity used by the primary instance, in MiB
    vpcName string
    Name of the private network to which the instance belongs.
    zoneName string
    Name of the availability zone to which the instance belongs.
    charge_status str
    Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.
    create_time str
    Instance creation time (UTC).
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    Instance ID
    master_count int
    Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default
    primary_subnet_id str
    Real-time primary availability zone subnet ID.
    primary_zone_id str
    Real-time primary zone ID
    standby_subnet_id str
    Real-time standby availability zone subnet ID.
    standby_zone_id str
    Real-time standby zone ID
    status str
    Current status of the instance. For more details about instance status, see Instance Status Description
    used_cold_storage int
    Capacity-type storage space used by the instance, in MiB
    used_storage float
    Storage capacity used by the primary instance, in MiB
    vpc_name str
    Name of the private network to which the instance belongs.
    zone_name str
    Name of the availability zone to which the instance belongs.
    chargeStatus String
    Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.
    createTime String
    Instance creation time (UTC).
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID
    masterCount Number
    Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default
    primarySubnetId String
    Real-time primary availability zone subnet ID.
    primaryZoneId String
    Real-time primary zone ID
    standbySubnetId String
    Real-time standby availability zone subnet ID.
    standbyZoneId String
    Real-time standby zone ID
    status String
    Current status of the instance. For more details about instance status, see Instance Status Description
    usedColdStorage Number
    Capacity-type storage space used by the instance, in MiB
    usedStorage Number
    Storage capacity used by the primary instance, in MiB
    vpcName String
    Name of the private network to which the instance belongs.
    zoneName String
    Name of the availability zone to which the instance belongs.

    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,
        auto_renew: Optional[bool] = None,
        charge_status: Optional[str] = None,
        charge_type: Optional[str] = None,
        cold_storage: Optional[int] = None,
        create_time: Optional[str] = None,
        deletion_protection: Optional[str] = None,
        enable_auth: Optional[bool] = None,
        enable_cloud_storage: Optional[bool] = None,
        endpoints: Optional[Sequence[InstanceEndpointArgs]] = None,
        engine_version: Optional[str] = None,
        instance_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_type: Optional[str] = None,
        master_count: Optional[int] = None,
        master_spec: Optional[str] = None,
        multi_az: Optional[bool] = None,
        primary_subnet_id: Optional[str] = None,
        primary_zone_id: Optional[str] = None,
        project_name: Optional[str] = None,
        purchase_months: Optional[int] = None,
        region_id: Optional[str] = None,
        rs_count: Optional[int] = None,
        rs_spec: Optional[str] = None,
        standby_subnet_id: Optional[str] = None,
        standby_zone_id: Optional[str] = None,
        status: Optional[str] = None,
        storage_capacity: Optional[int] = None,
        storage_type: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Sequence[InstanceTagArgs]] = None,
        used_cold_storage: Optional[int] = None,
        used_storage: Optional[float] = None,
        vpc_id: Optional[str] = None,
        vpc_name: Optional[str] = None,
        zone_id: Optional[str] = None,
        zone_name: 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)
    resources:  _:    type: volcenginecc:hbase:Instance    get:      id: ${id}
    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:
    AutoRenew bool
    Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.
    ChargeStatus string
    Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.
    ChargeType string
    Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).
    ColdStorage int
    Total capacity-type storage space for the instance, in GiB.
    CreateTime string
    Instance creation time (UTC).
    DeletionProtection string
    Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.
    EnableAuth bool
    Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.
    EnableCloudStorage bool
    Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).
    Endpoints List<Volcengine.InstanceEndpoint>
    EngineVersion string
    HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0
    InstanceId string
    Instance ID
    InstanceName string
    Instance name
    InstanceType string
    Instance type. Currently, only Standard is supported. The default value is Standard
    MasterCount int
    Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default
    MasterSpec string
    Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.
    MultiAz bool
    Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.
    PrimarySubnetId string
    Real-time primary availability zone subnet ID.
    PrimaryZoneId string
    Real-time primary zone ID
    ProjectName string
    Project name of the instance
    PurchaseMonths int
    Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required
    RegionId string
    Region ID of the instance.
    RsCount int
    Number of RegionServer nodes
    RsSpec string
    RegionServer node specification code.
    StandbySubnetId string
    Real-time standby availability zone subnet ID.
    StandbyZoneId string
    Real-time standby zone ID
    Status string
    Current status of the instance. For more details about instance status, see Instance Status Description
    StorageCapacity int
    Total storage capacity of the instance, unit: GiB.
    StorageType string
    Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.
    SubnetId string
    Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included
    Tags List<Volcengine.InstanceTag>
    UsedColdStorage int
    Capacity-type storage space used by the instance, in MiB
    UsedStorage double
    Storage capacity used by the primary instance, in MiB
    VpcId string
    Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.
    VpcName string
    Name of the private network to which the instance belongs.
    ZoneId string
    Zone ID of the instance
    ZoneName string
    Name of the availability zone to which the instance belongs.
    AutoRenew bool
    Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.
    ChargeStatus string
    Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.
    ChargeType string
    Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).
    ColdStorage int
    Total capacity-type storage space for the instance, in GiB.
    CreateTime string
    Instance creation time (UTC).
    DeletionProtection string
    Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.
    EnableAuth bool
    Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.
    EnableCloudStorage bool
    Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).
    Endpoints []InstanceEndpointArgs
    EngineVersion string
    HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0
    InstanceId string
    Instance ID
    InstanceName string
    Instance name
    InstanceType string
    Instance type. Currently, only Standard is supported. The default value is Standard
    MasterCount int
    Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default
    MasterSpec string
    Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.
    MultiAz bool
    Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.
    PrimarySubnetId string
    Real-time primary availability zone subnet ID.
    PrimaryZoneId string
    Real-time primary zone ID
    ProjectName string
    Project name of the instance
    PurchaseMonths int
    Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required
    RegionId string
    Region ID of the instance.
    RsCount int
    Number of RegionServer nodes
    RsSpec string
    RegionServer node specification code.
    StandbySubnetId string
    Real-time standby availability zone subnet ID.
    StandbyZoneId string
    Real-time standby zone ID
    Status string
    Current status of the instance. For more details about instance status, see Instance Status Description
    StorageCapacity int
    Total storage capacity of the instance, unit: GiB.
    StorageType string
    Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.
    SubnetId string
    Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included
    Tags []InstanceTagArgs
    UsedColdStorage int
    Capacity-type storage space used by the instance, in MiB
    UsedStorage float64
    Storage capacity used by the primary instance, in MiB
    VpcId string
    Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.
    VpcName string
    Name of the private network to which the instance belongs.
    ZoneId string
    Zone ID of the instance
    ZoneName string
    Name of the availability zone to which the instance belongs.
    autoRenew Boolean
    Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.
    chargeStatus String
    Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.
    chargeType String
    Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).
    coldStorage Integer
    Total capacity-type storage space for the instance, in GiB.
    createTime String
    Instance creation time (UTC).
    deletionProtection String
    Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.
    enableAuth Boolean
    Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.
    enableCloudStorage Boolean
    Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).
    endpoints List<InstanceEndpoint>
    engineVersion String
    HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0
    instanceId String
    Instance ID
    instanceName String
    Instance name
    instanceType String
    Instance type. Currently, only Standard is supported. The default value is Standard
    masterCount Integer
    Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default
    masterSpec String
    Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.
    multiAz Boolean
    Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.
    primarySubnetId String
    Real-time primary availability zone subnet ID.
    primaryZoneId String
    Real-time primary zone ID
    projectName String
    Project name of the instance
    purchaseMonths Integer
    Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required
    regionId String
    Region ID of the instance.
    rsCount Integer
    Number of RegionServer nodes
    rsSpec String
    RegionServer node specification code.
    standbySubnetId String
    Real-time standby availability zone subnet ID.
    standbyZoneId String
    Real-time standby zone ID
    status String
    Current status of the instance. For more details about instance status, see Instance Status Description
    storageCapacity Integer
    Total storage capacity of the instance, unit: GiB.
    storageType String
    Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.
    subnetId String
    Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included
    tags List<InstanceTag>
    usedColdStorage Integer
    Capacity-type storage space used by the instance, in MiB
    usedStorage Double
    Storage capacity used by the primary instance, in MiB
    vpcId String
    Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.
    vpcName String
    Name of the private network to which the instance belongs.
    zoneId String
    Zone ID of the instance
    zoneName String
    Name of the availability zone to which the instance belongs.
    autoRenew boolean
    Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.
    chargeStatus string
    Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.
    chargeType string
    Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).
    coldStorage number
    Total capacity-type storage space for the instance, in GiB.
    createTime string
    Instance creation time (UTC).
    deletionProtection string
    Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.
    enableAuth boolean
    Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.
    enableCloudStorage boolean
    Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).
    endpoints InstanceEndpoint[]
    engineVersion string
    HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0
    instanceId string
    Instance ID
    instanceName string
    Instance name
    instanceType string
    Instance type. Currently, only Standard is supported. The default value is Standard
    masterCount number
    Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default
    masterSpec string
    Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.
    multiAz boolean
    Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.
    primarySubnetId string
    Real-time primary availability zone subnet ID.
    primaryZoneId string
    Real-time primary zone ID
    projectName string
    Project name of the instance
    purchaseMonths number
    Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required
    regionId string
    Region ID of the instance.
    rsCount number
    Number of RegionServer nodes
    rsSpec string
    RegionServer node specification code.
    standbySubnetId string
    Real-time standby availability zone subnet ID.
    standbyZoneId string
    Real-time standby zone ID
    status string
    Current status of the instance. For more details about instance status, see Instance Status Description
    storageCapacity number
    Total storage capacity of the instance, unit: GiB.
    storageType string
    Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.
    subnetId string
    Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included
    tags InstanceTag[]
    usedColdStorage number
    Capacity-type storage space used by the instance, in MiB
    usedStorage number
    Storage capacity used by the primary instance, in MiB
    vpcId string
    Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.
    vpcName string
    Name of the private network to which the instance belongs.
    zoneId string
    Zone ID of the instance
    zoneName string
    Name of the availability zone to which the instance belongs.
    auto_renew bool
    Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.
    charge_status str
    Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.
    charge_type str
    Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).
    cold_storage int
    Total capacity-type storage space for the instance, in GiB.
    create_time str
    Instance creation time (UTC).
    deletion_protection str
    Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.
    enable_auth bool
    Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.
    enable_cloud_storage bool
    Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).
    endpoints Sequence[InstanceEndpointArgs]
    engine_version str
    HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0
    instance_id str
    Instance ID
    instance_name str
    Instance name
    instance_type str
    Instance type. Currently, only Standard is supported. The default value is Standard
    master_count int
    Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default
    master_spec str
    Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.
    multi_az bool
    Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.
    primary_subnet_id str
    Real-time primary availability zone subnet ID.
    primary_zone_id str
    Real-time primary zone ID
    project_name str
    Project name of the instance
    purchase_months int
    Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required
    region_id str
    Region ID of the instance.
    rs_count int
    Number of RegionServer nodes
    rs_spec str
    RegionServer node specification code.
    standby_subnet_id str
    Real-time standby availability zone subnet ID.
    standby_zone_id str
    Real-time standby zone ID
    status str
    Current status of the instance. For more details about instance status, see Instance Status Description
    storage_capacity int
    Total storage capacity of the instance, unit: GiB.
    storage_type str
    Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.
    subnet_id str
    Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included
    tags Sequence[InstanceTagArgs]
    used_cold_storage int
    Capacity-type storage space used by the instance, in MiB
    used_storage float
    Storage capacity used by the primary instance, in MiB
    vpc_id str
    Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.
    vpc_name str
    Name of the private network to which the instance belongs.
    zone_id str
    Zone ID of the instance
    zone_name str
    Name of the availability zone to which the instance belongs.
    autoRenew Boolean
    Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.
    chargeStatus String
    Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.
    chargeType String
    Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).
    coldStorage Number
    Total capacity-type storage space for the instance, in GiB.
    createTime String
    Instance creation time (UTC).
    deletionProtection String
    Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.
    enableAuth Boolean
    Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.
    enableCloudStorage Boolean
    Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).
    endpoints List<Property Map>
    engineVersion String
    HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0
    instanceId String
    Instance ID
    instanceName String
    Instance name
    instanceType String
    Instance type. Currently, only Standard is supported. The default value is Standard
    masterCount Number
    Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default
    masterSpec String
    Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.
    multiAz Boolean
    Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.
    primarySubnetId String
    Real-time primary availability zone subnet ID.
    primaryZoneId String
    Real-time primary zone ID
    projectName String
    Project name of the instance
    purchaseMonths Number
    Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required
    regionId String
    Region ID of the instance.
    rsCount Number
    Number of RegionServer nodes
    rsSpec String
    RegionServer node specification code.
    standbySubnetId String
    Real-time standby availability zone subnet ID.
    standbyZoneId String
    Real-time standby zone ID
    status String
    Current status of the instance. For more details about instance status, see Instance Status Description
    storageCapacity Number
    Total storage capacity of the instance, unit: GiB.
    storageType String
    Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.
    subnetId String
    Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included
    tags List<Property Map>
    usedColdStorage Number
    Capacity-type storage space used by the instance, in MiB
    usedStorage Number
    Storage capacity used by the primary instance, in MiB
    vpcId String
    Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.
    vpcName String
    Name of the private network to which the instance belongs.
    zoneId String
    Zone ID of the instance
    zoneName String
    Name of the availability zone to which the instance belongs.

    Supporting Types

    InstanceEndpoint, InstanceEndpointArgs

    AddressType string
    Connection address type. For more information about connection addresses, see Connection Address Types. The value range is as follows: Zk: ZK address. Thrift: Thrift2 address. HBaseReUsedEipId: When public access is enabled for the ZK or Thrift2 connection address, this parameter is returned, indicating the EIP ID information shared and used by other components in the instance (such as RS nodes, Master nodes, etc.)
    EipId string
    When the ZK connection address or Thrift2 connection address enables public access, this parameter is returned, indicating the EIP ID.
    EndpointId string
    Connection address ID. By default, only the ZK private network connection address is returned. If you apply for a Thrift2 connection address or enable public access for the ZK or Thrift2 connection address, the corresponding connection address ID will also be returned. When the connection address type is HBaseReUsedEipId, the connection address ID is fixed as HBaseReUsedEipId
    EndpointStr string
    Connection string for the connection address. By default, only the ZK private network connection address is returned. If you have requested a Thrift2 connection address, or enabled public access for ZK or Thrift2 connection addresses, the corresponding connection string will also be provided. When the connection address type is HBaseReUsedEipId, the connection string is always set to HBaseReUsedEipId.
    NetworkType string
    Connection address network type. Value range: Public: public access address. Private: private access address.
    PrivateDnsVisibility bool
    Whether public DNS resolution is enabled for the private network domain name.
    AddressType string
    Connection address type. For more information about connection addresses, see Connection Address Types. The value range is as follows: Zk: ZK address. Thrift: Thrift2 address. HBaseReUsedEipId: When public access is enabled for the ZK or Thrift2 connection address, this parameter is returned, indicating the EIP ID information shared and used by other components in the instance (such as RS nodes, Master nodes, etc.)
    EipId string
    When the ZK connection address or Thrift2 connection address enables public access, this parameter is returned, indicating the EIP ID.
    EndpointId string
    Connection address ID. By default, only the ZK private network connection address is returned. If you apply for a Thrift2 connection address or enable public access for the ZK or Thrift2 connection address, the corresponding connection address ID will also be returned. When the connection address type is HBaseReUsedEipId, the connection address ID is fixed as HBaseReUsedEipId
    EndpointStr string
    Connection string for the connection address. By default, only the ZK private network connection address is returned. If you have requested a Thrift2 connection address, or enabled public access for ZK or Thrift2 connection addresses, the corresponding connection string will also be provided. When the connection address type is HBaseReUsedEipId, the connection string is always set to HBaseReUsedEipId.
    NetworkType string
    Connection address network type. Value range: Public: public access address. Private: private access address.
    PrivateDnsVisibility bool
    Whether public DNS resolution is enabled for the private network domain name.
    addressType String
    Connection address type. For more information about connection addresses, see Connection Address Types. The value range is as follows: Zk: ZK address. Thrift: Thrift2 address. HBaseReUsedEipId: When public access is enabled for the ZK or Thrift2 connection address, this parameter is returned, indicating the EIP ID information shared and used by other components in the instance (such as RS nodes, Master nodes, etc.)
    eipId String
    When the ZK connection address or Thrift2 connection address enables public access, this parameter is returned, indicating the EIP ID.
    endpointId String
    Connection address ID. By default, only the ZK private network connection address is returned. If you apply for a Thrift2 connection address or enable public access for the ZK or Thrift2 connection address, the corresponding connection address ID will also be returned. When the connection address type is HBaseReUsedEipId, the connection address ID is fixed as HBaseReUsedEipId
    endpointStr String
    Connection string for the connection address. By default, only the ZK private network connection address is returned. If you have requested a Thrift2 connection address, or enabled public access for ZK or Thrift2 connection addresses, the corresponding connection string will also be provided. When the connection address type is HBaseReUsedEipId, the connection string is always set to HBaseReUsedEipId.
    networkType String
    Connection address network type. Value range: Public: public access address. Private: private access address.
    privateDnsVisibility Boolean
    Whether public DNS resolution is enabled for the private network domain name.
    addressType string
    Connection address type. For more information about connection addresses, see Connection Address Types. The value range is as follows: Zk: ZK address. Thrift: Thrift2 address. HBaseReUsedEipId: When public access is enabled for the ZK or Thrift2 connection address, this parameter is returned, indicating the EIP ID information shared and used by other components in the instance (such as RS nodes, Master nodes, etc.)
    eipId string
    When the ZK connection address or Thrift2 connection address enables public access, this parameter is returned, indicating the EIP ID.
    endpointId string
    Connection address ID. By default, only the ZK private network connection address is returned. If you apply for a Thrift2 connection address or enable public access for the ZK or Thrift2 connection address, the corresponding connection address ID will also be returned. When the connection address type is HBaseReUsedEipId, the connection address ID is fixed as HBaseReUsedEipId
    endpointStr string
    Connection string for the connection address. By default, only the ZK private network connection address is returned. If you have requested a Thrift2 connection address, or enabled public access for ZK or Thrift2 connection addresses, the corresponding connection string will also be provided. When the connection address type is HBaseReUsedEipId, the connection string is always set to HBaseReUsedEipId.
    networkType string
    Connection address network type. Value range: Public: public access address. Private: private access address.
    privateDnsVisibility boolean
    Whether public DNS resolution is enabled for the private network domain name.
    address_type str
    Connection address type. For more information about connection addresses, see Connection Address Types. The value range is as follows: Zk: ZK address. Thrift: Thrift2 address. HBaseReUsedEipId: When public access is enabled for the ZK or Thrift2 connection address, this parameter is returned, indicating the EIP ID information shared and used by other components in the instance (such as RS nodes, Master nodes, etc.)
    eip_id str
    When the ZK connection address or Thrift2 connection address enables public access, this parameter is returned, indicating the EIP ID.
    endpoint_id str
    Connection address ID. By default, only the ZK private network connection address is returned. If you apply for a Thrift2 connection address or enable public access for the ZK or Thrift2 connection address, the corresponding connection address ID will also be returned. When the connection address type is HBaseReUsedEipId, the connection address ID is fixed as HBaseReUsedEipId
    endpoint_str str
    Connection string for the connection address. By default, only the ZK private network connection address is returned. If you have requested a Thrift2 connection address, or enabled public access for ZK or Thrift2 connection addresses, the corresponding connection string will also be provided. When the connection address type is HBaseReUsedEipId, the connection string is always set to HBaseReUsedEipId.
    network_type str
    Connection address network type. Value range: Public: public access address. Private: private access address.
    private_dns_visibility bool
    Whether public DNS resolution is enabled for the private network domain name.
    addressType String
    Connection address type. For more information about connection addresses, see Connection Address Types. The value range is as follows: Zk: ZK address. Thrift: Thrift2 address. HBaseReUsedEipId: When public access is enabled for the ZK or Thrift2 connection address, this parameter is returned, indicating the EIP ID information shared and used by other components in the instance (such as RS nodes, Master nodes, etc.)
    eipId String
    When the ZK connection address or Thrift2 connection address enables public access, this parameter is returned, indicating the EIP ID.
    endpointId String
    Connection address ID. By default, only the ZK private network connection address is returned. If you apply for a Thrift2 connection address or enable public access for the ZK or Thrift2 connection address, the corresponding connection address ID will also be returned. When the connection address type is HBaseReUsedEipId, the connection address ID is fixed as HBaseReUsedEipId
    endpointStr String
    Connection string for the connection address. By default, only the ZK private network connection address is returned. If you have requested a Thrift2 connection address, or enabled public access for ZK or Thrift2 connection addresses, the corresponding connection string will also be provided. When the connection address type is HBaseReUsedEipId, the connection string is always set to HBaseReUsedEipId.
    networkType String
    Connection address network type. Value range: Public: public access address. Private: private access address.
    privateDnsVisibility Boolean
    Whether public DNS resolution is enabled for the private network domain name.

    InstanceTag, InstanceTagArgs

    Key string
    Tag key of the tags bound to the instance
    Value string
    Tag values bound to the instance.
    Key string
    Tag key of the tags bound to the instance
    Value string
    Tag values bound to the instance.
    key String
    Tag key of the tags bound to the instance
    value String
    Tag values bound to the instance.
    key string
    Tag key of the tags bound to the instance
    value string
    Tag values bound to the instance.
    key str
    Tag key of the tags bound to the instance
    value str
    Tag values bound to the instance.
    key String
    Tag key of the tags bound to the instance
    value String
    Tag values bound to the instance.

    Import

    $ pulumi import volcenginecc:hbase/instance:Instance example "instance_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.