@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
147 lines • 4.81 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getRegionsOutput = exports.getRegions = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(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