Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. clickhouse
  5. getRegions
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.clickhouse.getRegions

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

This data source provides the Click House Regions of the current Alibaba Cloud user.

NOTE: Available in v1.138.0+.

Example Usage

Basic Usage

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

const default1 = alicloud.clickhouse.getRegions({
    current: true,
});
const default2 = alicloud.clickhouse.getRegions({
    regionId: "cn-hangzhou",
});
Copy
import pulumi
import pulumi_alicloud as alicloud

default1 = alicloud.clickhouse.get_regions(current=True)
default2 = alicloud.clickhouse.get_regions(region_id="cn-hangzhou")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := clickhouse.GetRegions(ctx, &clickhouse.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		_, err = clickhouse.GetRegions(ctx, &clickhouse.GetRegionsArgs{
			RegionId: pulumi.StringRef("cn-hangzhou"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var default1 = AliCloud.ClickHouse.GetRegions.Invoke(new()
    {
        Current = true,
    });

    var default2 = AliCloud.ClickHouse.GetRegions.Invoke(new()
    {
        RegionId = "cn-hangzhou",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.clickhouse.ClickhouseFunctions;
import com.pulumi.alicloud.clickhouse.inputs.GetRegionsArgs;
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 default1 = ClickhouseFunctions.getRegions(GetRegionsArgs.builder()
            .current(true)
            .build());

        final var default2 = ClickhouseFunctions.getRegions(GetRegionsArgs.builder()
            .regionId("cn-hangzhou")
            .build());

    }
}
Copy
variables:
  default1:
    fn::invoke:
      function: alicloud:clickhouse:getRegions
      arguments:
        current: true
  default2:
    fn::invoke:
      function: alicloud:clickhouse:getRegions
      arguments:
        regionId: cn-hangzhou
Copy

Using getRegions

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.

function getRegions(args: GetRegionsArgs, opts?: InvokeOptions): Promise<GetRegionsResult>
function getRegionsOutput(args: GetRegionsOutputArgs, opts?: InvokeOptions): Output<GetRegionsResult>
Copy
def get_regions(current: Optional[bool] = None,
                output_file: Optional[str] = None,
                region_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetRegionsResult
def get_regions_output(current: Optional[pulumi.Input[bool]] = None,
                output_file: Optional[pulumi.Input[str]] = None,
                region_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetRegionsResult]
Copy
func GetRegions(ctx *Context, args *GetRegionsArgs, opts ...InvokeOption) (*GetRegionsResult, error)
func GetRegionsOutput(ctx *Context, args *GetRegionsOutputArgs, opts ...InvokeOption) GetRegionsResultOutput
Copy

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

public static class GetRegions 
{
    public static Task<GetRegionsResult> InvokeAsync(GetRegionsArgs args, InvokeOptions? opts = null)
    public static Output<GetRegionsResult> Invoke(GetRegionsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRegionsResult> getRegions(GetRegionsArgs args, InvokeOptions options)
public static Output<GetRegionsResult> getRegions(GetRegionsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: alicloud:clickhouse/getRegions:getRegions
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Current bool
Set to true to match only the region configured in the provider. Default value: true.
OutputFile string
File name where to save data source results (after running pulumi preview).
RegionId string
You can use specified region_id to find the region and available zones information that supports ClickHouse.
Current bool
Set to true to match only the region configured in the provider. Default value: true.
OutputFile string
File name where to save data source results (after running pulumi preview).
RegionId string
You can use specified region_id to find the region and available zones information that supports ClickHouse.
current Boolean
Set to true to match only the region configured in the provider. Default value: true.
outputFile String
File name where to save data source results (after running pulumi preview).
regionId String
You can use specified region_id to find the region and available zones information that supports ClickHouse.
current boolean
Set to true to match only the region configured in the provider. Default value: true.
outputFile string
File name where to save data source results (after running pulumi preview).
regionId string
You can use specified region_id to find the region and available zones information that supports ClickHouse.
current bool
Set to true to match only the region configured in the provider. Default value: true.
output_file str
File name where to save data source results (after running pulumi preview).
region_id str
You can use specified region_id to find the region and available zones information that supports ClickHouse.
current Boolean
Set to true to match only the region configured in the provider. Default value: true.
outputFile String
File name where to save data source results (after running pulumi preview).
regionId String
You can use specified region_id to find the region and available zones information that supports ClickHouse.

getRegions Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Regions List<Pulumi.AliCloud.ClickHouse.Outputs.GetRegionsRegion>
Current bool
OutputFile string
RegionId string
Id string
The provider-assigned unique ID for this managed resource.
Regions []GetRegionsRegion
Current bool
OutputFile string
RegionId string
id String
The provider-assigned unique ID for this managed resource.
regions List<GetRegionsRegion>
current Boolean
outputFile String
regionId String
id string
The provider-assigned unique ID for this managed resource.
regions GetRegionsRegion[]
current boolean
outputFile string
regionId string
id str
The provider-assigned unique ID for this managed resource.
regions Sequence[GetRegionsRegion]
current bool
output_file str
region_id str
id String
The provider-assigned unique ID for this managed resource.
regions List<Property Map>
current Boolean
outputFile String
regionId String

Supporting Types

GetRegionsRegion

RegionId This property is required. string
The Region ID.
ZoneIds This property is required. List<Pulumi.AliCloud.ClickHouse.Inputs.GetRegionsRegionZoneId>
A list of available zone ids in the region_id.
RegionId This property is required. string
The Region ID.
ZoneIds This property is required. []GetRegionsRegionZoneId
A list of available zone ids in the region_id.
regionId This property is required. String
The Region ID.
zoneIds This property is required. List<GetRegionsRegionZoneId>
A list of available zone ids in the region_id.
regionId This property is required. string
The Region ID.
zoneIds This property is required. GetRegionsRegionZoneId[]
A list of available zone ids in the region_id.
region_id This property is required. str
The Region ID.
zone_ids This property is required. Sequence[GetRegionsRegionZoneId]
A list of available zone ids in the region_id.
regionId This property is required. String
The Region ID.
zoneIds This property is required. List<Property Map>
A list of available zone ids in the region_id.

GetRegionsRegionZoneId

VpcEnabled This property is required. bool
Whether to support vpc network.
ZoneId This property is required. string
The zone ID.
VpcEnabled This property is required. bool
Whether to support vpc network.
ZoneId This property is required. string
The zone ID.
vpcEnabled This property is required. Boolean
Whether to support vpc network.
zoneId This property is required. String
The zone ID.
vpcEnabled This property is required. boolean
Whether to support vpc network.
zoneId This property is required. string
The zone ID.
vpc_enabled This property is required. bool
Whether to support vpc network.
zone_id This property is required. str
The zone ID.
vpcEnabled This property is required. Boolean
Whether to support vpc network.
zoneId This property is required. String
The zone ID.

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