@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
83 lines (82 loc) • 2.39 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Get information on a single DigitalOcean region. This is useful to find out
* what Droplet sizes and features are supported within a region.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const sfo2 = digitalocean.getRegion({
* slug: "sfo2",
* });
* export const regionName = sfo2.then(sfo2 => sfo2.name);
* ```
*/
export declare function getRegion(args: GetRegionArgs, opts?: pulumi.InvokeOptions): Promise<GetRegionResult>;
/**
* A collection of arguments for invoking getRegion.
*/
export interface GetRegionArgs {
/**
* A human-readable string that is used as a unique identifier for each region.
*/
slug: string;
}
/**
* A collection of values returned by getRegion.
*/
export interface GetRegionResult {
/**
* A boolean value that represents whether new Droplets can be created in this region.
*/
readonly available: boolean;
/**
* A set of features available in this region.
*/
readonly features: string[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The display name of the region.
*/
readonly name: string;
/**
* A set of identifying slugs for the Droplet sizes available in this region.
*/
readonly sizes: string[];
/**
* A human-readable string that is used as a unique identifier for each region.
*/
readonly slug: string;
}
/**
* Get information on a single DigitalOcean region. This is useful to find out
* what Droplet sizes and features are supported within a region.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const sfo2 = digitalocean.getRegion({
* slug: "sfo2",
* });
* export const regionName = sfo2.then(sfo2 => sfo2.name);
* ```
*/
export declare function getRegionOutput(args: GetRegionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRegionResult>;
/**
* A collection of arguments for invoking getRegion.
*/
export interface GetRegionOutputArgs {
/**
* A human-readable string that is used as a unique identifier for each region.
*/
slug: pulumi.Input<string>;
}