Control Plane v0.0.55, Mar 27 25

Control Plane v0.0.55 published on Thursday, Mar 27, 2025 by pulumiverse

cpln.getLocations

Explore with Pulumi AI

Control Plane v0.0.55 published on Thursday, Mar 27, 2025 by pulumiverse

pulumiverse/pulumi-cpln

Outputs

The following attributes are exported:

locations (Block List) (see below).

`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.
cloud_provider (String) Cloud Provider of the location.
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.

`geo`

Location geographical details

lat (Number) Latitude.
lon (Number) Longitude.
country (String) Country.
state (String) State.
city (String) City.
continent (String) Continent.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cpln from "@pulumi/cpln";

const locationsLocations = cpln.getLocations({});
export const locations = locationsLocations.then(locationsLocations => locationsLocations.locations);

import pulumi
import pulumi_cpln as cpln

locations_locations = cpln.get_locations()
pulumi.export("locations", locations_locations.locations)

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-cpln/sdk/go/cpln"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		locationsLocations, err := cpln.GetLocations(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		ctx.Export("locations", locationsLocations.Locations)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cpln = Pulumi.Cpln;

return await Deployment.RunAsync(() => 
{
    var locationsLocations = Cpln.GetLocations.Invoke();

    return new Dictionary<string, object?>
    {
        ["locations"] = locationsLocations.Apply(getLocationsResult => getLocationsResult.Locations),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cpln.CplnFunctions;
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 locationsLocations = CplnFunctions.getLocations();

        ctx.export("locations", locationsLocations.applyValue(getLocationsResult -> getLocationsResult.locations()));
    }
}

variables:
  locationsLocations:
    fn::invoke:
      function: cpln:getLocations
      arguments: {}
outputs:
  locations: ${locationsLocations.locations}

Using getLocations

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getLocations(opts?: InvokeOptions): Promise<GetLocationsResult>
function getLocationsOutput(opts?: InvokeOptions): Output<GetLocationsResult>

def get_locations(opts: Optional[InvokeOptions] = None) -> GetLocationsResult
def get_locations_output(opts: Optional[InvokeOptions] = None) -> Output[GetLocationsResult]

func GetLocations(ctx *Context, opts ...InvokeOption) (*GetLocationsResult, error)
func GetLocationsOutput(ctx *Context, opts ...InvokeOption) GetLocationsResultOutput

> Note: This function is named GetLocations in the Go SDK.

public static class GetLocations 
{
    public static Task<GetLocationsResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetLocationsResult> Invoke(InvokeOptions? opts = null)
}

public static CompletableFuture<GetLocationsResult> getLocations(InvokeOptions options)
public static Output<GetLocationsResult> getLocations(InvokeOptions options)

fn::invoke:
  function: cpln:index/getLocations:getLocations
  arguments:
    # arguments dictionary

getLocations Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Locations List<Pulumiverse.Cpln.Outputs.GetLocationsLocation>

Id string: The provider-assigned unique ID for this managed resource.
Locations []GetLocationsLocation

id String: The provider-assigned unique ID for this managed resource.
locations List<GetLocationsLocation>

id string: The provider-assigned unique ID for this managed resource.
locations GetLocationsLocation[]

id str: The provider-assigned unique ID for this managed resource.
locations Sequence[GetLocationsLocation]

id String: The provider-assigned unique ID for this managed resource.
locations List<Property Map>

Supporting Types

GetLocationsLocation

CloudProvider string: Cloud Provider of the location.
CplnId string: The ID, in GUID format, of the location.
Description string: Description of the location.
Enabled bool: Indication if location is enabled.
Geos List<Pulumiverse.Cpln.Inputs.GetLocationsLocationGeo>
IpRanges List<string>: A list of IP ranges of the location.
Name string: Name of the location.
Region string: Region of the location.
SelfLink string: Full link to this resource. Can be referenced by other resources.
Tags Dictionary<string, string>: Key-value map of resource tags.

CloudProvider string: Cloud Provider of the location.
CplnId string: The ID, in GUID format, of the location.
Description string: Description of the location.
Enabled bool: Indication if location is enabled.
Geos []GetLocationsLocationGeo
IpRanges []string: A list of IP ranges of the location.
Name string: Name of the location.
Region string: Region of the location.
SelfLink string: Full link to this resource. Can be referenced by other resources.
Tags map[string]string: Key-value map of resource tags.

cloudProvider String: Cloud Provider of the location.
cplnId String: The ID, in GUID format, of the location.
description String: Description of the location.
enabled Boolean: Indication if location is enabled.
geos List<GetLocationsLocationGeo>
ipRanges List<String>: A list of IP ranges of the location.
name String: Name of the location.
region String: Region of the location.
selfLink String: Full link to this resource. Can be referenced by other resources.
tags Map<String,String>: Key-value map of resource tags.

cloudProvider string: Cloud Provider of the location.
cplnId string: The ID, in GUID format, of the location.
description string: Description of the location.
enabled boolean: Indication if location is enabled.
geos GetLocationsLocationGeo[]
ipRanges string[]: A list of IP ranges of the location.
name string: Name of the location.
region string: Region of the location.
selfLink string: Full link to this resource. Can be referenced by other resources.
tags {[key: string]: string}: Key-value map of resource tags.

cloud_provider str: Cloud Provider of the location.
cpln_id str: The ID, in GUID format, of the location.
description str: Description of the location.
enabled bool: Indication if location is enabled.
geos Sequence[GetLocationsLocationGeo]
ip_ranges Sequence[str]: A list of IP ranges of the location.
name str: Name of the location.
region str: Region of the location.
self_link str: Full link to this resource. Can be referenced by other resources.
tags Mapping[str, str]: Key-value map of resource tags.

cloudProvider String: Cloud Provider of the location.
cplnId String: The ID, in GUID format, of the location.
description String: Description of the location.
enabled Boolean: Indication if location is enabled.
geos List<Property Map>
ipRanges List<String>: A list of IP ranges of the location.
name String: Name of the location.
region String: Region of the location.
selfLink String: Full link to this resource. Can be referenced by other resources.
tags Map<String>: Key-value map of resource tags.

GetLocationsLocationGeo

City string: City.
Continent string: Continent.
Country string: Country.
Lat double: Latitude.
Lon double: Longitude.
State string: State.

City string: City.
Continent string: Continent.
Country string: Country.
Lat float64: Latitude.
Lon float64: Longitude.
State string: State.

city String: City.
continent String: Continent.
country String: Country.
lat Double: Latitude.
lon Double: Longitude.
state String: State.

city string: City.
continent string: Continent.
country string: Country.
lat number: Latitude.
lon number: Longitude.
state string: State.

city str: City.
continent str: Continent.
country str: Country.
lat float: Latitude.
lon float: Longitude.
state str: State.

city String: City.
continent String: Continent.
country String: Country.
lat Number: Latitude.
lon Number: Longitude.
state String: State.

Package Details

Repository: cpln pulumiverse/pulumi-cpln
License: Apache-2.0
Notes: This Pulumi package is based on the cpln Terraform Provider.

Control Plane v0.0.55 published on Thursday, Mar 27, 2025 by pulumiverse

pulumiverse/pulumi-cpln

cpln.getLocations

On this page

On this page

Outputs

`locations`

`geo`

Example Usage

Using getLocations

getLocations Result

Supporting Types

GetLocationsLocation

GetLocationsLocationGeo

Package Details

On this page

On this page