1. Packages
  2. Linode
  3. API Docs
  4. getRegion
Linode v4.23.0 published on Thursday, Jul 18, 2024 by Pulumi

linode.getRegion

Explore with Pulumi AI

linode logo
Linode v4.23.0 published on Thursday, Jul 18, 2024 by Pulumi

    linode.getRegion provides details about a specific Linode region. See all regions here. For more information, see the Linode APIv4 docs.

    Example Usage

    The following example shows how the resource might be used to obtain additional information about a Linode region.

    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    
    const region = linode.getRegion({
        id: "us-east",
    });
    
    import pulumi
    import pulumi_linode as linode
    
    region = linode.get_region(id="us-east")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := linode.GetRegion(ctx, &linode.GetRegionArgs{
    			Id: "us-east",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Linode = Pulumi.Linode;
    
    return await Deployment.RunAsync(() => 
    {
        var region = Linode.GetRegion.Invoke(new()
        {
            Id = "us-east",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.linode.LinodeFunctions;
    import com.pulumi.linode.inputs.GetRegionArgs;
    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 region = LinodeFunctions.getRegion(GetRegionArgs.builder()
                .id("us-east")
                .build());
    
        }
    }
    
    variables:
      region:
        fn::invoke:
          Function: linode:getRegion
          Arguments:
            id: us-east
    

    Using getRegion

    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 getRegion(args: GetRegionArgs, opts?: InvokeOptions): Promise<GetRegionResult>
    function getRegionOutput(args: GetRegionOutputArgs, opts?: InvokeOptions): Output<GetRegionResult>
    def get_region(id: Optional[str] = None,
                   resolvers: Optional[Sequence[GetRegionResolver]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetRegionResult
    def get_region_output(id: Optional[pulumi.Input[str]] = None,
                   resolvers: Optional[pulumi.Input[Sequence[pulumi.Input[GetRegionResolverArgs]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetRegionResult]
    func GetRegion(ctx *Context, args *GetRegionArgs, opts ...InvokeOption) (*GetRegionResult, error)
    func GetRegionOutput(ctx *Context, args *GetRegionOutputArgs, opts ...InvokeOption) GetRegionResultOutput

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

    public static class GetRegion 
    {
        public static Task<GetRegionResult> InvokeAsync(GetRegionArgs args, InvokeOptions? opts = null)
        public static Output<GetRegionResult> Invoke(GetRegionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRegionResult> getRegion(GetRegionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: linode:index/getRegion:getRegion
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The code name of the region to select.
    Resolvers List<GetRegionResolver>
    Id string
    The code name of the region to select.
    Resolvers []GetRegionResolver
    id String
    The code name of the region to select.
    resolvers List<GetRegionResolver>
    id string
    The code name of the region to select.
    resolvers GetRegionResolver[]
    id str
    The code name of the region to select.
    resolvers Sequence[GetRegionResolver]
    id String
    The code name of the region to select.
    resolvers List<Property Map>

    getRegion Result

    The following output properties are available:

    Capabilities List<string>
    A list of capabilities of this region.
    Country string
    The country the region resides in.
    Id string
    Label string
    Detailed location information for this Region, including city, state or region, and country.
    PlacementGroupLimits List<GetRegionPlacementGroupLimit>
    SiteType string
    The type of this region.
    Status string
    This region’s current operational status (ok or outage).
    Resolvers List<GetRegionResolver>
    Capabilities []string
    A list of capabilities of this region.
    Country string
    The country the region resides in.
    Id string
    Label string
    Detailed location information for this Region, including city, state or region, and country.
    PlacementGroupLimits []GetRegionPlacementGroupLimit
    SiteType string
    The type of this region.
    Status string
    This region’s current operational status (ok or outage).
    Resolvers []GetRegionResolver
    capabilities List<String>
    A list of capabilities of this region.
    country String
    The country the region resides in.
    id String
    label String
    Detailed location information for this Region, including city, state or region, and country.
    placementGroupLimits List<GetRegionPlacementGroupLimit>
    siteType String
    The type of this region.
    status String
    This region’s current operational status (ok or outage).
    resolvers List<GetRegionResolver>
    capabilities string[]
    A list of capabilities of this region.
    country string
    The country the region resides in.
    id string
    label string
    Detailed location information for this Region, including city, state or region, and country.
    placementGroupLimits GetRegionPlacementGroupLimit[]
    siteType string
    The type of this region.
    status string
    This region’s current operational status (ok or outage).
    resolvers GetRegionResolver[]
    capabilities Sequence[str]
    A list of capabilities of this region.
    country str
    The country the region resides in.
    id str
    label str
    Detailed location information for this Region, including city, state or region, and country.
    placement_group_limits Sequence[GetRegionPlacementGroupLimit]
    site_type str
    The type of this region.
    status str
    This region’s current operational status (ok or outage).
    resolvers Sequence[GetRegionResolver]
    capabilities List<String>
    A list of capabilities of this region.
    country String
    The country the region resides in.
    id String
    label String
    Detailed location information for this Region, including city, state or region, and country.
    placementGroupLimits List<Property Map>
    siteType String
    The type of this region.
    status String
    This region’s current operational status (ok or outage).
    resolvers List<Property Map>

    Supporting Types

    GetRegionPlacementGroupLimit

    MaximumLinodesPerPg int
    The maximum number of Linodes allowed to be assigned to a placement group in this region.
    MaximumPgsPerCustomer int
    The maximum number of placement groups allowed for the current user in this region.
    MaximumLinodesPerPg int
    The maximum number of Linodes allowed to be assigned to a placement group in this region.
    MaximumPgsPerCustomer int
    The maximum number of placement groups allowed for the current user in this region.
    maximumLinodesPerPg Integer
    The maximum number of Linodes allowed to be assigned to a placement group in this region.
    maximumPgsPerCustomer Integer
    The maximum number of placement groups allowed for the current user in this region.
    maximumLinodesPerPg number
    The maximum number of Linodes allowed to be assigned to a placement group in this region.
    maximumPgsPerCustomer number
    The maximum number of placement groups allowed for the current user in this region.
    maximum_linodes_per_pg int
    The maximum number of Linodes allowed to be assigned to a placement group in this region.
    maximum_pgs_per_customer int
    The maximum number of placement groups allowed for the current user in this region.
    maximumLinodesPerPg Number
    The maximum number of Linodes allowed to be assigned to a placement group in this region.
    maximumPgsPerCustomer Number
    The maximum number of placement groups allowed for the current user in this region.

    GetRegionResolver

    Ipv4 string
    The IPv4 addresses for this region’s DNS resolvers, separated by commas.
    Ipv6 string
    The IPv6 addresses for this region’s DNS resolvers, separated by commas.
    Ipv4 string
    The IPv4 addresses for this region’s DNS resolvers, separated by commas.
    Ipv6 string
    The IPv6 addresses for this region’s DNS resolvers, separated by commas.
    ipv4 String
    The IPv4 addresses for this region’s DNS resolvers, separated by commas.
    ipv6 String
    The IPv6 addresses for this region’s DNS resolvers, separated by commas.
    ipv4 string
    The IPv4 addresses for this region’s DNS resolvers, separated by commas.
    ipv6 string
    The IPv6 addresses for this region’s DNS resolvers, separated by commas.
    ipv4 str
    The IPv4 addresses for this region’s DNS resolvers, separated by commas.
    ipv6 str
    The IPv6 addresses for this region’s DNS resolvers, separated by commas.
    ipv4 String
    The IPv4 addresses for this region’s DNS resolvers, separated by commas.
    ipv6 String
    The IPv6 addresses for this region’s DNS resolvers, separated by commas.

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.23.0 published on Thursday, Jul 18, 2024 by Pulumi