1. Packages
  2. Vkcs Provider
  3. API Docs
  4. getRegion
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vkcs.getRegion

Explore with Pulumi AI

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vkcs.getRegion provides details about a specific VKCS region. As well as validating a given region name this resource can be used to discover the name of the region configured within the provider.

Example Usage

The following example shows how the resource might be used to obtain the name of the VKCS region configured on the provider.

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

const current = vkcs.getRegion({});
Copy
import pulumi
import pulumi_vkcs as vkcs

current = vkcs.get_region()
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.GetRegion(ctx, &vkcs.GetRegionArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var current = Vkcs.GetRegion.Invoke();

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.VkcsFunctions;
import com.pulumi.vkcs.inputs.GetRegionArgs;
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 current = VkcsFunctions.getRegion();

    }
}
Copy
variables:
  current:
    fn::invoke:
      function: vkcs:getRegion
      arguments: {}
Copy

Using getRegion

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 getRegion(args: GetRegionArgs, opts?: InvokeOptions): Promise<GetRegionResult>
function getRegionOutput(args: GetRegionOutputArgs, opts?: InvokeOptions): Output<GetRegionResult>
Copy
def get_region(id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetRegionResult
def get_region_output(id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetRegionResult]
Copy
func GetRegion(ctx *Context, args *GetRegionArgs, opts ...InvokeOption) (*GetRegionResult, error)
func GetRegionOutput(ctx *Context, args *GetRegionOutputArgs, opts ...InvokeOption) GetRegionResultOutput
Copy

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

public static class GetRegion 
{
    public static Task<GetRegionResult> InvokeAsync(GetRegionArgs args, InvokeOptions? opts = null)
    public static Output<GetRegionResult> Invoke(GetRegionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRegionResult> getRegion(GetRegionArgs args, InvokeOptions options)
public static Output<GetRegionResult> getRegion(GetRegionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: vkcs:index/getRegion:getRegion
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
optional string → ID of the region to learn or use. Use empty value to learn current region on the provider.
Id string
optional string → ID of the region to learn or use. Use empty value to learn current region on the provider.
id String
optional string → ID of the region to learn or use. Use empty value to learn current region on the provider.
id string
optional string → ID of the region to learn or use. Use empty value to learn current region on the provider.
id str
optional string → ID of the region to learn or use. Use empty value to learn current region on the provider.
id String
optional string → ID of the region to learn or use. Use empty value to learn current region on the provider.

getRegion Result

The following output properties are available:

Description string
string → Description of the region.
Id string
ParentRegion string
string → Parent of the region.
Description string
string → Description of the region.
Id string
ParentRegion string
string → Parent of the region.
description String
string → Description of the region.
id String
parentRegion String
string → Parent of the region.
description string
string → Description of the region.
id string
parentRegion string
string → Parent of the region.
description str
string → Description of the region.
id str
parent_region str
string → Parent of the region.
description String
string → Description of the region.
id String
parentRegion String
string → Parent of the region.

Package Details

Repository
vkcs vk-cs/terraform-provider-vkcs
License
Notes
This Pulumi package is based on the vkcs Terraform Provider.
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs