PulumiUP: Hear from technical leaders as they present the vision for the future of cloud engineering. Save Your Spot

getRegions

Provides information about AWS Regions. Can be used to filter regions i.e. by Opt-In status or only regions enabled for current account. To get details like endpoint and description of each region the data source can be combined with the aws.getRegion data source.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var current = Output.Create(Aws.GetRegions.InvokeAsync());
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v3/go/aws"
	"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aws.GetRegions(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

current = aws.get_regions()
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const current = pulumi.output(aws.getRegions({ async: true }));

Using getRegions

function getRegions(args: GetRegionsArgs, opts?: InvokeOptions): Promise<GetRegionsResult>
def get_regions(all_regions: Optional[bool] = None, filters: Optional[Sequence[GetRegionsFilterArgs]] = None, opts: Optional[InvokeOptions] = None) -> GetRegionsResult
func GetRegions(ctx *Context, args *GetRegionsArgs, opts ...InvokeOption) (*GetRegionsResult, error)

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

public static class GetRegions {
    public static Task<GetRegionsResult> InvokeAsync(GetRegionsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

AllRegions bool
If true the source will query all regions regardless of availability.
Filters List<GetRegionsFilterArgs>
Configuration block(s) to use as filters. Detailed below.
AllRegions bool
If true the source will query all regions regardless of availability.
Filters []GetRegionsFilter
Configuration block(s) to use as filters. Detailed below.
allRegions boolean
If true the source will query all regions regardless of availability.
filters GetRegionsFilter[]
Configuration block(s) to use as filters. Detailed below.
all_regions bool
If true the source will query all regions regardless of availability.
filters Sequence[GetRegionsFilterArgs]
Configuration block(s) to use as filters. Detailed below.

getRegions Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Names List<string>
Names of regions that meets the criteria.
AllRegions bool
Filters List<GetRegionsFilter>
Id string
The provider-assigned unique ID for this managed resource.
Names []string
Names of regions that meets the criteria.
AllRegions bool
Filters []GetRegionsFilter
id string
The provider-assigned unique ID for this managed resource.
names string[]
Names of regions that meets the criteria.
allRegions boolean
filters GetRegionsFilter[]
id str
The provider-assigned unique ID for this managed resource.
names Sequence[str]
Names of regions that meets the criteria.
all_regions bool
filters Sequence[GetRegionsFilter]

Supporting Types

GetRegionsFilter

Name string
The name of the filter field. Valid values can be found in the [describe-regions AWS CLI Reference][1].
Values List<string>
Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
Name string
The name of the filter field. Valid values can be found in the [describe-regions AWS CLI Reference][1].
Values []string
Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
name string
The name of the filter field. Valid values can be found in the [describe-regions AWS CLI Reference][1].
values string[]
Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
name str
The name of the filter field. Valid values can be found in the [describe-regions AWS CLI Reference][1].
values Sequence[str]
Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.