Alibaba Cloud v3.76.0, Apr 8 25

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.hbase.getInstances

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const hbase = alicloud.hbase.getInstances({
    nameRegex: "tf_testAccHBase",
    availabilityZone: "cn-shenzhen-b",
});

import pulumi
import pulumi_alicloud as alicloud

hbase = alicloud.hbase.get_instances(name_regex="tf_testAccHBase",
    availability_zone="cn-shenzhen-b")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hbase.GetInstances(ctx, &hbase.GetInstancesArgs{
			NameRegex:        pulumi.StringRef("tf_testAccHBase"),
			AvailabilityZone: pulumi.StringRef("cn-shenzhen-b"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var hbase = AliCloud.Hbase.GetInstances.Invoke(new()
    {
        NameRegex = "tf_testAccHBase",
        AvailabilityZone = "cn-shenzhen-b",
    });

});

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.GetInstancesArgs;
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 hbase = HbaseFunctions.getInstances(GetInstancesArgs.builder()
            .nameRegex("tf_testAccHBase")
            .availabilityZone("cn-shenzhen-b")
            .build());

    }
}

variables:
  hbase:
    fn::invoke:
      function: alicloud:hbase:getInstances
      arguments:
        nameRegex: tf_testAccHBase
        availabilityZone: cn-shenzhen-b

