Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getVmaasTransitGatewayConnection
ibm 1.83.0-beta0 published on Monday, Sep 15, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getVmaasTransitGatewayConnection

Explore with Pulumi AI

ibm logo
ibm 1.83.0-beta0 published on Monday, Sep 15, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source to retrieve information about a vmaas_transit_gateway_connection. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    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.GetVmaasTransitGatewayConnectionArgs;
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 vmaasTransitGatewayConnection = IbmFunctions.getVmaasTransitGatewayConnection(GetVmaasTransitGatewayConnectionArgs.builder()
            .vmaasTransitGatewayConnectionId(ibm_vmaas_transit_gateway_connection.vmaas_transit_gateway_connection_instance().vmaas_transit_gateway_connection_id())
            .vdcId("vdc_id")
            .edgeId("edge_id")
            .region("us-south")
            .build());

    }
}

    variables:
  vmaasTransitGatewayConnection:
    fn::invoke:
      function: ibm:getVmaasTransitGatewayConnection
      arguments:
        vmaasTransitGatewayConnectionId: ${ibm_vmaas_transit_gateway_connection.vmaas_transit_gateway_connection_instance.vmaas_transit_gateway_connection_id}
        vdcId: vdc_id
        edgeId: edge_id
        region: us-south

    Using getVmaasTransitGatewayConnection

    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 getVmaasTransitGatewayConnection(args: GetVmaasTransitGatewayConnectionArgs, opts?: InvokeOptions): Promise<GetVmaasTransitGatewayConnectionResult>
