Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsVirtualEndpointGateway
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getIsVirtualEndpointGateway

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

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

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";
Copy
import pulumi
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
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) {
    }
}
Copy
{}
Copy

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const example = ibm.getIsVirtualEndpointGateway({
    name: ibm_is_virtual_endpoint_gateway.example.name,
});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_virtual_endpoint_gateway(name=ibm_is_virtual_endpoint_gateway["example"]["name"])
Copy
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.LookupIsVirtualEndpointGateway(ctx, &ibm.LookupIsVirtualEndpointGatewayArgs{
			Name: ibm_is_virtual_endpoint_gateway.Example.Name,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = Ibm.GetIsVirtualEndpointGateway.Invoke(new()
    {
        Name = ibm_is_virtual_endpoint_gateway.Example.Name,
    });

});
Copy
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.GetIsVirtualEndpointGatewayArgs;
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.getIsVirtualEndpointGateway(GetIsVirtualEndpointGatewayArgs.builder()
            .name(ibm_is_virtual_endpoint_gateway.example().name())
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: ibm:getIsVirtualEndpointGateway
      arguments:
        name: ${ibm_is_virtual_endpoint_gateway.example.name}
Copy

Using getIsVirtualEndpointGateway

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 getIsVirtualEndpointGateway(args: GetIsVirtualEndpointGatewayArgs, opts?: InvokeOptions): Promise<GetIsVirtualEndpointGatewayResult>
function getIsVirtualEndpointGatewayOutput(args: GetIsVirtualEndpointGatewayOutputArgs, opts?: InvokeOptions): Output<GetIsVirtualEndpointGatewayResult>
Copy
def get_is_virtual_endpoint_gateway(id: Optional[str] = None,
                                    name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetIsVirtualEndpointGatewayResult
def get_is_virtual_endpoint_gateway_output(id: Optional[pulumi.Input[str]] = None,
                                    name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetIsVirtualEndpointGatewayResult]
Copy
func LookupIsVirtualEndpointGateway(ctx *Context, args *LookupIsVirtualEndpointGatewayArgs, opts ...InvokeOption) (*LookupIsVirtualEndpointGatewayResult, error)
func LookupIsVirtualEndpointGatewayOutput(ctx *Context, args *LookupIsVirtualEndpointGatewayOutputArgs, opts ...InvokeOption) LookupIsVirtualEndpointGatewayResultOutput
Copy

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

public static class GetIsVirtualEndpointGateway 
{
    public static Task<GetIsVirtualEndpointGatewayResult> InvokeAsync(GetIsVirtualEndpointGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetIsVirtualEndpointGatewayResult> Invoke(GetIsVirtualEndpointGatewayInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIsVirtualEndpointGatewayResult> getIsVirtualEndpointGateway(GetIsVirtualEndpointGatewayArgs args, InvokeOptions options)
public static Output<GetIsVirtualEndpointGatewayResult> getIsVirtualEndpointGateway(GetIsVirtualEndpointGatewayArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getIsVirtualEndpointGateway:getIsVirtualEndpointGateway
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The endpoint gateway name.
Id string
(String) The collection of reserved IPs bound to an endpoint gateway.
Name This property is required. string
The endpoint gateway name.
Id string
(String) The collection of reserved IPs bound to an endpoint gateway.
name This property is required. String
The endpoint gateway name.
id String
(String) The collection of reserved IPs bound to an endpoint gateway.
name This property is required. string
The endpoint gateway name.
id string
(String) The collection of reserved IPs bound to an endpoint gateway.
name This property is required. str
The endpoint gateway name.
id str
(String) The collection of reserved IPs bound to an endpoint gateway.
name This property is required. String
The endpoint gateway name.
id String
(String) The collection of reserved IPs bound to an endpoint gateway.

getIsVirtualEndpointGateway Result

The following output properties are available:

AccessTags List<string>
(List) Access management tags associated for the virtual endpoint gateway.
AllowDnsResolutionBinding bool
(Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
CreatedAt string
(Timestamp) The created date and time of the endpoint gateway.
Crn string
(String) The target CRN.
HealthState string
(String) Endpoint gateway health state. ok: Healthy, degraded: Suffering from compromised performance, capacity, or connectivity, faulted: Completely unreachable, inoperative, or entirely incapacitated, inapplicable: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state.
Id string
(String) The collection of reserved IPs bound to an endpoint gateway.
Ips List<GetIsVirtualEndpointGatewayIp>
(List) The unique identifier for the reserved IP.
LifecycleReasons List<GetIsVirtualEndpointGatewayLifecycleReason>
LifecycleState string
(String) The endpoint gateway lifecycle state, supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
Name string
(String) The target name.
ResourceGroup string
(String) The unique identifier for the resource group.
ResourceType string
(String) The resource type of the subnet reserved IP.
SecurityGroups List<string>
(List) - The security groups to use for this endpoint gateway.
ServiceEndpoints List<string>
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
Tags List<string>
Targets List<GetIsVirtualEndpointGatewayTarget>
(List) The endpoint gateway target.
Vpc string
(String) The VPC ID.
AccessTags []string
(List) Access management tags associated for the virtual endpoint gateway.
AllowDnsResolutionBinding bool
(Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
CreatedAt string
(Timestamp) The created date and time of the endpoint gateway.
Crn string
(String) The target CRN.
HealthState string
(String) Endpoint gateway health state. ok: Healthy, degraded: Suffering from compromised performance, capacity, or connectivity, faulted: Completely unreachable, inoperative, or entirely incapacitated, inapplicable: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state.
Id string
(String) The collection of reserved IPs bound to an endpoint gateway.
Ips []GetIsVirtualEndpointGatewayIpType
(List) The unique identifier for the reserved IP.
LifecycleReasons []GetIsVirtualEndpointGatewayLifecycleReason
LifecycleState string
(String) The endpoint gateway lifecycle state, supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
Name string
(String) The target name.
ResourceGroup string
(String) The unique identifier for the resource group.
ResourceType string
(String) The resource type of the subnet reserved IP.
SecurityGroups []string
(List) - The security groups to use for this endpoint gateway.
ServiceEndpoints []string
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
Tags []string
Targets []GetIsVirtualEndpointGatewayTarget
(List) The endpoint gateway target.
Vpc string
(String) The VPC ID.
accessTags List<String>
(List) Access management tags associated for the virtual endpoint gateway.
allowDnsResolutionBinding Boolean
(Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
createdAt String
(Timestamp) The created date and time of the endpoint gateway.
crn String
(String) The target CRN.
healthState String
(String) Endpoint gateway health state. ok: Healthy, degraded: Suffering from compromised performance, capacity, or connectivity, faulted: Completely unreachable, inoperative, or entirely incapacitated, inapplicable: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state.
id String
(String) The collection of reserved IPs bound to an endpoint gateway.
ips List<GetIsVirtualEndpointGatewayIp>
(List) The unique identifier for the reserved IP.
lifecycleReasons List<GetIsVirtualEndpointGatewayLifecycleReason>
lifecycleState String
(String) The endpoint gateway lifecycle state, supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
name String
(String) The target name.
resourceGroup String
(String) The unique identifier for the resource group.
resourceType String
(String) The resource type of the subnet reserved IP.
securityGroups List<String>
(List) - The security groups to use for this endpoint gateway.
serviceEndpoints List<String>
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
tags List<String>
targets List<GetIsVirtualEndpointGatewayTarget>
(List) The endpoint gateway target.
vpc String
(String) The VPC ID.
accessTags string[]
(List) Access management tags associated for the virtual endpoint gateway.
allowDnsResolutionBinding boolean
(Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
createdAt string
(Timestamp) The created date and time of the endpoint gateway.
crn string
(String) The target CRN.
healthState string
(String) Endpoint gateway health state. ok: Healthy, degraded: Suffering from compromised performance, capacity, or connectivity, faulted: Completely unreachable, inoperative, or entirely incapacitated, inapplicable: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state.
id string
(String) The collection of reserved IPs bound to an endpoint gateway.
ips GetIsVirtualEndpointGatewayIp[]
(List) The unique identifier for the reserved IP.
lifecycleReasons GetIsVirtualEndpointGatewayLifecycleReason[]
lifecycleState string
(String) The endpoint gateway lifecycle state, supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
name string
(String) The target name.
resourceGroup string
(String) The unique identifier for the resource group.
resourceType string
(String) The resource type of the subnet reserved IP.
securityGroups string[]
(List) - The security groups to use for this endpoint gateway.
serviceEndpoints string[]
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
tags string[]
targets GetIsVirtualEndpointGatewayTarget[]
(List) The endpoint gateway target.
vpc string
(String) The VPC ID.
access_tags Sequence[str]
(List) Access management tags associated for the virtual endpoint gateway.
allow_dns_resolution_binding bool
(Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
created_at str
(Timestamp) The created date and time of the endpoint gateway.
crn str
(String) The target CRN.
health_state str
(String) Endpoint gateway health state. ok: Healthy, degraded: Suffering from compromised performance, capacity, or connectivity, faulted: Completely unreachable, inoperative, or entirely incapacitated, inapplicable: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state.
id str
(String) The collection of reserved IPs bound to an endpoint gateway.
ips Sequence[GetIsVirtualEndpointGatewayIp]
(List) The unique identifier for the reserved IP.
lifecycle_reasons Sequence[GetIsVirtualEndpointGatewayLifecycleReason]
lifecycle_state str
(String) The endpoint gateway lifecycle state, supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
name str
(String) The target name.
resource_group str
(String) The unique identifier for the resource group.
resource_type str
(String) The resource type of the subnet reserved IP.
security_groups Sequence[str]
(List) - The security groups to use for this endpoint gateway.
service_endpoints Sequence[str]
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
tags Sequence[str]
targets Sequence[GetIsVirtualEndpointGatewayTarget]
(List) The endpoint gateway target.
vpc str
(String) The VPC ID.
accessTags List<String>
(List) Access management tags associated for the virtual endpoint gateway.
allowDnsResolutionBinding Boolean
(Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
createdAt String
(Timestamp) The created date and time of the endpoint gateway.
crn String
(String) The target CRN.
healthState String
(String) Endpoint gateway health state. ok: Healthy, degraded: Suffering from compromised performance, capacity, or connectivity, faulted: Completely unreachable, inoperative, or entirely incapacitated, inapplicable: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state.
id String
(String) The collection of reserved IPs bound to an endpoint gateway.
ips List<Property Map>
(List) The unique identifier for the reserved IP.
lifecycleReasons List<Property Map>
lifecycleState String
(String) The endpoint gateway lifecycle state, supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
name String
(String) The target name.
resourceGroup String
(String) The unique identifier for the resource group.
resourceType String
(String) The resource type of the subnet reserved IP.
securityGroups List<String>
(List) - The security groups to use for this endpoint gateway.
serviceEndpoints List<String>
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
tags List<String>
targets List<Property Map>
(List) The endpoint gateway target.
vpc String
(String) The VPC ID.

Supporting Types

GetIsVirtualEndpointGatewayIp

Address This property is required. string
(String) The endpoint gateway IP Address.
Id This property is required. string
(String) The collection of reserved IPs bound to an endpoint gateway.
Name This property is required. string
The endpoint gateway name.
ResourceType This property is required. string
(String) The resource type of the subnet reserved IP.
Address This property is required. string
(String) The endpoint gateway IP Address.
Id This property is required. string
(String) The collection of reserved IPs bound to an endpoint gateway.
Name This property is required. string
The endpoint gateway name.
ResourceType This property is required. string
(String) The resource type of the subnet reserved IP.
address This property is required. String
(String) The endpoint gateway IP Address.
id This property is required. String
(String) The collection of reserved IPs bound to an endpoint gateway.
name This property is required. String
The endpoint gateway name.
resourceType This property is required. String
(String) The resource type of the subnet reserved IP.
address This property is required. string
(String) The endpoint gateway IP Address.
id This property is required. string
(String) The collection of reserved IPs bound to an endpoint gateway.
name This property is required. string
The endpoint gateway name.
resourceType This property is required. string
(String) The resource type of the subnet reserved IP.
address This property is required. str
(String) The endpoint gateway IP Address.
id This property is required. str
(String) The collection of reserved IPs bound to an endpoint gateway.
name This property is required. str
The endpoint gateway name.
resource_type This property is required. str
(String) The resource type of the subnet reserved IP.
address This property is required. String
(String) The endpoint gateway IP Address.
id This property is required. String
(String) The collection of reserved IPs bound to an endpoint gateway.
name This property is required. String
The endpoint gateway name.
resourceType This property is required. String
(String) The resource type of the subnet reserved IP.

GetIsVirtualEndpointGatewayLifecycleReason

Code This property is required. string
Message This property is required. string
MoreInfo This property is required. string
Code This property is required. string
Message This property is required. string
MoreInfo This property is required. string
code This property is required. String
message This property is required. String
moreInfo This property is required. String
code This property is required. string
message This property is required. string
moreInfo This property is required. string
code This property is required. str
message This property is required. str
more_info This property is required. str
code This property is required. String
message This property is required. String
moreInfo This property is required. String

GetIsVirtualEndpointGatewayTarget

Crn This property is required. string
(String) The target CRN.
Name This property is required. string
The endpoint gateway name.
ResourceType This property is required. string
(String) The resource type of the subnet reserved IP.
Crn This property is required. string
(String) The target CRN.
Name This property is required. string
The endpoint gateway name.
ResourceType This property is required. string
(String) The resource type of the subnet reserved IP.
crn This property is required. String
(String) The target CRN.
name This property is required. String
The endpoint gateway name.
resourceType This property is required. String
(String) The resource type of the subnet reserved IP.
crn This property is required. string
(String) The target CRN.
name This property is required. string
The endpoint gateway name.
resourceType This property is required. string
(String) The resource type of the subnet reserved IP.
crn This property is required. str
(String) The target CRN.
name This property is required. str
The endpoint gateway name.
resource_type This property is required. str
(String) The resource type of the subnet reserved IP.
crn This property is required. String
(String) The target CRN.
name This property is required. String
The endpoint gateway name.
resourceType This property is required. String
(String) The resource type of the subnet reserved IP.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm