getRegions function

Future<GetRegionsResult> getRegions(
  1. GetRegionsArgs args, {
  2. InvokeOptions? options,
})

The aws.account.getRegions data source lets you query AWS region information for any account in your AWS Organization. It uses the AWS Account REST Service to show all regions, including those that are enabled, disabled, or in the process of being enabled or disabled. You can list regions for any organization account, see all possible region opt-in statuses (ENABLED, ENABLING, DISABLING, DISABLED, ENABLED_BY_DEFAULT), and check which regions are being enabled or disabled.

This is more comprehensive than the aws.getRegions data source, which only uses the EC2 REST service and is limited to the current account and a subset of region statuses.

Example Usage

Basic Usage

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

const example = aws.account.getRegions({});
import pulumi
import pulumi_aws as aws

example = aws.account.get_regions()
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.Account.GetRegions.Invoke();

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := account.GetRegions(ctx, &account.GetRegionsArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_account_getregions" "example" {
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.account.AccountFunctions;
import com.pulumi.aws.account.inputs.GetRegionsArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = AccountFunctions.getRegions(GetRegionsArgs.builder()
            .build());

    }
}
variables:
  example:
    fn::invoke:
      function: aws:account:getRegions
      arguments: {}

args Arguments passed to this invoke. Arguments for getRegions. options Invoke options controlling this call.

Implementation

Future<GetRegionsResult> getRegions(
  GetRegionsArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:account/getRegions:getRegions',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetRegionsResult.fromMap(result);
}