Using getInstances

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>
function getInstancesOutput(args: GetInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstancesResult>

def get_instances(availability_zone: Optional[str] = None,
                  ids: Optional[Sequence[str]] = None,
                  name_regex: Optional[str] = None,
                  output_file: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetInstancesResult
def get_instances_output(availability_zone: Optional[pulumi.Input[str]] = None,
                  ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  name_regex: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetInstancesResult]

func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
func GetInstancesOutput(ctx *Context, args *GetInstancesOutputArgs, opts ...InvokeOption) GetInstancesResultOutput

> Note: This function is named GetInstances in the Go SDK.

public static class GetInstances 
{
    public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetInstancesResult> Invoke(GetInstancesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
public static Output<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)

fn::invoke:
  function: alicloud:hbase/getInstances:getInstances
  arguments:
    # arguments dictionary

The following arguments are supported:

AvailabilityZone string: Instance availability zone.
Ids List<string>: The ids list of HBase instances
NameRegex string: A regex string to apply to the instance name.
OutputFile string: The name of file that can save the collection of instances after running pulumi preview.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

AvailabilityZone string: Instance availability zone.
Ids []string: The ids list of HBase instances
NameRegex string: A regex string to apply to the instance name.
OutputFile string: The name of file that can save the collection of instances after running pulumi preview.
Tags map[string]string: A mapping of tags to assign to the resource.

availabilityZone String: Instance availability zone.
ids List<String>: The ids list of HBase instances
nameRegex String: A regex string to apply to the instance name.
outputFile String: The name of file that can save the collection of instances after running pulumi preview.
tags Map<String,String>: A mapping of tags to assign to the resource.

availabilityZone string: Instance availability zone.
ids string[]: The ids list of HBase instances
nameRegex string: A regex string to apply to the instance name.
outputFile string: The name of file that can save the collection of instances after running pulumi preview.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

availability_zone str: Instance availability zone.
ids Sequence[str]: The ids list of HBase instances
name_regex str: A regex string to apply to the instance name.
output_file str: The name of file that can save the collection of instances after running pulumi preview.
tags Mapping[str, str]: A mapping of tags to assign to the resource.

availabilityZone String: Instance availability zone.
ids List<String>: The ids list of HBase instances
nameRegex String: A regex string to apply to the instance name.
outputFile String: The name of file that can save the collection of instances after running pulumi preview.
tags Map<String>: A mapping of tags to assign to the resource.

getInstances Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>: The ids list of HBase instances
Instances List<Pulumi.AliCloud.Hbase.Outputs.GetInstancesInstance>: A list of HBase instances. Its every element contains the following attributes:
Names List<string>: The names list of HBase instances
AvailabilityZone string
NameRegex string
OutputFile string
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

Id string: The provider-assigned unique ID for this managed resource.
Ids []string: The ids list of HBase instances
Instances []GetInstancesInstance: A list of HBase instances. Its every element contains the following attributes:
Names []string: The names list of HBase instances
AvailabilityZone string
NameRegex string
OutputFile string
Tags map[string]string: A mapping of tags to assign to the resource.

id String: The provider-assigned unique ID for this managed resource.
ids List<String>: The ids list of HBase instances
instances List<GetInstancesInstance>: A list of HBase instances. Its every element contains the following attributes:
names List<String>: The names list of HBase instances
availabilityZone String
nameRegex String
outputFile String
tags Map<String,String>: A mapping of tags to assign to the resource.

id string: The provider-assigned unique ID for this managed resource.
ids string[]: The ids list of HBase instances
instances GetInstancesInstance[]: A list of HBase instances. Its every element contains the following attributes:
names string[]: The names list of HBase instances
availabilityZone string
nameRegex string
outputFile string
tags {[key: string]: string}: A mapping of tags to assign to the resource.

id str: The provider-assigned unique ID for this managed resource.
ids Sequence[str]: The ids list of HBase instances
instances Sequence[GetInstancesInstance]: A list of HBase instances. Its every element contains the following attributes:
names Sequence[str]: The names list of HBase instances
availability_zone str
name_regex str
output_file str
tags Mapping[str, str]: A mapping of tags to assign to the resource.

id String: The provider-assigned unique ID for this managed resource.
ids List<String>: The ids list of HBase instances
instances List<Property Map>: A list of HBase instances. Its every element contains the following attributes:
names List<String>: The names list of HBase instances
availabilityZone String
nameRegex String
outputFile String
tags Map<String>: A mapping of tags to assign to the resource.

Supporting Types

GetInstancesInstance

BackupStatus string: The Backup Status of the instance.
CoreDiskSize int: Core node disk size, unit:GB.
CoreDiskType string: Cloud_ssd or cloud_efficiency
CoreInstanceType string: Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
CoreNodeCount int: Same with "core_instance_quantity"
CreatedTime string: The created time of the instance.
DeletionProtection bool: The switch of delete protection.
Engine string: The engine of the instance.
EngineVersion string: The engine_version of the instance.
ExpireTime string: The expire time of the instance.
Id string: The ID of the HBase instance.
MasterInstanceType string: Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
MasterNodeCount int: The node count of master
Name string: The name of the HBase instance.
NetworkType string: Classic network or VPC.
PayType string: Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.
RegionId string: Region ID the instance belongs to.
Status string: Status of the instance.
VpcId string: VPC ID the instance belongs to.
VswitchId string: VSwitch ID the instance belongs to.
ZoneId string: Zone ID the instance belongs to.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

BackupStatus string: The Backup Status of the instance.
CoreDiskSize int: Core node disk size, unit:GB.
CoreDiskType string: Cloud_ssd or cloud_efficiency
CoreInstanceType string: Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
CoreNodeCount int: Same with "core_instance_quantity"
CreatedTime string: The created time of the instance.
DeletionProtection bool: The switch of delete protection.
Engine string: The engine of the instance.
EngineVersion string: The engine_version of the instance.
ExpireTime string: The expire time of the instance.
Id string: The ID of the HBase instance.
MasterInstanceType string: Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
MasterNodeCount int: The node count of master
Name string: The name of the HBase instance.
NetworkType string: Classic network or VPC.
PayType string: Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.
RegionId string: Region ID the instance belongs to.
Status string: Status of the instance.
VpcId string: VPC ID the instance belongs to.
VswitchId string: VSwitch ID the instance belongs to.
ZoneId string: Zone ID the instance belongs to.
Tags map[string]string: A mapping of tags to assign to the resource.

backupStatus String: The Backup Status of the instance.
coreDiskSize Integer: Core node disk size, unit:GB.
coreDiskType String: Cloud_ssd or cloud_efficiency
coreInstanceType String: Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
coreNodeCount Integer: Same with "core_instance_quantity"
createdTime String: The created time of the instance.
deletionProtection Boolean: The switch of delete protection.
engine String: The engine of the instance.
engineVersion String: The engine_version of the instance.
expireTime String: The expire time of the instance.
id String: The ID of the HBase instance.
masterInstanceType String: Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
masterNodeCount Integer: The node count of master
name String: The name of the HBase instance.
networkType String: Classic network or VPC.
payType String: Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.
regionId String: Region ID the instance belongs to.
status String: Status of the instance.
vpcId String: VPC ID the instance belongs to.
vswitchId String: VSwitch ID the instance belongs to.
zoneId String: Zone ID the instance belongs to.
tags Map<String,String>: A mapping of tags to assign to the resource.

backupStatus string: The Backup Status of the instance.
coreDiskSize number: Core node disk size, unit:GB.
coreDiskType string: Cloud_ssd or cloud_efficiency
coreInstanceType string: Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
coreNodeCount number: Same with "core_instance_quantity"
createdTime string: The created time of the instance.
deletionProtection boolean: The switch of delete protection.
engine string: The engine of the instance.
engineVersion string: The engine_version of the instance.
expireTime string: The expire time of the instance.
id string: The ID of the HBase instance.
masterInstanceType string: Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
masterNodeCount number: The node count of master
name string: The name of the HBase instance.
networkType string: Classic network or VPC.
payType string: Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.
regionId string: Region ID the instance belongs to.
status string: Status of the instance.
vpcId string: VPC ID the instance belongs to.
vswitchId string: VSwitch ID the instance belongs to.
zoneId string: Zone ID the instance belongs to.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

backup_status str: The Backup Status of the instance.
core_disk_size int: Core node disk size, unit:GB.
core_disk_type str: Cloud_ssd or cloud_efficiency
core_instance_type str: Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
core_node_count int: Same with "core_instance_quantity"
created_time str: The created time of the instance.
deletion_protection bool: The switch of delete protection.
engine str: The engine of the instance.
engine_version str: The engine_version of the instance.
expire_time str: The expire time of the instance.
id str: The ID of the HBase instance.
master_instance_type str: Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
master_node_count int: The node count of master
name str: The name of the HBase instance.
network_type str: Classic network or VPC.
pay_type str: Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.
region_id str: Region ID the instance belongs to.
status str: Status of the instance.
vpc_id str: VPC ID the instance belongs to.
vswitch_id str: VSwitch ID the instance belongs to.
zone_id str: Zone ID the instance belongs to.
tags Mapping[str, str]: A mapping of tags to assign to the resource.

backupStatus String: The Backup Status of the instance.
coreDiskSize Number: Core node disk size, unit:GB.
coreDiskType String: Cloud_ssd or cloud_efficiency
coreInstanceType String: Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
coreNodeCount Number: Same with "core_instance_quantity"
createdTime String: The created time of the instance.
deletionProtection Boolean: The switch of delete protection.
engine String: The engine of the instance.
engineVersion String: The engine_version of the instance.
expireTime String: The expire time of the instance.
id String: The ID of the HBase instance.
masterInstanceType String: Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
masterNodeCount Number: The node count of master
name String: The name of the HBase instance.
networkType String: Classic network or VPC.
payType String: Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.
regionId String: Region ID the instance belongs to.
status String: Status of the instance.
vpcId String: VPC ID the instance belongs to.
vswitchId String: VSwitch ID the instance belongs to.
zoneId String: Zone ID the instance belongs to.
tags Map<String>: A mapping of tags to assign to the resource.

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-alicloud

alicloud.hbase.getInstances

On this page

On this page

Example Usage

Using getInstances

getInstances Result

Supporting Types

GetInstancesInstance

Package Details

On this page

On this page