function getVmaasTransitGatewayConnectionOutput(args: GetVmaasTransitGatewayConnectionOutputArgs, opts?: InvokeOptions): Output<GetVmaasTransitGatewayConnectionResult>
    def get_vmaas_transit_gateway_connection(edge_id: Optional[str] = None,
                                         id: Optional[str] = None,
                                         vdc_id: Optional[str] = None,
                                         vmaas_transit_gateway_connection_id: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetVmaasTransitGatewayConnectionResult
def get_vmaas_transit_gateway_connection_output(edge_id: Optional[pulumi.Input[str]] = None,
                                         id: Optional[pulumi.Input[str]] = None,
                                         vdc_id: Optional[pulumi.Input[str]] = None,
                                         vmaas_transit_gateway_connection_id: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetVmaasTransitGatewayConnectionResult]
    func LookupVmaasTransitGatewayConnection(ctx *Context, args *LookupVmaasTransitGatewayConnectionArgs, opts ...InvokeOption) (*LookupVmaasTransitGatewayConnectionResult, error)
func LookupVmaasTransitGatewayConnectionOutput(ctx *Context, args *LookupVmaasTransitGatewayConnectionOutputArgs, opts ...InvokeOption) LookupVmaasTransitGatewayConnectionResultOutput

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

    public static class GetVmaasTransitGatewayConnection 
{
    public static Task<GetVmaasTransitGatewayConnectionResult> InvokeAsync(GetVmaasTransitGatewayConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetVmaasTransitGatewayConnectionResult> Invoke(GetVmaasTransitGatewayConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVmaasTransitGatewayConnectionResult> getVmaasTransitGatewayConnection(GetVmaasTransitGatewayConnectionArgs args, InvokeOptions options)
public static Output<GetVmaasTransitGatewayConnectionResult> getVmaasTransitGatewayConnection(GetVmaasTransitGatewayConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getVmaasTransitGatewayConnection:getVmaasTransitGatewayConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    EdgeId string
    A unique ID for an edge.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    VdcId string
    A unique ID for a virtual data center.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    VmaasTransitGatewayConnectionId string
    A unique ID for a specified virtual data center.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    Id string
    The unique identifier of the vmaas_transit_gateway_connection.
    EdgeId string
    A unique ID for an edge.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    VdcId string
    A unique ID for a virtual data center.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    VmaasTransitGatewayConnectionId string
    A unique ID for a specified virtual data center.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    Id string
    The unique identifier of the vmaas_transit_gateway_connection.
    edgeId String
    A unique ID for an edge.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    vdcId String
    A unique ID for a virtual data center.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    vmaasTransitGatewayConnectionId String
    A unique ID for a specified virtual data center.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    id String
    The unique identifier of the vmaas_transit_gateway_connection.
    edgeId string
    A unique ID for an edge.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    vdcId string
    A unique ID for a virtual data center.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    vmaasTransitGatewayConnectionId string
    A unique ID for a specified virtual data center.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    id string
    The unique identifier of the vmaas_transit_gateway_connection.
    edge_id str
    A unique ID for an edge.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    vdc_id str
    A unique ID for a virtual data center.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    vmaas_transit_gateway_connection_id str
    A unique ID for a specified virtual data center.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    id str
    The unique identifier of the vmaas_transit_gateway_connection.
    edgeId String
    A unique ID for an edge.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    vdcId String
    A unique ID for a virtual data center.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    vmaasTransitGatewayConnectionId String
    A unique ID for a specified virtual data center.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[A-Za-z0-9_-]{1,128}$/.
    id String
    The unique identifier of the vmaas_transit_gateway_connection.

    getVmaasTransitGatewayConnection Result

    The following output properties are available:

    Connections List<GetVmaasTransitGatewayConnectionConnection>
    (List) IBM Transit Gateway connections.

    • Constraints: The maximum length is 128 items. The minimum length is 1 item. Nested schema for connections:
    EdgeId string
    Id string
    The unique identifier of the vmaas_transit_gateway_connection.
    Region string
    (String) The region where the IBM Transit Gateway is deployed.
    Status string
    (String) Determines the state of the IBM Transit Gateway based on its connections.

    • Constraints: Allowable values are: pending, creating, ready_to_use, deleting.
    VdcId string
    VmaasTransitGatewayConnectionId string
    Connections []GetVmaasTransitGatewayConnectionConnection
    (List) IBM Transit Gateway connections.

    • Constraints: The maximum length is 128 items. The minimum length is 1 item. Nested schema for connections:
    EdgeId string
    Id string
    The unique identifier of the vmaas_transit_gateway_connection.
    Region string
    (String) The region where the IBM Transit Gateway is deployed.
    Status string
    (String) Determines the state of the IBM Transit Gateway based on its connections.

    • Constraints: Allowable values are: pending, creating, ready_to_use, deleting.
    VdcId string
    VmaasTransitGatewayConnectionId string
    connections List<GetVmaasTransitGatewayConnectionConnection>
    (List) IBM Transit Gateway connections.

    • Constraints: The maximum length is 128 items. The minimum length is 1 item. Nested schema for connections:
    edgeId String
    id String
    The unique identifier of the vmaas_transit_gateway_connection.
    region String
    (String) The region where the IBM Transit Gateway is deployed.
    status String
    (String) Determines the state of the IBM Transit Gateway based on its connections.

    • Constraints: Allowable values are: pending, creating, ready_to_use, deleting.
    vdcId String
    vmaasTransitGatewayConnectionId String
    connections GetVmaasTransitGatewayConnectionConnection[]
    (List) IBM Transit Gateway connections.

    • Constraints: The maximum length is 128 items. The minimum length is 1 item. Nested schema for connections:
    edgeId string
    id string
    The unique identifier of the vmaas_transit_gateway_connection.
    region string
    (String) The region where the IBM Transit Gateway is deployed.
    status string
    (String) Determines the state of the IBM Transit Gateway based on its connections.

    • Constraints: Allowable values are: pending, creating, ready_to_use, deleting.
    vdcId string
    vmaasTransitGatewayConnectionId string
    connections Sequence[GetVmaasTransitGatewayConnectionConnection]
    (List) IBM Transit Gateway connections.

    • Constraints: The maximum length is 128 items. The minimum length is 1 item. Nested schema for connections:
    edge_id str
    id str
    The unique identifier of the vmaas_transit_gateway_connection.
    region str
    (String) The region where the IBM Transit Gateway is deployed.
    status str
    (String) Determines the state of the IBM Transit Gateway based on its connections.

    • Constraints: Allowable values are: pending, creating, ready_to_use, deleting.
    vdc_id str
    vmaas_transit_gateway_connection_id str
    connections List<Property Map>
    (List) IBM Transit Gateway connections.

    • Constraints: The maximum length is 128 items. The minimum length is 1 item. Nested schema for connections:
    edgeId String
    id String
    The unique identifier of the vmaas_transit_gateway_connection.
    region String
    (String) The region where the IBM Transit Gateway is deployed.
    status String
    (String) Determines the state of the IBM Transit Gateway based on its connections.

    • Constraints: Allowable values are: pending, creating, ready_to_use, deleting.
    vdcId String
    vmaasTransitGatewayConnectionId String

    Supporting Types

    GetVmaasTransitGatewayConnectionConnection

    BaseNetworkType string
    (String) The type of the network that the unbound GRE tunnel is targeting. Only "classic" is supported.
    LocalBgpAsn double
    (Integer) Local network BGP ASN for the connection.

    • Constraints: The maximum value is 4294967294. The minimum value is 1.
    LocalGatewayIp string
    (String) Local gateway IP address for the connection.
    LocalTunnelIp string
    (String) Local tunnel IP address for the connection.
    Name string
    (String) The autogenerated name for this connection.
    NetworkAccountId string
    (String) The ID of the account that owns the connected network.
    NetworkType string
    (String) The type of the network that is connected through this connection. Only "unbound_gre_tunnel" is supported.
    RemoteBgpAsn double
    (Integer) Remote network BGP ASN for the connection.

    • Constraints: The maximum value is 4294967294. The minimum value is 1.
    RemoteGatewayIp string
    (String) Remote gateway IP address for the connection.
    RemoteTunnelIp string
    (String) Remote tunnel IP address for the connection.
    Status string
    (String) Determines the state of the IBM Transit Gateway based on its connections.

    • Constraints: Allowable values are: pending, creating, ready_to_use, deleting.
    TransitGatewayConnectionName string
    (String) The user-defined name of the connection created on the IBM Transit Gateway.
    Zone string
    (String) The location of the connection.
    BaseNetworkType string
    (String) The type of the network that the unbound GRE tunnel is targeting. Only "classic" is supported.
    LocalBgpAsn float64
    (Integer) Local network BGP ASN for the connection.

    • Constraints: The maximum value is 4294967294. The minimum value is 1.
    LocalGatewayIp string
    (String) Local gateway IP address for the connection.
    LocalTunnelIp string
    (String) Local tunnel IP address for the connection.
    Name string
    (String) The autogenerated name for this connection.
    NetworkAccountId string
    (String) The ID of the account that owns the connected network.
    NetworkType string
    (String) The type of the network that is connected through this connection. Only "unbound_gre_tunnel" is supported.
    RemoteBgpAsn float64
    (Integer) Remote network BGP ASN for the connection.

    • Constraints: The maximum value is 4294967294. The minimum value is 1.
    RemoteGatewayIp string
    (String) Remote gateway IP address for the connection.
    RemoteTunnelIp string
    (String) Remote tunnel IP address for the connection.
    Status string
    (String) Determines the state of the IBM Transit Gateway based on its connections.

    • Constraints: Allowable values are: pending, creating, ready_to_use, deleting.
    TransitGatewayConnectionName string
    (String) The user-defined name of the connection created on the IBM Transit Gateway.
    Zone string
    (String) The location of the connection.
    baseNetworkType String
    (String) The type of the network that the unbound GRE tunnel is targeting. Only "classic" is supported.
    localBgpAsn Double
    (Integer) Local network BGP ASN for the connection.

    • Constraints: The maximum value is 4294967294. The minimum value is 1.
    localGatewayIp String
    (String) Local gateway IP address for the connection.
    localTunnelIp String
    (String) Local tunnel IP address for the connection.
    name String
    (String) The autogenerated name for this connection.
    networkAccountId String
    (String) The ID of the account that owns the connected network.
    networkType String
    (String) The type of the network that is connected through this connection. Only "unbound_gre_tunnel" is supported.
    remoteBgpAsn Double
    (Integer) Remote network BGP ASN for the connection.

    • Constraints: The maximum value is 4294967294. The minimum value is 1.
    remoteGatewayIp String
    (String) Remote gateway IP address for the connection.
    remoteTunnelIp String
    (String) Remote tunnel IP address for the connection.
    status String
    (String) Determines the state of the IBM Transit Gateway based on its connections.

    • Constraints: Allowable values are: pending, creating, ready_to_use, deleting.
    transitGatewayConnectionName String
    (String) The user-defined name of the connection created on the IBM Transit Gateway.
    zone String
    (String) The location of the connection.
    baseNetworkType string
    (String) The type of the network that the unbound GRE tunnel is targeting. Only "classic" is supported.
    localBgpAsn number
    (Integer) Local network BGP ASN for the connection.

    • Constraints: The maximum value is 4294967294. The minimum value is 1.
    localGatewayIp string
    (String) Local gateway IP address for the connection.
    localTunnelIp string
    (String) Local tunnel IP address for the connection.
    name string
    (String) The autogenerated name for this connection.
    networkAccountId string
    (String) The ID of the account that owns the connected network.
    networkType string
    (String) The type of the network that is connected through this connection. Only "unbound_gre_tunnel" is supported.
    remoteBgpAsn number
    (Integer) Remote network BGP ASN for the connection.

    • Constraints: The maximum value is 4294967294. The minimum value is 1.
    remoteGatewayIp string
    (String) Remote gateway IP address for the connection.
    remoteTunnelIp string
    (String) Remote tunnel IP address for the connection.
    status string
    (String) Determines the state of the IBM Transit Gateway based on its connections.

    • Constraints: Allowable values are: pending, creating, ready_to_use, deleting.
    transitGatewayConnectionName string
    (String) The user-defined name of the connection created on the IBM Transit Gateway.
    zone string
    (String) The location of the connection.
    base_network_type str
    (String) The type of the network that the unbound GRE tunnel is targeting. Only "classic" is supported.
    local_bgp_asn float
    (Integer) Local network BGP ASN for the connection.

    • Constraints: The maximum value is 4294967294. The minimum value is 1.
    local_gateway_ip str
    (String) Local gateway IP address for the connection.
    local_tunnel_ip str
    (String) Local tunnel IP address for the connection.
    name str
    (String) The autogenerated name for this connection.
    network_account_id str
    (String) The ID of the account that owns the connected network.
    network_type str
    (String) The type of the network that is connected through this connection. Only "unbound_gre_tunnel" is supported.
    remote_bgp_asn float
    (Integer) Remote network BGP ASN for the connection.

    • Constraints: The maximum value is 4294967294. The minimum value is 1.
    remote_gateway_ip str
    (String) Remote gateway IP address for the connection.
    remote_tunnel_ip str
    (String) Remote tunnel IP address for the connection.
    status str
    (String) Determines the state of the IBM Transit Gateway based on its connections.

    • Constraints: Allowable values are: pending, creating, ready_to_use, deleting.
    transit_gateway_connection_name str
    (String) The user-defined name of the connection created on the IBM Transit Gateway.
    zone str
    (String) The location of the connection.
    baseNetworkType String
    (String) The type of the network that the unbound GRE tunnel is targeting. Only "classic" is supported.
    localBgpAsn Number
    (Integer) Local network BGP ASN for the connection.

    • Constraints: The maximum value is 4294967294. The minimum value is 1.
    localGatewayIp String
    (String) Local gateway IP address for the connection.
    localTunnelIp String
    (String) Local tunnel IP address for the connection.
    name String
    (String) The autogenerated name for this connection.
    networkAccountId String
    (String) The ID of the account that owns the connected network.
    networkType String
    (String) The type of the network that is connected through this connection. Only "unbound_gre_tunnel" is supported.
    remoteBgpAsn Number
    (Integer) Remote network BGP ASN for the connection.

    • Constraints: The maximum value is 4294967294. The minimum value is 1.
    remoteGatewayIp String
    (String) Remote gateway IP address for the connection.
    remoteTunnelIp String
    (String) Remote tunnel IP address for the connection.
    status String
    (String) Determines the state of the IBM Transit Gateway based on its connections.

    • Constraints: Allowable values are: pending, creating, ready_to_use, deleting.
    transitGatewayConnectionName String
    (String) The user-defined name of the connection created on the IBM Transit Gateway.
    zone String
    (String) The location of the connection.

    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.83.0-beta0 published on Monday, Sep 15, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm