Show / Hide Table of Contents

Class Instance

Provides a HBase instance resource supports replica set instances only. the HBase provides stable, reliable, and automatic scalable database services. It offers a full range of database solutions, such as disaster recovery, backup, recovery, monitoring, and alarms. You can see detail product introduction here

NOTE: Available in 1.67.0+

NOTE: The following regions don't support create Classic network HBase instance. [cn-hangzhou,cn-shanghai,cn-qingdao,cn-beijing,cn-shenzhen,ap-southeast-1a,.....] the official website mark more regions. or you can call DescribeRegions

NOTE: Create HBase instance or change instance type and storage would cost 15 minutes. Please make full preparation

Example Usage

Create a hbase instance

using Pulumi;
using AliCloud = Pulumi.AliCloud;

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

}
Inheritance
System.Object
Resource
CustomResource
Instance
Inherited Members
CustomResource.Id
Resource.GetResourceType()
Resource.GetResourceName()
Resource.Urn
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.AliCloud.Hbase
Assembly: Pulumi.AliCloud.dll
Syntax
public class Instance : CustomResource

Constructors

View Source

Instance(String, InstanceArgs, CustomResourceOptions)

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

Declaration
public Instance(string name, InstanceArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource

InstanceArgs args

The arguments used to populate this resource's properties

CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AutoRenew

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

Declaration
public Output<bool> AutoRenew { get; }
Property Value
Type Description
Output<System.Boolean>
View Source

ColdStorageSize

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

Declaration
public Output<int> ColdStorageSize { get; }
Property Value
Type Description
Output<System.Int32>
View Source

CoreDiskSize

User-defined HBase instance one core node's storage space.Unit: GB. Value range:

  • Custom storage space; value range: [400, 8000]
  • 40-GB increments.
Declaration
public Output<int?> CoreDiskSize { get; }
Property Value
Type Description
Output<System.Nullable<System.Int32>>
View Source

CoreDiskType

Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro. local_disk size is fixed.

Declaration
public Output<string> CoreDiskType { get; }
Property Value
Type Description
Output<System.String>
View Source

CoreInstanceQuantity

default=2. if core_instance_quantity > 1,this is cluster's instance. if core_instance_quantity = 1,this is a single instance.

Declaration
public Output<int?> CoreInstanceQuantity { get; }
Property Value
Type Description
Output<System.Nullable<System.Int32>>
View Source

CoreInstanceType

Declaration
public Output<string> CoreInstanceType { get; }
Property Value
Type Description
Output<System.String>
View Source

DeletionProtection

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

Declaration
public Output<bool?> DeletionProtection { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

Duration

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

Declaration
public Output<int> Duration { get; }
Property Value
Type Description
Output<System.Int32>
View Source

Engine

Declaration
public Output<string> Engine { get; }
Property Value
Type Description
Output<System.String>
View Source

EngineVersion

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、core_instance_type - (Required, ForceNew) Instance specification. see Instance specifications. or you can call describeInstanceType api.
Declaration
public Output<string> EngineVersion { get; }
Property Value
Type Description
Output<System.String>
View Source

MaintainEndTime

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

Declaration
public Output<string> MaintainEndTime { get; }
Property Value
Type Description
Output<System.String>
View Source

MaintainStartTime

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

Declaration
public Output<string> MaintainStartTime { get; }
Property Value
Type Description
Output<System.String>
View Source

MasterInstanceType

Declaration
public Output<string> MasterInstanceType { get; }
Property Value
Type Description
Output<System.String>
View Source

Name

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

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

PayType

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

Declaration
public Output<string> PayType { get; }
Property Value
Type Description
Output<System.String>
View Source

Tags

A mapping of tags to assign to the resource.

Declaration
public Output<ImmutableDictionary<string, object>> Tags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

VswitchId

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

Declaration
public Output<string> VswitchId { get; }
Property Value
Type Description
Output<System.String>
View Source

ZoneId

The Zone to launch the HBase instance. if vswitch_id is not empty, this zone_id can be "" or consistent.

Declaration
public Output<string> ZoneId { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, InstanceState, CustomResourceOptions)

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

Declaration
public static Instance Get(string name, Input<string> id, InstanceState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.

Input<System.String> id

The unique provider ID of the resource to lookup.

InstanceState state

Any extra arguments used during the lookup.

CustomResourceOptions options

A bag of options that control this resource's behavior

Returns
Type Description
Instance
  • View Source
Back to top Copyright 2016-2020, Pulumi Corporation.