@pulumi/digitalocean/getRegions.js

A Pulumi package for creating and managing DigitalOcean cloud resources.

"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getRegionsOutput = exports.getRegions = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * 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:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as digitalocean from "@pulumi/digitalocean";
 *
 * const available = digitalocean.getRegions({
 *     filters: [{
 *         key: "available",
 *         values: ["true"],
 *     }],
 * });
 * ```
 *
 * You can filter on multiple fields and sort the results as well:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as digitalocean from "@pulumi/digitalocean";
 *
 * const available = digitalocean.getRegions({
 *     filters: [
 *         {
 *             key: "available",
 *             values: ["true"],
 *         },
 *         {
 *             key: "features",
 *             values: ["private_networking"],
 *         },
 *     ],
 *     sorts: [{
 *         key: "name",
 *         direction: "desc",
 *     }],
 * });
 * ```
 */
function getRegions(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("digitalocean:index/getRegions:getRegions", {
        "filters": args.filters,
        "sorts": args.sorts,
    }, opts);
}
exports.getRegions = getRegions;
/**
 * 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:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as digitalocean from "@pulumi/digitalocean";
 *
 * const available = digitalocean.getRegions({
 *     filters: [{
 *         key: "available",
 *         values: ["true"],
 *     }],
 * });
 * ```
 *
 * You can filter on multiple fields and sort the results as well:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as digitalocean from "@pulumi/digitalocean";
 *
 * const available = digitalocean.getRegions({
 *     filters: [
 *         {
 *             key: "available",
 *             values: ["true"],
 *         },
 *         {
 *             key: "features",
 *             values: ["private_networking"],
 *         },
 *     ],
 *     sorts: [{
 *         key: "name",
 *         direction: "desc",
 *     }],
 * });
 * ```
 */
function getRegionsOutput(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("digitalocean:index/getRegions:getRegions", {
        "filters": args.filters,
        "sorts": args.sorts,
    }, opts);
}
exports.getRegionsOutput = getRegionsOutput;
//# sourceMappingURL=getRegions.js.map