1. Packages
  2. Hcloud Provider
  3. API Docs
  4. getLocation
Hetzner Cloud v1.21.0 published on Tuesday, Nov 12, 2024 by Pulumi

hcloud.getLocation

Explore with Pulumi AI

hcloud logo
Hetzner Cloud v1.21.0 published on Tuesday, Nov 12, 2024 by Pulumi

    Provides details about a specific Hetzner Cloud Location. Use this resource to get detailed information about specific location.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as hcloud from "@pulumi/hcloud";
    
    const l1 = hcloud.getLocation({
        name: "fsn1",
    });
    const l2 = hcloud.getLocation({
        id: 1,
    });
    
    import pulumi
    import pulumi_hcloud as hcloud
    
    l1 = hcloud.get_location(name="fsn1")
    l2 = hcloud.get_location(id=1)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-hcloud/sdk/go/hcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := hcloud.GetLocation(ctx, &hcloud.GetLocationArgs{
    			Name: pulumi.StringRef("fsn1"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = hcloud.GetLocation(ctx, &hcloud.GetLocationArgs{
    			Id: pulumi.IntRef(1),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using HCloud = Pulumi.HCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var l1 = HCloud.GetLocation.Invoke(new()
        {
            Name = "fsn1",
        });
    
        var l2 = HCloud.GetLocation.Invoke(new()
        {
            Id = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hcloud.HcloudFunctions;
    import com.pulumi.hcloud.inputs.GetLocationArgs;
    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 l1 = HcloudFunctions.getLocation(GetLocationArgs.builder()
                .name("fsn1")
                .build());
    
            final var l2 = HcloudFunctions.getLocation(GetLocationArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      l1:
        fn::invoke:
          Function: hcloud:getLocation
          Arguments:
            name: fsn1
      l2:
        fn::invoke:
          Function: hcloud:getLocation
          Arguments:
            id: 1
    

    Using getLocation

    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 getLocation(args: GetLocationArgs, opts?: InvokeOptions): Promise<GetLocationResult>
    function getLocationOutput(args: GetLocationOutputArgs, opts?: InvokeOptions): Output<GetLocationResult>
    def get_location(id: Optional[int] = None,
                     name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetLocationResult
    def get_location_output(id: Optional[pulumi.Input[int]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetLocationResult]
    func GetLocation(ctx *Context, args *GetLocationArgs, opts ...InvokeOption) (*GetLocationResult, error)
    func GetLocationOutput(ctx *Context, args *GetLocationOutputArgs, opts ...InvokeOption) GetLocationResultOutput

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

    public static class GetLocation 
    {
        public static Task<GetLocationResult> InvokeAsync(GetLocationArgs args, InvokeOptions? opts = null)
        public static Output<GetLocationResult> Invoke(GetLocationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLocationResult> getLocation(GetLocationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: hcloud:index/getLocation:getLocation
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id int
    ID of the location.
    Name string
    Name of the location.
    Id int
    ID of the location.
    Name string
    Name of the location.
    id Integer
    ID of the location.
    name String
    Name of the location.
    id number
    ID of the location.
    name string
    Name of the location.
    id int
    ID of the location.
    name str
    Name of the location.
    id Number
    ID of the location.
    name String
    Name of the location.

    getLocation Result

    The following output properties are available:

    City string
    (string) City of the location.
    Country string
    (string) Country of the location.
    Description string
    (string) Description of the location.
    Id int
    (int) Unique ID of the location.
    Latitude double
    (float) Latitude of the city.
    Longitude double
    (float) Longitude of the city.
    Name string
    (string) Name of the location.
    NetworkZone string
    (string) Network Zone of the location.
    City string
    (string) City of the location.
    Country string
    (string) Country of the location.
    Description string
    (string) Description of the location.
    Id int
    (int) Unique ID of the location.
    Latitude float64
    (float) Latitude of the city.
    Longitude float64
    (float) Longitude of the city.
    Name string
    (string) Name of the location.
    NetworkZone string
    (string) Network Zone of the location.
    city String
    (string) City of the location.
    country String
    (string) Country of the location.
    description String
    (string) Description of the location.
    id Integer
    (int) Unique ID of the location.
    latitude Double
    (float) Latitude of the city.
    longitude Double
    (float) Longitude of the city.
    name String
    (string) Name of the location.
    networkZone String
    (string) Network Zone of the location.
    city string
    (string) City of the location.
    country string
    (string) Country of the location.
    description string
    (string) Description of the location.
    id number
    (int) Unique ID of the location.
    latitude number
    (float) Latitude of the city.
    longitude number
    (float) Longitude of the city.
    name string
    (string) Name of the location.
    networkZone string
    (string) Network Zone of the location.
    city str
    (string) City of the location.
    country str
    (string) Country of the location.
    description str
    (string) Description of the location.
    id int
    (int) Unique ID of the location.
    latitude float
    (float) Latitude of the city.
    longitude float
    (float) Longitude of the city.
    name str
    (string) Name of the location.
    network_zone str
    (string) Network Zone of the location.
    city String
    (string) City of the location.
    country String
    (string) Country of the location.
    description String
    (string) Description of the location.
    id Number
    (int) Unique ID of the location.
    latitude Number
    (float) Latitude of the city.
    longitude Number
    (float) Longitude of the city.
    name String
    (string) Name of the location.
    networkZone String
    (string) Network Zone of the location.

    Package Details

    Repository
    Hetzner Cloud pulumi/pulumi-hcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the hcloud Terraform Provider.
    hcloud logo
    Hetzner Cloud v1.21.0 published on Tuesday, Nov 12, 2024 by Pulumi