import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * 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 * * ```typescript * 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 * * ```sh * $ pulumi import volcenginecc:hbase/instance:Instance example "instance_id" * ``` */ export declare class Instance extends pulumi.CustomResource { /** * Get an existing Instance resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance; /** * Returns true if the given object is an instance of Instance. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Instance; /** * Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled. */ readonly autoRenew: pulumi.Output; /** * Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown. */ readonly chargeStatus: pulumi.Output; /** * Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly). */ readonly chargeType: pulumi.Output; /** * Total capacity-type storage space for the instance, in GiB. */ readonly coldStorage: pulumi.Output; /** * Instance creation time (UTC). */ readonly createTime: pulumi.Output; /** * Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection. */ readonly deletionProtection: pulumi.Output; /** * Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled. */ readonly enableAuth: pulumi.Output; /** * 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). */ readonly enableCloudStorage: pulumi.Output; readonly endpoints: pulumi.Output; /** * HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0 */ readonly engineVersion: pulumi.Output; /** * Instance ID */ readonly instanceId: pulumi.Output; /** * Instance name */ readonly instanceName: pulumi.Output; /** * Instance type. Currently, only Standard is supported. The default value is Standard */ readonly instanceType: pulumi.Output; /** * Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default */ readonly masterCount: pulumi.Output; /** * 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. */ readonly masterSpec: pulumi.Output; /** * Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported. */ readonly multiAz: pulumi.Output; /** * Real-time primary availability zone subnet ID. */ readonly primarySubnetId: pulumi.Output; /** * Real-time primary zone ID */ readonly primaryZoneId: pulumi.Output; /** * Project name of the instance */ readonly projectName: pulumi.Output; /** * 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 */ readonly purchaseMonths: pulumi.Output; /** * Region ID of the instance. */ readonly regionId: pulumi.Output; /** * Number of RegionServer nodes */ readonly rsCount: pulumi.Output; /** * RegionServer node specification code. */ readonly rsSpec: pulumi.Output; /** * Real-time standby availability zone subnet ID. */ readonly standbySubnetId: pulumi.Output; /** * Real-time standby zone ID */ readonly standbyZoneId: pulumi.Output; /** * Current status of the instance. For more details about instance status, see Instance Status Description */ readonly status: pulumi.Output; /** * Total storage capacity of the instance, unit: GiB. */ readonly storageCapacity: pulumi.Output; /** * Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage. */ readonly storageType: pulumi.Output; /** * Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included */ readonly subnetId: pulumi.Output; readonly tags: pulumi.Output; /** * Capacity-type storage space used by the instance, in MiB */ readonly usedColdStorage: pulumi.Output; /** * Storage capacity used by the primary instance, in MiB */ readonly usedStorage: pulumi.Output; /** * 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. */ readonly vpcId: pulumi.Output; /** * Name of the private network to which the instance belongs. */ readonly vpcName: pulumi.Output; /** * Zone ID of the instance */ readonly zoneId: pulumi.Output; /** * Name of the availability zone to which the instance belongs. */ readonly zoneName: pulumi.Output; /** * Create a Instance resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Instance resources. */ export interface InstanceState { /** * Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled. */ autoRenew?: pulumi.Input; /** * Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown. */ chargeStatus?: pulumi.Input; /** * Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly). */ chargeType?: pulumi.Input; /** * Total capacity-type storage space for the instance, in GiB. */ coldStorage?: pulumi.Input; /** * Instance creation time (UTC). */ createTime?: pulumi.Input; /** * Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection. */ deletionProtection?: pulumi.Input; /** * Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled. */ enableAuth?: pulumi.Input; /** * 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). */ enableCloudStorage?: pulumi.Input; endpoints?: pulumi.Input[]>; /** * HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0 */ engineVersion?: pulumi.Input; /** * Instance ID */ instanceId?: pulumi.Input; /** * Instance name */ instanceName?: pulumi.Input; /** * Instance type. Currently, only Standard is supported. The default value is Standard */ instanceType?: pulumi.Input; /** * Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default */ masterCount?: pulumi.Input; /** * 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. */ masterSpec?: pulumi.Input; /** * Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported. */ multiAz?: pulumi.Input; /** * Real-time primary availability zone subnet ID. */ primarySubnetId?: pulumi.Input; /** * Real-time primary zone ID */ primaryZoneId?: pulumi.Input; /** * Project name of the instance */ projectName?: pulumi.Input; /** * 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 */ purchaseMonths?: pulumi.Input; /** * Region ID of the instance. */ regionId?: pulumi.Input; /** * Number of RegionServer nodes */ rsCount?: pulumi.Input; /** * RegionServer node specification code. */ rsSpec?: pulumi.Input; /** * Real-time standby availability zone subnet ID. */ standbySubnetId?: pulumi.Input; /** * Real-time standby zone ID */ standbyZoneId?: pulumi.Input; /** * Current status of the instance. For more details about instance status, see Instance Status Description */ status?: pulumi.Input; /** * Total storage capacity of the instance, unit: GiB. */ storageCapacity?: pulumi.Input; /** * Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage. */ storageType?: pulumi.Input; /** * Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included */ subnetId?: pulumi.Input; tags?: pulumi.Input[]>; /** * Capacity-type storage space used by the instance, in MiB */ usedColdStorage?: pulumi.Input; /** * Storage capacity used by the primary instance, in MiB */ usedStorage?: pulumi.Input; /** * 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. */ vpcId?: pulumi.Input; /** * Name of the private network to which the instance belongs. */ vpcName?: pulumi.Input; /** * Zone ID of the instance */ zoneId?: pulumi.Input; /** * Name of the availability zone to which the instance belongs. */ zoneName?: pulumi.Input; } /** * The set of arguments for constructing a Instance resource. */ export interface InstanceArgs { /** * Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled. */ autoRenew?: pulumi.Input; /** * Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly). */ chargeType: pulumi.Input; /** * Total capacity-type storage space for the instance, in GiB. */ coldStorage?: pulumi.Input; /** * Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection. */ deletionProtection?: pulumi.Input; /** * Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled. */ enableAuth?: pulumi.Input; /** * 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). */ enableCloudStorage?: pulumi.Input; endpoints?: pulumi.Input[]>; /** * HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0 */ engineVersion: pulumi.Input; /** * Instance name */ instanceName?: pulumi.Input; /** * Instance type. Currently, only Standard is supported. The default value is Standard */ instanceType?: pulumi.Input; /** * 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. */ masterSpec: pulumi.Input; /** * Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported. */ multiAz?: pulumi.Input; /** * Project name of the instance */ projectName?: pulumi.Input; /** * 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 */ purchaseMonths?: pulumi.Input; /** * Region ID of the instance. */ regionId: pulumi.Input; /** * Number of RegionServer nodes */ rsCount: pulumi.Input; /** * RegionServer node specification code. */ rsSpec: pulumi.Input; /** * Total storage capacity of the instance, unit: GiB. */ storageCapacity: pulumi.Input; /** * Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage. */ storageType: pulumi.Input; /** * Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included */ subnetId: pulumi.Input; tags?: pulumi.Input[]>; /** * 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. */ vpcId: pulumi.Input; /** * Zone ID of the instance */ zoneId: pulumi.Input; }