1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsRegion
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getIsRegion

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Retrieve information about a VPC Generation 2 Compute region as a read only data source. For more information, about managing IBM Cloud region, see creating a VPC in a different region.

    Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

    provider.tf

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const example = ibm.getIsRegion({
        name: "us-south",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.get_is_region(name="us-south")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.GetIsRegion(ctx, &ibm.GetIsRegionArgs{
    			Name: pulumi.StringRef("us-south"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Ibm.GetIsRegion.Invoke(new()
        {
            Name = "us-south",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetIsRegionArgs;
    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 example = IbmFunctions.getIsRegion(GetIsRegionArgs.builder()
                .name("us-south")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ibm:getIsRegion
          arguments:
            name: us-south
    
    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const defaultRegion = ibm.getIsRegion({});
    
    import pulumi
    import pulumi_ibm as ibm
    
    default_region = ibm.get_is_region()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.GetIsRegion(ctx, &ibm.GetIsRegionArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var defaultRegion = Ibm.GetIsRegion.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetIsRegionArgs;
    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 defaultRegion = IbmFunctions.getIsRegion();
    
        }
    }
    
    variables:
      defaultRegion:
        fn::invoke:
          function: ibm:getIsRegion
          arguments: {}
    

    Using getIsRegion

    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 getIsRegion(args: GetIsRegionArgs, opts?: InvokeOptions): Promise<GetIsRegionResult>
    function getIsRegionOutput(args: GetIsRegionOutputArgs, opts?: InvokeOptions): Output<GetIsRegionResult>
    def get_is_region(id: Optional[str] = None,
                      name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetIsRegionResult
    def get_is_region_output(id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetIsRegionResult]
    func GetIsRegion(ctx *Context, args *GetIsRegionArgs, opts ...InvokeOption) (*GetIsRegionResult, error)
    func GetIsRegionOutput(ctx *Context, args *GetIsRegionOutputArgs, opts ...InvokeOption) GetIsRegionResultOutput

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

    public static class GetIsRegion 
    {
        public static Task<GetIsRegionResult> InvokeAsync(GetIsRegionArgs args, InvokeOptions? opts = null)
        public static Output<GetIsRegionResult> Invoke(GetIsRegionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIsRegionResult> getIsRegion(GetIsRegionArgs args, InvokeOptions options)
    public static Output<GetIsRegionResult> getIsRegion(GetIsRegionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIsRegion:getIsRegion
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Name string
    The name of the region. If no name is provided then default region name is taken from the provider block.
    Id string
    Name string
    The name of the region. If no name is provided then default region name is taken from the provider block.
    id String
    name String
    The name of the region. If no name is provided then default region name is taken from the provider block.
    id string
    name string
    The name of the region. If no name is provided then default region name is taken from the provider block.
    id str
    name str
    The name of the region. If no name is provided then default region name is taken from the provider block.
    id String
    name String
    The name of the region. If no name is provided then default region name is taken from the provider block.

    getIsRegion Result

    The following output properties are available:

    Endpoint string
    (String) The endpoint of the region.
    Id string
    Status string
    (String) The status of the region.
    Name string
    Endpoint string
    (String) The endpoint of the region.
    Id string
    Status string
    (String) The status of the region.
    Name string
    endpoint String
    (String) The endpoint of the region.
    id String
    status String
    (String) The status of the region.
    name String
    endpoint string
    (String) The endpoint of the region.
    id string
    status string
    (String) The status of the region.
    name string
    endpoint str
    (String) The endpoint of the region.
    id str
    status str
    (String) The status of the region.
    name str
    endpoint String
    (String) The endpoint of the region.
    id String
    status String
    (String) The status of the region.
    name String

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud