pulumi-digitalocean-kotlin/com.pulumi.digitalocean.kotlin/DigitaloceanFunctions/getRegions

getRegions

suspend fun getRegions(argument: GetRegionsPlainArgs): GetRegionsResult

Retrieve information about all supported DigitalOcean regions, with the ability to filter and sort the results. If no filters are specified, all regions will be returned. Note: You can use the digitalocean.getRegion data source to obtain metadata about a single region if you already know the slug to retrieve.

Example Usage

Use the filter block with a key string and values list to filter regions. For example to find all available regions:

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.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 available = DigitaloceanFunctions.getRegions(GetRegionsArgs.builder()
            .filters(GetRegionsFilterArgs.builder()
                .key("available")
                .values("true")
                .build())
            .build());
    }
}
Content copied to clipboard

Return

A collection of values returned by getRegions.

Parameters

argument

A collection of arguments for invoking getRegions.

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

Return

A collection of values returned by getRegions.

See also

Parameters

filters

Filter the results. The filter block is documented below.

sorts

Sort the results. The sort block is documented below.

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

Return

A collection of values returned by getRegions.

See also

Parameters

argument

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