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

ibm.getIsVirtualEndpointGatewayIps

Explore with Pulumi AI

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

    Retrieve information of an existing IBM Cloud infrastructure virtual endpoint gateway IPs as a read only data source. For more information, about the VPC endpoint gateways, see about VPC gateways.

    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.getIsVirtualEndpointGatewayIps({
        gateway: ibm_is_virtual_endpoint_gateway.example.id,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.get_is_virtual_endpoint_gateway_ips(gateway=ibm_is_virtual_endpoint_gateway["example"]["id"])
    
    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.GetIsVirtualEndpointGatewayIps(ctx, &ibm.GetIsVirtualEndpointGatewayIpsArgs{
    			Gateway: ibm_is_virtual_endpoint_gateway.Example.Id,
    		}, 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.GetIsVirtualEndpointGatewayIps.Invoke(new()
        {
            Gateway = ibm_is_virtual_endpoint_gateway.Example.Id,
        });
    
    });
    
    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.GetIsVirtualEndpointGatewayIpsArgs;
    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.getIsVirtualEndpointGatewayIps(GetIsVirtualEndpointGatewayIpsArgs.builder()
                .gateway(ibm_is_virtual_endpoint_gateway.example().id())
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ibm:getIsVirtualEndpointGatewayIps
          arguments:
            gateway: ${ibm_is_virtual_endpoint_gateway.example.id}
    

    Using getIsVirtualEndpointGatewayIps

    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 getIsVirtualEndpointGatewayIps(args: GetIsVirtualEndpointGatewayIpsArgs, opts?: InvokeOptions): Promise<GetIsVirtualEndpointGatewayIpsResult>
    function getIsVirtualEndpointGatewayIpsOutput(args: GetIsVirtualEndpointGatewayIpsOutputArgs, opts?: InvokeOptions): Output<GetIsVirtualEndpointGatewayIpsResult>
    def get_is_virtual_endpoint_gateway_ips(gateway: Optional[str] = None,
                                            id: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetIsVirtualEndpointGatewayIpsResult
    def get_is_virtual_endpoint_gateway_ips_output(gateway: Optional[pulumi.Input[str]] = None,
                                            id: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetIsVirtualEndpointGatewayIpsResult]
    func GetIsVirtualEndpointGatewayIps(ctx *Context, args *GetIsVirtualEndpointGatewayIpsArgs, opts ...InvokeOption) (*GetIsVirtualEndpointGatewayIpsResult, error)
    func GetIsVirtualEndpointGatewayIpsOutput(ctx *Context, args *GetIsVirtualEndpointGatewayIpsOutputArgs, opts ...InvokeOption) GetIsVirtualEndpointGatewayIpsResultOutput

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

    public static class GetIsVirtualEndpointGatewayIps 
    {
        public static Task<GetIsVirtualEndpointGatewayIpsResult> InvokeAsync(GetIsVirtualEndpointGatewayIpsArgs args, InvokeOptions? opts = null)
        public static Output<GetIsVirtualEndpointGatewayIpsResult> Invoke(GetIsVirtualEndpointGatewayIpsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIsVirtualEndpointGatewayIpsResult> getIsVirtualEndpointGatewayIps(GetIsVirtualEndpointGatewayIpsArgs args, InvokeOptions options)
    public static Output<GetIsVirtualEndpointGatewayIpsResult> getIsVirtualEndpointGatewayIps(GetIsVirtualEndpointGatewayIpsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIsVirtualEndpointGatewayIps:getIsVirtualEndpointGatewayIps
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Gateway string
    The endpoint gateway ID.
    Id string
    (String) The IPs target ID.
    Gateway string
    The endpoint gateway ID.
    Id string
    (String) The IPs target ID.
    gateway String
    The endpoint gateway ID.
    id String
    (String) The IPs target ID.
    gateway string
    The endpoint gateway ID.
    id string
    (String) The IPs target ID.
    gateway str
    The endpoint gateway ID.
    id str
    (String) The IPs target ID.
    gateway String
    The endpoint gateway ID.
    id String
    (String) The IPs target ID.

    getIsVirtualEndpointGatewayIps Result

    The following output properties are available:

    Gateway string
    Id string
    (String) The IPs target ID.
    Ips List<GetIsVirtualEndpointGatewayIpsIp>
    (String) Endpoint gateway reserved IP id
    Gateway string
    Id string
    (String) The IPs target ID.
    Ips []GetIsVirtualEndpointGatewayIpsIp
    (String) Endpoint gateway reserved IP id
    gateway String
    id String
    (String) The IPs target ID.
    ips List<GetIsVirtualEndpointGatewayIpsIp>
    (String) Endpoint gateway reserved IP id
    gateway string
    id string
    (String) The IPs target ID.
    ips GetIsVirtualEndpointGatewayIpsIp[]
    (String) Endpoint gateway reserved IP id
    gateway str
    id str
    (String) The IPs target ID.
    ips Sequence[GetIsVirtualEndpointGatewayIpsIp]
    (String) Endpoint gateway reserved IP id
    gateway String
    id String
    (String) The IPs target ID.
    ips List<Property Map>
    (String) Endpoint gateway reserved IP id

    Supporting Types

    GetIsVirtualEndpointGatewayIpsIp

    Address string
    (String) The endpoint gateway IP address.
    AutoDelete bool
    (String) The endpoint gateway IP auto delete.
    CreatedAt string
    (Timestamp) The created date and time of the endpoint gateway IP.
    Name string
    (String) The IPs target name.
    ReservedIp string
    (String) The endpoint gateway reserved IP ID.
    ResourceType string
    (String) The endpoint gateway resource type.
    Targets List<GetIsVirtualEndpointGatewayIpsIpTarget>
    (List) The endpoint gateway target details.
    Address string
    (String) The endpoint gateway IP address.
    AutoDelete bool
    (String) The endpoint gateway IP auto delete.
    CreatedAt string
    (Timestamp) The created date and time of the endpoint gateway IP.
    Name string
    (String) The IPs target name.
    ReservedIp string
    (String) The endpoint gateway reserved IP ID.
    ResourceType string
    (String) The endpoint gateway resource type.
    Targets []GetIsVirtualEndpointGatewayIpsIpTarget
    (List) The endpoint gateway target details.
    address String
    (String) The endpoint gateway IP address.
    autoDelete Boolean
    (String) The endpoint gateway IP auto delete.
    createdAt String
    (Timestamp) The created date and time of the endpoint gateway IP.
    name String
    (String) The IPs target name.
    reservedIp String
    (String) The endpoint gateway reserved IP ID.
    resourceType String
    (String) The endpoint gateway resource type.
    targets List<GetIsVirtualEndpointGatewayIpsIpTarget>
    (List) The endpoint gateway target details.
    address string
    (String) The endpoint gateway IP address.
    autoDelete boolean
    (String) The endpoint gateway IP auto delete.
    createdAt string
    (Timestamp) The created date and time of the endpoint gateway IP.
    name string
    (String) The IPs target name.
    reservedIp string
    (String) The endpoint gateway reserved IP ID.
    resourceType string
    (String) The endpoint gateway resource type.
    targets GetIsVirtualEndpointGatewayIpsIpTarget[]
    (List) The endpoint gateway target details.
    address str
    (String) The endpoint gateway IP address.
    auto_delete bool
    (String) The endpoint gateway IP auto delete.
    created_at str
    (Timestamp) The created date and time of the endpoint gateway IP.
    name str
    (String) The IPs target name.
    reserved_ip str
    (String) The endpoint gateway reserved IP ID.
    resource_type str
    (String) The endpoint gateway resource type.
    targets Sequence[GetIsVirtualEndpointGatewayIpsIpTarget]
    (List) The endpoint gateway target details.
    address String
    (String) The endpoint gateway IP address.
    autoDelete Boolean
    (String) The endpoint gateway IP auto delete.
    createdAt String
    (Timestamp) The created date and time of the endpoint gateway IP.
    name String
    (String) The IPs target name.
    reservedIp String
    (String) The endpoint gateway reserved IP ID.
    resourceType String
    (String) The endpoint gateway resource type.
    targets List<Property Map>
    (List) The endpoint gateway target details.

    GetIsVirtualEndpointGatewayIpsIpTarget

    Id string
    (String) The IPs target ID.
    Name string
    (String) The IPs target name.
    ResourceType string
    (String) The endpoint gateway resource type.
    Id string
    (String) The IPs target ID.
    Name string
    (String) The IPs target name.
    ResourceType string
    (String) The endpoint gateway resource type.
    id String
    (String) The IPs target ID.
    name String
    (String) The IPs target name.
    resourceType String
    (String) The endpoint gateway resource type.
    id string
    (String) The IPs target ID.
    name string
    (String) The IPs target name.
    resourceType string
    (String) The endpoint gateway resource type.
    id str
    (String) The IPs target ID.
    name str
    (String) The IPs target name.
    resource_type str
    (String) The endpoint gateway resource type.
    id String
    (String) The IPs target ID.
    name String
    (String) The IPs target name.
    resourceType String
    (String) The endpoint gateway resource type.

    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