pulumi-aws-kotlin/com.pulumi.aws.kotlin/AwsFunctions/getRegions

getRegions

suspend fun getRegions(argument: GetRegionsPlainArgs): GetRegionsResult

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

Enabled AWS Regions:

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.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 current = AwsFunctions.getRegions();
    }
}
Content copied to clipboard

Return

A collection of values returned by getRegions.

Parameters

argument

A collection of arguments for invoking getRegions.

suspend fun getRegions(allRegions: Boolean? = null, filters: List<GetRegionsFilter>? = null): GetRegionsResult

Return

A collection of values returned by getRegions.

Parameters

allRegions

If true the source will query all regions regardless of availability.

filters

Configuration block(s) to use as filters. Detailed below.

See also

.

suspend fun getRegions(argument: suspend GetRegionsPlainArgsBuilder.() -> Unit): GetRegionsResult

Return

A collection of values returned by getRegions.

Parameters

argument

Builder for com.pulumi.aws.kotlin.inputs.GetRegionsPlainArgs.

See also

.