InstanceArgs

data class InstanceArgs(val account: Output<String>? = null, val autoRenew: Output<Boolean>? = null, val coldStorageSize: Output<Int>? = null, val coreDiskSize: Output<Int>? = null, val coreDiskType: Output<String>? = null, val coreInstanceQuantity: Output<Int>? = null, val coreInstanceType: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val duration: Output<Int>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val immediateDeleteFlag: Output<Boolean>? = null, val ipWhite: Output<String>? = null, val maintainEndTime: Output<String>? = null, val maintainStartTime: Output<String>? = null, val masterInstanceType: Output<String>? = null, val name: Output<String>? = null, val password: Output<String>? = null, val payType: Output<String>? = null, val securityGroups: Output<List<String>>? = null, val tags: Output<Map<String, Any>>? = null, val vpcId: Output<String>? = null, val vswitchId: Output<String>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<InstanceArgs>

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

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 defaultZones = HbaseFunctions.getZones();
final var defaultNetworks = VpcFunctions.getNetworks(GetNetworksArgs.builder()
.nameRegex("^default-NODELETING$")
.build());
final var defaultSwitches = VpcFunctions.getSwitches(GetSwitchesArgs.builder()
.vpcId(defaultNetworks.applyValue(getNetworksResult -> getNetworksResult.ids()[0]))
.zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
.build());
var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
.zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
.vswitchId(defaultSwitches.applyValue(getSwitchesResult -> getSwitchesResult.ids()[0]))
.vpcId(defaultNetworks.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());
}
}

Import

HBase can be imported using the id, e.g.

$ pulumi import alicloud:hbase/instance:Instance example hb-wz96815u13k659fvd

Constructors

Link copied to clipboard
fun InstanceArgs(account: Output<String>? = null, autoRenew: Output<Boolean>? = null, coldStorageSize: Output<Int>? = null, coreDiskSize: Output<Int>? = null, coreDiskType: Output<String>? = null, coreInstanceQuantity: Output<Int>? = null, coreInstanceType: Output<String>? = null, deletionProtection: Output<Boolean>? = null, duration: Output<Int>? = null, engine: Output<String>? = null, engineVersion: Output<String>? = null, immediateDeleteFlag: Output<Boolean>? = null, ipWhite: Output<String>? = null, maintainEndTime: Output<String>? = null, maintainStartTime: Output<String>? = null, masterInstanceType: Output<String>? = null, name: Output<String>? = null, password: Output<String>? = null, payType: Output<String>? = null, securityGroups: Output<List<String>>? = null, tags: Output<Map<String, Any>>? = null, vpcId: Output<String>? = null, vswitchId: Output<String>? = null, zoneId: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): InstanceArgs

Properties

Link copied to clipboard
val account: Output<String>? = null

The account of the cluster web ui. Size 0-128.

Link copied to clipboard
val autoRenew: Output<Boolean>? = null

Valid values are true, false, system default to false, valid when pay_type = PrePaid.

Link copied to clipboard
val coldStorageSize: Output<Int>? = null

0 or 800, 100000000, step:10-GB increments. 0 means is_cold_storage = false. 800, 100000000 means is_cold_storage = true.

Link copied to clipboard
val coreDiskSize: Output<Int>? = null

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:

Link copied to clipboard
val coreDiskType: Output<String>? = null

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

Link copied to clipboard
val coreInstanceQuantity: Output<Int>? = null

Default=2, 1-200. If core_instance_quantity 1, this is cluster's instance. If core_instance_quantity = 1, this is a single instance.

Link copied to clipboard
val coreInstanceType: Output<String>? = null

Instance specification. See Instance specifications, or you can call describeInstanceType api.

Link copied to clipboard
val deletionProtection: Output<Boolean>? = null

The switch of delete protection. True: delete protect, False: no delete protect. You must set false when you want to delete cluster.

Link copied to clipboard
val duration: Output<Int>? = null

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.

Link copied to clipboard
val engine: Output<String>? = null

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.

Link copied to clipboard
val engineVersion: Output<String>? = null

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.

Link copied to clipboard
val immediateDeleteFlag: Output<Boolean>? = null

The switch of delete immediate. True: delete immediate, False: delete delay. You will not found the cluster no matter set true or false.

Link copied to clipboard
val ipWhite: Output<String>? = null

The white ip list of the cluster.

Link copied to clipboard
val maintainEndTime: Output<String>? = null

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.

Link copied to clipboard
val maintainStartTime: Output<String>? = null

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.

Link copied to clipboard
val masterInstanceType: Output<String>? = null

Instance specification. See Instance specifications, or you can call describeInstanceType api.

Link copied to clipboard
val name: Output<String>? = null

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

Link copied to clipboard
val password: Output<String>? = null

The password of the cluster web ui account. Size 0-128.

Link copied to clipboard
val payType: Output<String>? = null

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+.

Link copied to clipboard
val securityGroups: Output<List<String>>? = null

The security group resource of the cluster.

Link copied to clipboard
val tags: Output<Map<String, Any>>? = null

A mapping of tags to assign to the resource.

Link copied to clipboard
val vpcId: Output<String>? = null

The id of the VPC.

Link copied to clipboard
val vswitchId: Output<String>? = null

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.

Link copied to clipboard
val zoneId: Output<String>? = null

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