@pulumiverse/cpln
Version:
A Pulumi package for creating and managing Control Plane (cpln) resources.
122 lines • 4.32 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! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getLocationsOutput = exports.getLocations = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Use this data source to access information about all [Locations](https://docs.controlplane.com/reference/location) within Control Plane.
*
* ## Outputs
*
* The following attributes are exported:
*
* - **locations** (Block List) (see below).
*
* <a id="nestedblock--locations"></a>
*
* ### `locations`
*
* - **cpln_id** (String) The ID, in GUID format, of the location.
* - **name** (String) Name of the location.
* - **description** (String) Description of the location.
* - **tags** (Map of String) Key-value map of resource tags.
* - **origin** (String) Origin of the location. Valid values: `builtin`, `default`, `custom`.
* - **cloud_provider** (String) Cloud Provider of the location. Valid values: `aws`, `gcp`, `azure`, `byok`, `linode`, `vultr`, `equinix`, `oci`.
* - **region** (String) Region of the location.
* - **enabled** (Boolean) Indication if location is enabled.
* - **geo** (Block List, Max: 1) (see below)
* - **ip_ranges** (List of String) A list of IP ranges of the location.
* - **self_link** (String) Full link to this resource. Can be referenced by other resources.
*
* <a id="nestedblock--geo"></a>
*
* ### `geo`
*
* Location geographical details
*
* - **lat** (Number) Latitude.
* - **lon** (Number) Longitude.
* - **country** (String) Country.
* - **state** (String) State.
* - **city** (String) City.
* - **continent** (String) Continent.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as cpln from "@pulumiverse/cpln";
*
* export = async () => {
* const locations = await cpln.getLocations({});
* return {
* locations: locations.locations,
* };
* }
* ```
*/
function getLocations(opts) {
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invoke("cpln:index/getLocations:getLocations", {}, opts);
}
exports.getLocations = getLocations;
/**
* Use this data source to access information about all [Locations](https://docs.controlplane.com/reference/location) within Control Plane.
*
* ## Outputs
*
* The following attributes are exported:
*
* - **locations** (Block List) (see below).
*
* <a id="nestedblock--locations"></a>
*
* ### `locations`
*
* - **cpln_id** (String) The ID, in GUID format, of the location.
* - **name** (String) Name of the location.
* - **description** (String) Description of the location.
* - **tags** (Map of String) Key-value map of resource tags.
* - **origin** (String) Origin of the location. Valid values: `builtin`, `default`, `custom`.
* - **cloud_provider** (String) Cloud Provider of the location. Valid values: `aws`, `gcp`, `azure`, `byok`, `linode`, `vultr`, `equinix`, `oci`.
* - **region** (String) Region of the location.
* - **enabled** (Boolean) Indication if location is enabled.
* - **geo** (Block List, Max: 1) (see below)
* - **ip_ranges** (List of String) A list of IP ranges of the location.
* - **self_link** (String) Full link to this resource. Can be referenced by other resources.
*
* <a id="nestedblock--geo"></a>
*
* ### `geo`
*
* Location geographical details
*
* - **lat** (Number) Latitude.
* - **lon** (Number) Longitude.
* - **country** (String) Country.
* - **state** (String) State.
* - **city** (String) City.
* - **continent** (String) Continent.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as cpln from "@pulumiverse/cpln";
*
* export = async () => {
* const locations = await cpln.getLocations({});
* return {
* locations: locations.locations,
* };
* }
* ```
*/
function getLocationsOutput(opts) {
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invokeOutput("cpln:index/getLocations:getLocations", {}, opts);
}
exports.getLocationsOutput = getLocationsOutput;
//# sourceMappingURL=getLocations.js.map