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

ibm.getIsPublicGateways

Explore with Pulumi AI

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

    Retrieve information of an existing public gateways as a read only data source. For more information, about an VPC public gateway, see about networking.

    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.getIsPublicGateways({});
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.get_is_public_gateways()
    
    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.GetIsPublicGateways(ctx, &ibm.GetIsPublicGatewaysArgs{}, 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.GetIsPublicGateways.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.GetIsPublicGatewaysArgs;
    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.getIsPublicGateways();
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ibm:getIsPublicGateways
          arguments: {}
    

    Using getIsPublicGateways

    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 getIsPublicGateways(args: GetIsPublicGatewaysArgs, opts?: InvokeOptions): Promise<GetIsPublicGatewaysResult>
    function getIsPublicGatewaysOutput(args: GetIsPublicGatewaysOutputArgs, opts?: InvokeOptions): Output<GetIsPublicGatewaysResult>
    def get_is_public_gateways(id: Optional[str] = None,
                               resource_group: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetIsPublicGatewaysResult
    def get_is_public_gateways_output(id: Optional[pulumi.Input[str]] = None,
                               resource_group: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetIsPublicGatewaysResult]
    func GetIsPublicGateways(ctx *Context, args *GetIsPublicGatewaysArgs, opts ...InvokeOption) (*GetIsPublicGatewaysResult, error)
    func GetIsPublicGatewaysOutput(ctx *Context, args *GetIsPublicGatewaysOutputArgs, opts ...InvokeOption) GetIsPublicGatewaysResultOutput

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

    public static class GetIsPublicGateways 
    {
        public static Task<GetIsPublicGatewaysResult> InvokeAsync(GetIsPublicGatewaysArgs args, InvokeOptions? opts = null)
        public static Output<GetIsPublicGatewaysResult> Invoke(GetIsPublicGatewaysInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIsPublicGatewaysResult> getIsPublicGateways(GetIsPublicGatewaysArgs args, InvokeOptions options)
    public static Output<GetIsPublicGatewaysResult> getIsPublicGateways(GetIsPublicGatewaysArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIsPublicGateways:getIsPublicGateways
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    (String) ID of the floating ip bound to the public gateway.
    ResourceGroup string
    The ID of the Resource group this public gateway belongs to.
    Id string
    (String) ID of the floating ip bound to the public gateway.
    ResourceGroup string
    The ID of the Resource group this public gateway belongs to.
    id String
    (String) ID of the floating ip bound to the public gateway.
    resourceGroup String
    The ID of the Resource group this public gateway belongs to.
    id string
    (String) ID of the floating ip bound to the public gateway.
    resourceGroup string
    The ID of the Resource group this public gateway belongs to.
    id str
    (String) ID of the floating ip bound to the public gateway.
    resource_group str
    The ID of the Resource group this public gateway belongs to.
    id String
    (String) ID of the floating ip bound to the public gateway.
    resourceGroup String
    The ID of the Resource group this public gateway belongs to.

    getIsPublicGateways Result

    The following output properties are available:

    Id string
    (String) ID of the floating ip bound to the public gateway.
    PublicGateways List<GetIsPublicGatewaysPublicGateway>
    (List) List of all Public Gateways in the IBM Cloud infrastructure region.
    ResourceGroup string
    Id string
    (String) ID of the floating ip bound to the public gateway.
    PublicGateways []GetIsPublicGatewaysPublicGateway
    (List) List of all Public Gateways in the IBM Cloud infrastructure region.
    ResourceGroup string
    id String
    (String) ID of the floating ip bound to the public gateway.
    publicGateways List<GetIsPublicGatewaysPublicGateway>
    (List) List of all Public Gateways in the IBM Cloud infrastructure region.
    resourceGroup String
    id string
    (String) ID of the floating ip bound to the public gateway.
    publicGateways GetIsPublicGatewaysPublicGateway[]
    (List) List of all Public Gateways in the IBM Cloud infrastructure region.
    resourceGroup string
    id str
    (String) ID of the floating ip bound to the public gateway.
    public_gateways Sequence[GetIsPublicGatewaysPublicGateway]
    (List) List of all Public Gateways in the IBM Cloud infrastructure region.
    resource_group str
    id String
    (String) ID of the floating ip bound to the public gateway.
    publicGateways List<Property Map>
    (List) List of all Public Gateways in the IBM Cloud infrastructure region.
    resourceGroup String

    Supporting Types

    GetIsPublicGatewaysPublicGateway

    AccessTags List<string>
    (List) Access management tags associated for the public gateway.
    Crn string
    (String) The CRN for this public gateway.
    FloatingIp Dictionary<string, string>
    (List) A nested block describing the floating IP of the public gateway.
    Id string
    (String) ID of the floating ip bound to the public gateway.
    Name string
    (String) The name of the public gateway.
    ResourceControllerUrl string
    ResourceCrn string
    ResourceGroup string
    The ID of the Resource group this public gateway belongs to.
    ResourceGroupName string
    ResourceName string
    ResourceStatus string
    Status string
    (String) The status of the public gateway.
    Tags List<string>
    (String) Tags associated with the public gateway.
    Vpc string
    (String) The VPC ID of the public gateway.
    Zone string
    (String) The public gateway zone name.
    AccessTags []string
    (List) Access management tags associated for the public gateway.
    Crn string
    (String) The CRN for this public gateway.
    FloatingIp map[string]string
    (List) A nested block describing the floating IP of the public gateway.
    Id string
    (String) ID of the floating ip bound to the public gateway.
    Name string
    (String) The name of the public gateway.
    ResourceControllerUrl string
    ResourceCrn string
    ResourceGroup string
    The ID of the Resource group this public gateway belongs to.
    ResourceGroupName string
    ResourceName string
    ResourceStatus string
    Status string
    (String) The status of the public gateway.
    Tags []string
    (String) Tags associated with the public gateway.
    Vpc string
    (String) The VPC ID of the public gateway.
    Zone string
    (String) The public gateway zone name.
    accessTags List<String>
    (List) Access management tags associated for the public gateway.
    crn String
    (String) The CRN for this public gateway.
    floatingIp Map<String,String>
    (List) A nested block describing the floating IP of the public gateway.
    id String
    (String) ID of the floating ip bound to the public gateway.
    name String
    (String) The name of the public gateway.
    resourceControllerUrl String
    resourceCrn String
    resourceGroup String
    The ID of the Resource group this public gateway belongs to.
    resourceGroupName String
    resourceName String
    resourceStatus String
    status String
    (String) The status of the public gateway.
    tags List<String>
    (String) Tags associated with the public gateway.
    vpc String
    (String) The VPC ID of the public gateway.
    zone String
    (String) The public gateway zone name.
    accessTags string[]
    (List) Access management tags associated for the public gateway.
    crn string
    (String) The CRN for this public gateway.
    floatingIp {[key: string]: string}
    (List) A nested block describing the floating IP of the public gateway.
    id string
    (String) ID of the floating ip bound to the public gateway.
    name string
    (String) The name of the public gateway.
    resourceControllerUrl string
    resourceCrn string
    resourceGroup string
    The ID of the Resource group this public gateway belongs to.
    resourceGroupName string
    resourceName string
    resourceStatus string
    status string
    (String) The status of the public gateway.
    tags string[]
    (String) Tags associated with the public gateway.
    vpc string
    (String) The VPC ID of the public gateway.
    zone string
    (String) The public gateway zone name.
    access_tags Sequence[str]
    (List) Access management tags associated for the public gateway.
    crn str
    (String) The CRN for this public gateway.
    floating_ip Mapping[str, str]
    (List) A nested block describing the floating IP of the public gateway.
    id str
    (String) ID of the floating ip bound to the public gateway.
    name str
    (String) The name of the public gateway.
    resource_controller_url str
    resource_crn str
    resource_group str
    The ID of the Resource group this public gateway belongs to.
    resource_group_name str
    resource_name str
    resource_status str
    status str
    (String) The status of the public gateway.
    tags Sequence[str]
    (String) Tags associated with the public gateway.
    vpc str
    (String) The VPC ID of the public gateway.
    zone str
    (String) The public gateway zone name.
    accessTags List<String>
    (List) Access management tags associated for the public gateway.
    crn String
    (String) The CRN for this public gateway.
    floatingIp Map<String>
    (List) A nested block describing the floating IP of the public gateway.
    id String
    (String) ID of the floating ip bound to the public gateway.
    name String
    (String) The name of the public gateway.
    resourceControllerUrl String
    resourceCrn String
    resourceGroup String
    The ID of the Resource group this public gateway belongs to.
    resourceGroupName String
    resourceName String
    resourceStatus String
    status String
    (String) The status of the public gateway.
    tags List<String>
    (String) Tags associated with the public gateway.
    vpc String
    (String) The VPC ID of the public gateway.
    zone String
    (String) The public gateway zone name.

    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