Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. TgConnection
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.TgConnection

Explore with Pulumi AI

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

    subcategory: “Transit Gateway” layout: “ibm” page_title: “IBM : tg_connection” description: |- Manages IBM Transit Gateway connection.

    ibm.TgConnection

    Create, update and delete for the transit gateway’s connection resource. For more information, about Transit Gateway connection, see adding a cross-account connection.

    Example Usage

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

const testIbmTgConnection = new ibm.TgConnection("testIbmTgConnection", {
    gateway: ibm_tg_gateway.test_tg_gateway.id,
    networkType: "vpc",
    networkId: ibm_is_vpc.test_tg_vpc.resource_crn,
});
const testIbmTgRgreConnection = new ibm.TgConnection("testIbmTgRgreConnection", {
    gateway: ibm_tg_gateway.test_tg_gateway.id,
    networkType: redundant_gre,
    baseNetworkType: vpc,
    networkId: ibm_is_vpc.test_tg_vpc.resource_crn,
    tunnels: [
        {
            localGatewayIp: "192.129.200.1",
            localTunnelIp: "192.158.239.2",
            name: "tunne1_testtgw1461",
            remoteGatewayIp: "10.186.203.4",
            remoteTunnelIp: "192.158.239.1",
            zone: "us-south-1",
        },
        {
            localGatewayIp: "192.129.220.1",
            localTunnelIp: "192.158.249.2",
            name: "tunne2_testtgw1462",
            remoteGatewayIp: "10.186.203.4",
            remoteTunnelIp: "192.158.249.1",
            zone: "us-south-1",
        },
    ],
});

    import pulumi
import pulumi_ibm as ibm

test_ibm_tg_connection = ibm.TgConnection("testIbmTgConnection",
    gateway=ibm_tg_gateway["test_tg_gateway"]["id"],
    network_type="vpc",
    network_id=ibm_is_vpc["test_tg_vpc"]["resource_crn"])
test_ibm_tg_rgre_connection = ibm.TgConnection("testIbmTgRgreConnection",
    gateway=ibm_tg_gateway["test_tg_gateway"]["id"],
    network_type=redundant_gre,
    base_network_type=vpc,
    network_id=ibm_is_vpc["test_tg_vpc"]["resource_crn"],
    tunnels=[
        {
            "local_gateway_ip": "192.129.200.1",
            "local_tunnel_ip": "192.158.239.2",
            "name": "tunne1_testtgw1461",
            "remote_gateway_ip": "10.186.203.4",
            "remote_tunnel_ip": "192.158.239.1",
            "zone": "us-south-1",
        },
        {
            "local_gateway_ip": "192.129.220.1",
            "local_tunnel_ip": "192.158.249.2",
            "name": "tunne2_testtgw1462",
            "remote_gateway_ip": "10.186.203.4",
            "remote_tunnel_ip": "192.158.249.1",
            "zone": "us-south-1",
        },
    ])

    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.NewTgConnection(ctx, "testIbmTgConnection", &ibm.TgConnectionArgs{
			Gateway:     pulumi.Any(ibm_tg_gateway.Test_tg_gateway.Id),
			NetworkType: pulumi.String("vpc"),
			NetworkId:   pulumi.Any(ibm_is_vpc.Test_tg_vpc.Resource_crn),
		})
		if err != nil {
			return err
		}
		_, err = ibm.NewTgConnection(ctx, "testIbmTgRgreConnection", &ibm.TgConnectionArgs{
			Gateway:         pulumi.Any(ibm_tg_gateway.Test_tg_gateway.Id),
			NetworkType:     pulumi.Any(redundant_gre),
			BaseNetworkType: pulumi.Any(vpc),
			NetworkId:       pulumi.Any(ibm_is_vpc.Test_tg_vpc.Resource_crn),
			Tunnels: ibm.TgConnectionTunnelArray{
				&ibm.TgConnectionTunnelArgs{
					LocalGatewayIp:  pulumi.String("192.129.200.1"),
					LocalTunnelIp:   pulumi.String("192.158.239.2"),
					Name:            pulumi.String("tunne1_testtgw1461"),
					RemoteGatewayIp: pulumi.String("10.186.203.4"),
					RemoteTunnelIp:  pulumi.String("192.158.239.1"),
					Zone:            pulumi.String("us-south-1"),
				},
				&ibm.TgConnectionTunnelArgs{
					LocalGatewayIp:  pulumi.String("192.129.220.1"),
					LocalTunnelIp:   pulumi.String("192.158.249.2"),
					Name:            pulumi.String("tunne2_testtgw1462"),
					RemoteGatewayIp: pulumi.String("10.186.203.4"),
					RemoteTunnelIp:  pulumi.String("192.158.249.1"),
					Zone:            pulumi.String("us-south-1"),
				},
			},
		})
		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 testIbmTgConnection = new Ibm.TgConnection("testIbmTgConnection", new()
    {
        Gateway = ibm_tg_gateway.Test_tg_gateway.Id,
        NetworkType = "vpc",
        NetworkId = ibm_is_vpc.Test_tg_vpc.Resource_crn,
    });

    var testIbmTgRgreConnection = new Ibm.TgConnection("testIbmTgRgreConnection", new()
    {
        Gateway = ibm_tg_gateway.Test_tg_gateway.Id,
        NetworkType = redundant_gre,
        BaseNetworkType = vpc,
        NetworkId = ibm_is_vpc.Test_tg_vpc.Resource_crn,
        Tunnels = new[]
        {
            new Ibm.Inputs.TgConnectionTunnelArgs
            {
                LocalGatewayIp = "192.129.200.1",
                LocalTunnelIp = "192.158.239.2",
                Name = "tunne1_testtgw1461",
                RemoteGatewayIp = "10.186.203.4",
                RemoteTunnelIp = "192.158.239.1",
                Zone = "us-south-1",
            },
            new Ibm.Inputs.TgConnectionTunnelArgs
            {
                LocalGatewayIp = "192.129.220.1",
                LocalTunnelIp = "192.158.249.2",
                Name = "tunne2_testtgw1462",
                RemoteGatewayIp = "10.186.203.4",
                RemoteTunnelIp = "192.158.249.1",
                Zone = "us-south-1",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.TgConnection;
import com.pulumi.ibm.TgConnectionArgs;
import com.pulumi.ibm.inputs.TgConnectionTunnelArgs;
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) {
        var testIbmTgConnection = new TgConnection("testIbmTgConnection", TgConnectionArgs.builder()
            .gateway(ibm_tg_gateway.test_tg_gateway().id())
            .networkType("vpc")
            .networkId(ibm_is_vpc.test_tg_vpc().resource_crn())
            .build());

        var testIbmTgRgreConnection = new TgConnection("testIbmTgRgreConnection", TgConnectionArgs.builder()
            .gateway(ibm_tg_gateway.test_tg_gateway().id())
            .networkType(redundant_gre)
            .baseNetworkType(vpc)
            .networkId(ibm_is_vpc.test_tg_vpc().resource_crn())
            .tunnels(            
                TgConnectionTunnelArgs.builder()
                    .localGatewayIp("192.129.200.1")
                    .localTunnelIp("192.158.239.2")
                    .name("tunne1_testtgw1461")
                    .remoteGatewayIp("10.186.203.4")
                    .remoteTunnelIp("192.158.239.1")
                    .zone("us-south-1")
                    .build(),
                TgConnectionTunnelArgs.builder()
                    .localGatewayIp("192.129.220.1")
                    .localTunnelIp("192.158.249.2")
                    .name("tunne2_testtgw1462")
                    .remoteGatewayIp("10.186.203.4")
                    .remoteTunnelIp("192.158.249.1")
                    .zone("us-south-1")
                    .build())
            .build());

    }
}

    resources:
  testIbmTgConnection:
    type: ibm:TgConnection
    properties:
      gateway: ${ibm_tg_gateway.test_tg_gateway.id}
      networkType: vpc
      networkId: ${ibm_is_vpc.test_tg_vpc.resource_crn}
  testIbmTgRgreConnection:
    type: ibm:TgConnection
    properties:
      gateway: ${ibm_tg_gateway.test_tg_gateway.id}
      networkType: ${redundant_gre}
      baseNetworkType: ${vpc}
      networkId: ${ibm_is_vpc.test_tg_vpc.resource_crn}
      tunnels:
        - localGatewayIp: 192.129.200.1
          localTunnelIp: 192.158.239.2
          name: tunne1_testtgw1461
          remoteGatewayIp: 10.186.203.4
          remoteTunnelIp: 192.158.239.1
          zone: us-south-1
        - localGatewayIp: 192.129.220.1
          localTunnelIp: 192.158.249.2
          name: tunne2_testtgw1462
          remoteGatewayIp: 10.186.203.4
          remoteTunnelIp: 192.158.249.1
          zone: us-south-1

    Create TgConnection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TgConnection(name: string, args: TgConnectionArgs, opts?: CustomResourceOptions);
    @overload
def TgConnection(resource_name: str,
                 args: TgConnectionArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def TgConnection(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 gateway: Optional[str] = None,
                 network_type: Optional[str] = None,
                 network_id: Optional[str] = None,
                 base_network_type: Optional[str] = None,
                 local_gateway_ip: Optional[str] = None,
                 local_tunnel_ip: Optional[str] = None,
                 name: Optional[str] = None,
                 network_account_id: Optional[str] = None,
                 base_connection_id: Optional[str] = None,
                 default_prefix_filter: Optional[str] = None,
                 remote_bgp_asn: Optional[float] = None,
                 remote_gateway_ip: Optional[str] = None,
                 remote_tunnel_ip: Optional[str] = None,
                 tg_connection_id: Optional[str] = None,
                 timeouts: Optional[TgConnectionTimeoutsArgs] = None,
                 tunnels: Optional[Sequence[TgConnectionTunnelArgs]] = None,
                 zone: Optional[str] = None)
    func NewTgConnection(ctx *Context, name string, args TgConnectionArgs, opts ...ResourceOption) (*TgConnection, error)
    public TgConnection(string name, TgConnectionArgs args, CustomResourceOptions? opts = null)
    public TgConnection(String name, TgConnectionArgs args)
public TgConnection(String name, TgConnectionArgs args, CustomResourceOptions options)

    type: ibm:TgConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TgConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TgConnectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TgConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TgConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TgConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var tgConnectionResource = new Ibm.TgConnection("tgConnectionResource", new()
{
    Gateway = "string",
    NetworkType = "string",
    NetworkId = "string",
    BaseNetworkType = "string",
    LocalGatewayIp = "string",
    LocalTunnelIp = "string",
    Name = "string",
    NetworkAccountId = "string",
    BaseConnectionId = "string",
    DefaultPrefixFilter = "string",
    RemoteBgpAsn = 0,
    RemoteGatewayIp = "string",
    RemoteTunnelIp = "string",
    TgConnectionId = "string",
    Timeouts = new Ibm.Inputs.TgConnectionTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    Tunnels = new[]
    {
        new Ibm.Inputs.TgConnectionTunnelArgs
        {
            RemoteGatewayIp = "string",
            Zone = "string",
            LocalGatewayIp = "string",
            LocalTunnelIp = "string",
            RemoteTunnelIp = "string",
            Name = "string",
            RemoteBgpAsn = 0,
            CreatedAt = "string",
            Mtu = 0,
            Status = "string",
            TunnelId = "string",
            UpdatedAt = "string",
            LocalBgpAsn = 0,
        },
    },
    Zone = "string",
});

    example, err := ibm.NewTgConnection(ctx, "tgConnectionResource", &ibm.TgConnectionArgs{
	Gateway:             pulumi.String("string"),
	NetworkType:         pulumi.String("string"),
	NetworkId:           pulumi.String("string"),
	BaseNetworkType:     pulumi.String("string"),
	LocalGatewayIp:      pulumi.String("string"),
	LocalTunnelIp:       pulumi.String("string"),
	Name:                pulumi.String("string"),
	NetworkAccountId:    pulumi.String("string"),
	BaseConnectionId:    pulumi.String("string"),
	DefaultPrefixFilter: pulumi.String("string"),
	RemoteBgpAsn:        pulumi.Float64(0),
	RemoteGatewayIp:     pulumi.String("string"),
	RemoteTunnelIp:      pulumi.String("string"),
	TgConnectionId:      pulumi.String("string"),
	Timeouts: &ibm.TgConnectionTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	Tunnels: ibm.TgConnectionTunnelArray{
		&ibm.TgConnectionTunnelArgs{
			RemoteGatewayIp: pulumi.String("string"),
			Zone:            pulumi.String("string"),
			LocalGatewayIp:  pulumi.String("string"),
			LocalTunnelIp:   pulumi.String("string"),
			RemoteTunnelIp:  pulumi.String("string"),
			Name:            pulumi.String("string"),
			RemoteBgpAsn:    pulumi.Float64(0),
			CreatedAt:       pulumi.String("string"),
			Mtu:             pulumi.Float64(0),
			Status:          pulumi.String("string"),
			TunnelId:        pulumi.String("string"),
			UpdatedAt:       pulumi.String("string"),
			LocalBgpAsn:     pulumi.Float64(0),
		},
	},
	Zone: pulumi.String("string"),
})

    var tgConnectionResource = new TgConnection("tgConnectionResource", TgConnectionArgs.builder()
    .gateway("string")
    .networkType("string")
    .networkId("string")
    .baseNetworkType("string")
    .localGatewayIp("string")
    .localTunnelIp("string")
    .name("string")
    .networkAccountId("string")
    .baseConnectionId("string")
    .defaultPrefixFilter("string")
    .remoteBgpAsn(0)
    .remoteGatewayIp("string")
    .remoteTunnelIp("string")
    .tgConnectionId("string")
    .timeouts(TgConnectionTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .tunnels(TgConnectionTunnelArgs.builder()
        .remoteGatewayIp("string")
        .zone("string")
        .localGatewayIp("string")
        .localTunnelIp("string")
        .remoteTunnelIp("string")
        .name("string")
        .remoteBgpAsn(0)
        .createdAt("string")
        .mtu(0)
        .status("string")
        .tunnelId("string")
        .updatedAt("string")
        .localBgpAsn(0)
        .build())
    .zone("string")
    .build());

    tg_connection_resource = ibm.TgConnection("tgConnectionResource",
    gateway="string",
    network_type="string",
    network_id="string",
    base_network_type="string",
    local_gateway_ip="string",
    local_tunnel_ip="string",
    name="string",
    network_account_id="string",
    base_connection_id="string",
    default_prefix_filter="string",
    remote_bgp_asn=0,
    remote_gateway_ip="string",
    remote_tunnel_ip="string",
    tg_connection_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    tunnels=[{
        "remote_gateway_ip": "string",
        "zone": "string",
        "local_gateway_ip": "string",
        "local_tunnel_ip": "string",
        "remote_tunnel_ip": "string",
        "name": "string",
        "remote_bgp_asn": 0,
        "created_at": "string",
        "mtu": 0,
        "status": "string",
        "tunnel_id": "string",
        "updated_at": "string",
        "local_bgp_asn": 0,
    }],
    zone="string")

    const tgConnectionResource = new ibm.TgConnection("tgConnectionResource", {
    gateway: "string",
    networkType: "string",
    networkId: "string",
    baseNetworkType: "string",
    localGatewayIp: "string",
    localTunnelIp: "string",
    name: "string",
    networkAccountId: "string",
    baseConnectionId: "string",
    defaultPrefixFilter: "string",
    remoteBgpAsn: 0,
    remoteGatewayIp: "string",
    remoteTunnelIp: "string",
    tgConnectionId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    tunnels: [{
        remoteGatewayIp: "string",
        zone: "string",
        localGatewayIp: "string",
        localTunnelIp: "string",
        remoteTunnelIp: "string",
        name: "string",
        remoteBgpAsn: 0,
        createdAt: "string",
        mtu: 0,
        status: "string",
        tunnelId: "string",
        updatedAt: "string",
        localBgpAsn: 0,
    }],
    zone: "string",
});

    type: ibm:TgConnection
properties:
    baseConnectionId: string
    baseNetworkType: string
    defaultPrefixFilter: string
    gateway: string
    localGatewayIp: string
    localTunnelIp: string
    name: string
    networkAccountId: string
    networkId: string
    networkType: string
    remoteBgpAsn: 0
    remoteGatewayIp: string
    remoteTunnelIp: string
    tgConnectionId: string
    timeouts:
        create: string
        delete: string
        update: string
    tunnels:
        - createdAt: string
          localBgpAsn: 0
          localGatewayIp: string
          localTunnelIp: string
          mtu: 0
          name: string
          remoteBgpAsn: 0
          remoteGatewayIp: string
          remoteTunnelIp: string
          status: string
          tunnelId: string
          updatedAt: string
          zone: string
    zone: string

    TgConnection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The TgConnection resource accepts the following input properties:

    Gateway string
    Enter the transit gateway identifier.
    NetworkType string
    Enter the network type. Allowed values are classic, directlink, gre_tunnel, unbound_gre_tunnel, vpc, and power_virtual_server.
    BaseConnectionId string
    The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    BaseNetworkType string
    The type of network the unbound gre tunnel is targeting. This field is required for network type unbound_gre_tunnel.
    DefaultPrefixFilter string
    Whether to permit or deny the prefix filter
    LocalGatewayIp string
    The local gateway IP address. This field is required for and only applicable to gre_tunnel connection types.
    LocalTunnelIp string
    The local tunnel IP address. This field is required for and only applicable to type gre_tunnel connections.
    Name string
    Enter a name. If the name is not given, the default name is provided based on the network type, such as vpc for network type VPC and classic for network type classic.
    NetworkAccountId string
    The ID of the network connected account. This is used if the network is in a different account than the gateway.
    NetworkId string
    Enter the ID of the network being connected through this connection. This parameter is required for network type vpc and directlink, the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type classic. For example, crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b.
    RemoteBgpAsn double
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    RemoteGatewayIp string
    The remote gateway IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    RemoteTunnelIp string
    The remote tunnel IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    TgConnectionId string
    (String) The unique identifier of the connection tunnel ID resource.
    Timeouts TgConnectionTimeouts
    Tunnels List<TgConnectionTunnel>
    List of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for 'redundant_gre' connections. Nested scheme for tunnel:
    Zone string
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    Gateway string
    Enter the transit gateway identifier.
    NetworkType string
    Enter the network type. Allowed values are classic, directlink, gre_tunnel, unbound_gre_tunnel, vpc, and power_virtual_server.
    BaseConnectionId string
    The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    BaseNetworkType string
    The type of network the unbound gre tunnel is targeting. This field is required for network type unbound_gre_tunnel.
    DefaultPrefixFilter string
    Whether to permit or deny the prefix filter
    LocalGatewayIp string
    The local gateway IP address. This field is required for and only applicable to gre_tunnel connection types.
    LocalTunnelIp string
    The local tunnel IP address. This field is required for and only applicable to type gre_tunnel connections.
    Name string
    Enter a name. If the name is not given, the default name is provided based on the network type, such as vpc for network type VPC and classic for network type classic.
    NetworkAccountId string
    The ID of the network connected account. This is used if the network is in a different account than the gateway.
    NetworkId string
    Enter the ID of the network being connected through this connection. This parameter is required for network type vpc and directlink, the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type classic. For example, crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b.
    RemoteBgpAsn float64
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    RemoteGatewayIp string
    The remote gateway IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    RemoteTunnelIp string
    The remote tunnel IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    TgConnectionId string
    (String) The unique identifier of the connection tunnel ID resource.
    Timeouts TgConnectionTimeoutsArgs
    Tunnels []TgConnectionTunnelArgs
    List of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for 'redundant_gre' connections. Nested scheme for tunnel:
    Zone string
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    gateway String
    Enter the transit gateway identifier.
    networkType String
    Enter the network type. Allowed values are classic, directlink, gre_tunnel, unbound_gre_tunnel, vpc, and power_virtual_server.
    baseConnectionId String
    The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    baseNetworkType String
    The type of network the unbound gre tunnel is targeting. This field is required for network type unbound_gre_tunnel.
    defaultPrefixFilter String
    Whether to permit or deny the prefix filter
    localGatewayIp String
    The local gateway IP address. This field is required for and only applicable to gre_tunnel connection types.
    localTunnelIp String
    The local tunnel IP address. This field is required for and only applicable to type gre_tunnel connections.
    name String
    Enter a name. If the name is not given, the default name is provided based on the network type, such as vpc for network type VPC and classic for network type classic.
    networkAccountId String
    The ID of the network connected account. This is used if the network is in a different account than the gateway.
    networkId String
    Enter the ID of the network being connected through this connection. This parameter is required for network type vpc and directlink, the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type classic. For example, crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b.
    remoteBgpAsn Double
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remoteGatewayIp String
    The remote gateway IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remoteTunnelIp String
    The remote tunnel IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    tgConnectionId String
    (String) The unique identifier of the connection tunnel ID resource.
    timeouts TgConnectionTimeouts
    tunnels List<TgConnectionTunnel>
    List of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for 'redundant_gre' connections. Nested scheme for tunnel:
    zone String
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    gateway string
    Enter the transit gateway identifier.
    networkType string
    Enter the network type. Allowed values are classic, directlink, gre_tunnel, unbound_gre_tunnel, vpc, and power_virtual_server.
    baseConnectionId string
    The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    baseNetworkType string
    The type of network the unbound gre tunnel is targeting. This field is required for network type unbound_gre_tunnel.
    defaultPrefixFilter string
    Whether to permit or deny the prefix filter
    localGatewayIp string
    The local gateway IP address. This field is required for and only applicable to gre_tunnel connection types.
    localTunnelIp string
    The local tunnel IP address. This field is required for and only applicable to type gre_tunnel connections.
    name string
    Enter a name. If the name is not given, the default name is provided based on the network type, such as vpc for network type VPC and classic for network type classic.
    networkAccountId string
    The ID of the network connected account. This is used if the network is in a different account than the gateway.
    networkId string
    Enter the ID of the network being connected through this connection. This parameter is required for network type vpc and directlink, the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type classic. For example, crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b.
    remoteBgpAsn number
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remoteGatewayIp string
    The remote gateway IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remoteTunnelIp string
    The remote tunnel IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    tgConnectionId string
    (String) The unique identifier of the connection tunnel ID resource.
    timeouts TgConnectionTimeouts
    tunnels TgConnectionTunnel[]
    List of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for 'redundant_gre' connections. Nested scheme for tunnel:
    zone string
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    gateway str
    Enter the transit gateway identifier.
    network_type str
    Enter the network type. Allowed values are classic, directlink, gre_tunnel, unbound_gre_tunnel, vpc, and power_virtual_server.
    base_connection_id str
    The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    base_network_type str
    The type of network the unbound gre tunnel is targeting. This field is required for network type unbound_gre_tunnel.
    default_prefix_filter str
    Whether to permit or deny the prefix filter
    local_gateway_ip str
    The local gateway IP address. This field is required for and only applicable to gre_tunnel connection types.
    local_tunnel_ip str
    The local tunnel IP address. This field is required for and only applicable to type gre_tunnel connections.
    name str
    Enter a name. If the name is not given, the default name is provided based on the network type, such as vpc for network type VPC and classic for network type classic.
    network_account_id str
    The ID of the network connected account. This is used if the network is in a different account than the gateway.
    network_id str
    Enter the ID of the network being connected through this connection. This parameter is required for network type vpc and directlink, the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type classic. For example, crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b.
    remote_bgp_asn float
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remote_gateway_ip str
    The remote gateway IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remote_tunnel_ip str
    The remote tunnel IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    tg_connection_id str
    (String) The unique identifier of the connection tunnel ID resource.
    timeouts TgConnectionTimeoutsArgs
    tunnels Sequence[TgConnectionTunnelArgs]
    List of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for 'redundant_gre' connections. Nested scheme for tunnel:
    zone str
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    gateway String
    Enter the transit gateway identifier.
    networkType String
    Enter the network type. Allowed values are classic, directlink, gre_tunnel, unbound_gre_tunnel, vpc, and power_virtual_server.
    baseConnectionId String
    The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    baseNetworkType String
    The type of network the unbound gre tunnel is targeting. This field is required for network type unbound_gre_tunnel.
    defaultPrefixFilter String
    Whether to permit or deny the prefix filter
    localGatewayIp String
    The local gateway IP address. This field is required for and only applicable to gre_tunnel connection types.
    localTunnelIp String
    The local tunnel IP address. This field is required for and only applicable to type gre_tunnel connections.
    name String
    Enter a name. If the name is not given, the default name is provided based on the network type, such as vpc for network type VPC and classic for network type classic.
    networkAccountId String
    The ID of the network connected account. This is used if the network is in a different account than the gateway.
    networkId String
    Enter the ID of the network being connected through this connection. This parameter is required for network type vpc and directlink, the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type classic. For example, crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b.
    remoteBgpAsn Number
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remoteGatewayIp String
    The remote gateway IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remoteTunnelIp String
    The remote tunnel IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    tgConnectionId String
    (String) The unique identifier of the connection tunnel ID resource.
    timeouts Property Map
    tunnels List<Property Map>
    List of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for 'redundant_gre' connections. Nested scheme for tunnel:
    zone String
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TgConnection resource produces the following output properties:

    ConnectionId string
    (String) The unique identifier for transit gateway connection to network.
    CreatedAt string
    (Timestamp) The date and time the connection tunnel was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    RelatedCrn string
    The crn of the transit gateway
    RequestStatus string
    Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]
    Status string
    (String) The configuration status of the connection tunnel, such as attached, failed,
    UpdatedAt string
    (Timestamp) Last updated date and time of the connection tunnel.
    ConnectionId string
    (String) The unique identifier for transit gateway connection to network.
    CreatedAt string
    (Timestamp) The date and time the connection tunnel was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    RelatedCrn string
    The crn of the transit gateway
    RequestStatus string
    Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]
    Status string
    (String) The configuration status of the connection tunnel, such as attached, failed,
    UpdatedAt string
    (Timestamp) Last updated date and time of the connection tunnel.
    connectionId String
    (String) The unique identifier for transit gateway connection to network.
    createdAt String
    (Timestamp) The date and time the connection tunnel was created.
    id String
    The provider-assigned unique ID for this managed resource.
    relatedCrn String
    The crn of the transit gateway
    requestStatus String
    Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]
    status String
    (String) The configuration status of the connection tunnel, such as attached, failed,
    updatedAt String
    (Timestamp) Last updated date and time of the connection tunnel.
    connectionId string
    (String) The unique identifier for transit gateway connection to network.
    createdAt string
    (Timestamp) The date and time the connection tunnel was created.
    id string
    The provider-assigned unique ID for this managed resource.
    relatedCrn string
    The crn of the transit gateway
    requestStatus string
    Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]
    status string
    (String) The configuration status of the connection tunnel, such as attached, failed,
    updatedAt string
    (Timestamp) Last updated date and time of the connection tunnel.
    connection_id str
    (String) The unique identifier for transit gateway connection to network.
    created_at str
    (Timestamp) The date and time the connection tunnel was created.
    id str
    The provider-assigned unique ID for this managed resource.
    related_crn str
    The crn of the transit gateway
    request_status str
    Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]
    status str
    (String) The configuration status of the connection tunnel, such as attached, failed,
    updated_at str
    (Timestamp) Last updated date and time of the connection tunnel.
    connectionId String
    (String) The unique identifier for transit gateway connection to network.
    createdAt String
    (Timestamp) The date and time the connection tunnel was created.
    id String
    The provider-assigned unique ID for this managed resource.
    relatedCrn String
    The crn of the transit gateway
    requestStatus String
    Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]
    status String
    (String) The configuration status of the connection tunnel, such as attached, failed,
    updatedAt String
    (Timestamp) Last updated date and time of the connection tunnel.

    Look up Existing TgConnection Resource

    Get an existing TgConnection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TgConnectionState, opts?: CustomResourceOptions): TgConnection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        base_connection_id: Optional[str] = None,
        base_network_type: Optional[str] = None,
        connection_id: Optional[str] = None,
        created_at: Optional[str] = None,
        default_prefix_filter: Optional[str] = None,
        gateway: Optional[str] = None,
        local_gateway_ip: Optional[str] = None,
        local_tunnel_ip: Optional[str] = None,
        name: Optional[str] = None,
        network_account_id: Optional[str] = None,
        network_id: Optional[str] = None,
        network_type: Optional[str] = None,
        related_crn: Optional[str] = None,
        remote_bgp_asn: Optional[float] = None,
        remote_gateway_ip: Optional[str] = None,
        remote_tunnel_ip: Optional[str] = None,
        request_status: Optional[str] = None,
        status: Optional[str] = None,
        tg_connection_id: Optional[str] = None,
        timeouts: Optional[TgConnectionTimeoutsArgs] = None,
        tunnels: Optional[Sequence[TgConnectionTunnelArgs]] = None,
        updated_at: Optional[str] = None,
        zone: Optional[str] = None) -> TgConnection
    func GetTgConnection(ctx *Context, name string, id IDInput, state *TgConnectionState, opts ...ResourceOption) (*TgConnection, error)
    public static TgConnection Get(string name, Input<string> id, TgConnectionState? state, CustomResourceOptions? opts = null)
    public static TgConnection get(String name, Output<String> id, TgConnectionState state, CustomResourceOptions options)
    resources:  _:    type: ibm:TgConnection    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BaseConnectionId string
    The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    BaseNetworkType string
    The type of network the unbound gre tunnel is targeting. This field is required for network type unbound_gre_tunnel.
    ConnectionId string
    (String) The unique identifier for transit gateway connection to network.
    CreatedAt string
    (Timestamp) The date and time the connection tunnel was created.
    DefaultPrefixFilter string
    Whether to permit or deny the prefix filter
    Gateway string
    Enter the transit gateway identifier.
    LocalGatewayIp string
    The local gateway IP address. This field is required for and only applicable to gre_tunnel connection types.
    LocalTunnelIp string
    The local tunnel IP address. This field is required for and only applicable to type gre_tunnel connections.
    Name string
    Enter a name. If the name is not given, the default name is provided based on the network type, such as vpc for network type VPC and classic for network type classic.
    NetworkAccountId string
    The ID of the network connected account. This is used if the network is in a different account than the gateway.
    NetworkId string
    Enter the ID of the network being connected through this connection. This parameter is required for network type vpc and directlink, the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type classic. For example, crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b.
    NetworkType string
    Enter the network type. Allowed values are classic, directlink, gre_tunnel, unbound_gre_tunnel, vpc, and power_virtual_server.
    RelatedCrn string
    The crn of the transit gateway
    RemoteBgpAsn double
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    RemoteGatewayIp string
    The remote gateway IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    RemoteTunnelIp string
    The remote tunnel IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    RequestStatus string
    Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]
    Status string
    (String) The configuration status of the connection tunnel, such as attached, failed,
    TgConnectionId string
    (String) The unique identifier of the connection tunnel ID resource.
    Timeouts TgConnectionTimeouts
    Tunnels List<TgConnectionTunnel>
    List of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for 'redundant_gre' connections. Nested scheme for tunnel:
    UpdatedAt string
    (Timestamp) Last updated date and time of the connection tunnel.
    Zone string
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    BaseConnectionId string
    The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    BaseNetworkType string
    The type of network the unbound gre tunnel is targeting. This field is required for network type unbound_gre_tunnel.
    ConnectionId string
    (String) The unique identifier for transit gateway connection to network.
    CreatedAt string
    (Timestamp) The date and time the connection tunnel was created.
    DefaultPrefixFilter string
    Whether to permit or deny the prefix filter
    Gateway string
    Enter the transit gateway identifier.
    LocalGatewayIp string
    The local gateway IP address. This field is required for and only applicable to gre_tunnel connection types.
    LocalTunnelIp string
    The local tunnel IP address. This field is required for and only applicable to type gre_tunnel connections.
    Name string
    Enter a name. If the name is not given, the default name is provided based on the network type, such as vpc for network type VPC and classic for network type classic.
    NetworkAccountId string
    The ID of the network connected account. This is used if the network is in a different account than the gateway.
    NetworkId string
    Enter the ID of the network being connected through this connection. This parameter is required for network type vpc and directlink, the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type classic. For example, crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b.
    NetworkType string
    Enter the network type. Allowed values are classic, directlink, gre_tunnel, unbound_gre_tunnel, vpc, and power_virtual_server.
    RelatedCrn string
    The crn of the transit gateway
    RemoteBgpAsn float64
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    RemoteGatewayIp string
    The remote gateway IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    RemoteTunnelIp string
    The remote tunnel IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    RequestStatus string
    Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]
    Status string
    (String) The configuration status of the connection tunnel, such as attached, failed,
    TgConnectionId string
    (String) The unique identifier of the connection tunnel ID resource.
    Timeouts TgConnectionTimeoutsArgs
    Tunnels []TgConnectionTunnelArgs
    List of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for 'redundant_gre' connections. Nested scheme for tunnel:
    UpdatedAt string
    (Timestamp) Last updated date and time of the connection tunnel.
    Zone string
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    baseConnectionId String
    The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    baseNetworkType String
    The type of network the unbound gre tunnel is targeting. This field is required for network type unbound_gre_tunnel.
    connectionId String
    (String) The unique identifier for transit gateway connection to network.
    createdAt String
    (Timestamp) The date and time the connection tunnel was created.
    defaultPrefixFilter String
    Whether to permit or deny the prefix filter
    gateway String
    Enter the transit gateway identifier.
    localGatewayIp String
    The local gateway IP address. This field is required for and only applicable to gre_tunnel connection types.
    localTunnelIp String
    The local tunnel IP address. This field is required for and only applicable to type gre_tunnel connections.
    name String
    Enter a name. If the name is not given, the default name is provided based on the network type, such as vpc for network type VPC and classic for network type classic.
    networkAccountId String
    The ID of the network connected account. This is used if the network is in a different account than the gateway.
    networkId String
    Enter the ID of the network being connected through this connection. This parameter is required for network type vpc and directlink, the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type classic. For example, crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b.
    networkType String
    Enter the network type. Allowed values are classic, directlink, gre_tunnel, unbound_gre_tunnel, vpc, and power_virtual_server.
    relatedCrn String
    The crn of the transit gateway
    remoteBgpAsn Double
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remoteGatewayIp String
    The remote gateway IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remoteTunnelIp String
    The remote tunnel IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    requestStatus String
    Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]
    status String
    (String) The configuration status of the connection tunnel, such as attached, failed,
    tgConnectionId String
    (String) The unique identifier of the connection tunnel ID resource.
    timeouts TgConnectionTimeouts
    tunnels List<TgConnectionTunnel>
    List of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for 'redundant_gre' connections. Nested scheme for tunnel:
    updatedAt String
    (Timestamp) Last updated date and time of the connection tunnel.
    zone String
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    baseConnectionId string
    The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    baseNetworkType string
    The type of network the unbound gre tunnel is targeting. This field is required for network type unbound_gre_tunnel.
    connectionId string
    (String) The unique identifier for transit gateway connection to network.
    createdAt string
    (Timestamp) The date and time the connection tunnel was created.
    defaultPrefixFilter string
    Whether to permit or deny the prefix filter
    gateway string
    Enter the transit gateway identifier.
    localGatewayIp string
    The local gateway IP address. This field is required for and only applicable to gre_tunnel connection types.
    localTunnelIp string
    The local tunnel IP address. This field is required for and only applicable to type gre_tunnel connections.
    name string
    Enter a name. If the name is not given, the default name is provided based on the network type, such as vpc for network type VPC and classic for network type classic.
    networkAccountId string
    The ID of the network connected account. This is used if the network is in a different account than the gateway.
    networkId string
    Enter the ID of the network being connected through this connection. This parameter is required for network type vpc and directlink, the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type classic. For example, crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b.
    networkType string
    Enter the network type. Allowed values are classic, directlink, gre_tunnel, unbound_gre_tunnel, vpc, and power_virtual_server.
    relatedCrn string
    The crn of the transit gateway
    remoteBgpAsn number
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remoteGatewayIp string
    The remote gateway IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remoteTunnelIp string
    The remote tunnel IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    requestStatus string
    Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]
    status string
    (String) The configuration status of the connection tunnel, such as attached, failed,
    tgConnectionId string
    (String) The unique identifier of the connection tunnel ID resource.
    timeouts TgConnectionTimeouts
    tunnels TgConnectionTunnel[]
    List of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for 'redundant_gre' connections. Nested scheme for tunnel:
    updatedAt string
    (Timestamp) Last updated date and time of the connection tunnel.
    zone string
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    base_connection_id str
    The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    base_network_type str
    The type of network the unbound gre tunnel is targeting. This field is required for network type unbound_gre_tunnel.
    connection_id str
    (String) The unique identifier for transit gateway connection to network.
    created_at str
    (Timestamp) The date and time the connection tunnel was created.
    default_prefix_filter str
    Whether to permit or deny the prefix filter
    gateway str
    Enter the transit gateway identifier.
    local_gateway_ip str
    The local gateway IP address. This field is required for and only applicable to gre_tunnel connection types.
    local_tunnel_ip str
    The local tunnel IP address. This field is required for and only applicable to type gre_tunnel connections.
    name str
    Enter a name. If the name is not given, the default name is provided based on the network type, such as vpc for network type VPC and classic for network type classic.
    network_account_id str
    The ID of the network connected account. This is used if the network is in a different account than the gateway.
    network_id str
    Enter the ID of the network being connected through this connection. This parameter is required for network type vpc and directlink, the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type classic. For example, crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b.
    network_type str
    Enter the network type. Allowed values are classic, directlink, gre_tunnel, unbound_gre_tunnel, vpc, and power_virtual_server.
    related_crn str
    The crn of the transit gateway
    remote_bgp_asn float
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remote_gateway_ip str
    The remote gateway IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remote_tunnel_ip str
    The remote tunnel IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    request_status str
    Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]
    status str
    (String) The configuration status of the connection tunnel, such as attached, failed,
    tg_connection_id str
    (String) The unique identifier of the connection tunnel ID resource.
    timeouts TgConnectionTimeoutsArgs
    tunnels Sequence[TgConnectionTunnelArgs]
    List of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for 'redundant_gre' connections. Nested scheme for tunnel:
    updated_at str
    (Timestamp) Last updated date and time of the connection tunnel.
    zone str
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    baseConnectionId String
    The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    baseNetworkType String
    The type of network the unbound gre tunnel is targeting. This field is required for network type unbound_gre_tunnel.
    connectionId String
    (String) The unique identifier for transit gateway connection to network.
    createdAt String
    (Timestamp) The date and time the connection tunnel was created.
    defaultPrefixFilter String
    Whether to permit or deny the prefix filter
    gateway String
    Enter the transit gateway identifier.
    localGatewayIp String
    The local gateway IP address. This field is required for and only applicable to gre_tunnel connection types.
    localTunnelIp String
    The local tunnel IP address. This field is required for and only applicable to type gre_tunnel connections.
    name String
    Enter a name. If the name is not given, the default name is provided based on the network type, such as vpc for network type VPC and classic for network type classic.
    networkAccountId String
    The ID of the network connected account. This is used if the network is in a different account than the gateway.
    networkId String
    Enter the ID of the network being connected through this connection. This parameter is required for network type vpc and directlink, the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type classic. For example, crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b.
    networkType String
    Enter the network type. Allowed values are classic, directlink, gre_tunnel, unbound_gre_tunnel, vpc, and power_virtual_server.
    relatedCrn String
    The crn of the transit gateway
    remoteBgpAsn Number
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remoteGatewayIp String
    The remote gateway IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    remoteTunnelIp String
    The remote tunnel IP address. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    requestStatus String
    Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]
    status String
    (String) The configuration status of the connection tunnel, such as attached, failed,
    tgConnectionId String
    (String) The unique identifier of the connection tunnel ID resource.
    timeouts Property Map
    tunnels List<Property Map>
    List of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for 'redundant_gre' connections. Nested scheme for tunnel:
    updatedAt String
    (Timestamp) Last updated date and time of the connection tunnel.
    zone String
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.

    Supporting Types

    TgConnectionTimeouts, TgConnectionTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    TgConnectionTunnel, TgConnectionTunnelArgs

    LocalGatewayIp string
    The local gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    LocalTunnelIp string
    The local tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    Name string
    The user-defined name for this tunnel connection.
    RemoteGatewayIp string
    The remote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    RemoteTunnelIp string
    The remote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    Zone string
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    CreatedAt string
    (Timestamp) The date and time the connection tunnel was created.
    LocalBgpAsn double
    (Integer) The local network BGP ASN.
    Mtu double
    (Integer) GRE tunnel MTU.
    RemoteBgpAsn double
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network typegre_tunnel and unbound_gre_tunnel connections.
    Status string
    (String) The configuration status of the connection tunnel, such as attached, failed,
    TunnelId string
    The Transit Gateway Connection tunnel identifier
    UpdatedAt string
    (Timestamp) Last updated date and time of the connection tunnel.
    LocalGatewayIp string
    The local gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    LocalTunnelIp string
    The local tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    Name string
    The user-defined name for this tunnel connection.
    RemoteGatewayIp string
    The remote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    RemoteTunnelIp string
    The remote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    Zone string
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    CreatedAt string
    (Timestamp) The date and time the connection tunnel was created.
    LocalBgpAsn float64
    (Integer) The local network BGP ASN.
    Mtu float64
    (Integer) GRE tunnel MTU.
    RemoteBgpAsn float64
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network typegre_tunnel and unbound_gre_tunnel connections.
    Status string
    (String) The configuration status of the connection tunnel, such as attached, failed,
    TunnelId string
    The Transit Gateway Connection tunnel identifier
    UpdatedAt string
    (Timestamp) Last updated date and time of the connection tunnel.
    localGatewayIp String
    The local gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    localTunnelIp String
    The local tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    name String
    The user-defined name for this tunnel connection.
    remoteGatewayIp String
    The remote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    remoteTunnelIp String
    The remote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    zone String
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    createdAt String
    (Timestamp) The date and time the connection tunnel was created.
    localBgpAsn Double
    (Integer) The local network BGP ASN.
    mtu Double
    (Integer) GRE tunnel MTU.
    remoteBgpAsn Double
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network typegre_tunnel and unbound_gre_tunnel connections.
    status String
    (String) The configuration status of the connection tunnel, such as attached, failed,
    tunnelId String
    The Transit Gateway Connection tunnel identifier
    updatedAt String
    (Timestamp) Last updated date and time of the connection tunnel.
    localGatewayIp string
    The local gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    localTunnelIp string
    The local tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    name string
    The user-defined name for this tunnel connection.
    remoteGatewayIp string
    The remote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    remoteTunnelIp string
    The remote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    zone string
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    createdAt string
    (Timestamp) The date and time the connection tunnel was created.
    localBgpAsn number
    (Integer) The local network BGP ASN.
    mtu number
    (Integer) GRE tunnel MTU.
    remoteBgpAsn number
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network typegre_tunnel and unbound_gre_tunnel connections.
    status string
    (String) The configuration status of the connection tunnel, such as attached, failed,
    tunnelId string
    The Transit Gateway Connection tunnel identifier
    updatedAt string
    (Timestamp) Last updated date and time of the connection tunnel.
    local_gateway_ip str
    The local gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    local_tunnel_ip str
    The local tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    name str
    The user-defined name for this tunnel connection.
    remote_gateway_ip str
    The remote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    remote_tunnel_ip str
    The remote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    zone str
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    created_at str
    (Timestamp) The date and time the connection tunnel was created.
    local_bgp_asn float
    (Integer) The local network BGP ASN.
    mtu float
    (Integer) GRE tunnel MTU.
    remote_bgp_asn float
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network typegre_tunnel and unbound_gre_tunnel connections.
    status str
    (String) The configuration status of the connection tunnel, such as attached, failed,
    tunnel_id str
    The Transit Gateway Connection tunnel identifier
    updated_at str
    (Timestamp) Last updated date and time of the connection tunnel.
    localGatewayIp String
    The local gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    localTunnelIp String
    The local tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    name String
    The user-defined name for this tunnel connection.
    remoteGatewayIp String
    The remote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    remoteTunnelIp String
    The remote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
    zone String
    The location of the GRE tunnel. This field only applies to network type gre_tunnel and unbound_gre_tunnel connections.
    createdAt String
    (Timestamp) The date and time the connection tunnel was created.
    localBgpAsn Number
    (Integer) The local network BGP ASN.
    mtu Number
    (Integer) GRE tunnel MTU.
    remoteBgpAsn Number
    The remote network BGP ASN (will be generated for the connection if not specified). This field only applies to network typegre_tunnel and unbound_gre_tunnel connections.
    status String
    (String) The configuration status of the connection tunnel, such as attached, failed,
    tunnelId String
    The Transit Gateway Connection tunnel identifier
    updatedAt String
    (Timestamp) Last updated date and time of the connection tunnel.

    Import

    The ibm_tg_connection resource can be imported by using transit gateway ID and connection ID.

    Example

    $ pulumi import ibm:index/tgConnection:TgConnection example 5ffda12064634723b079acdb018ef308/cea6651a-bd0a-4438-9f8a-a0770bbf3ebb

    To learn more about importing existing cloud resources, see Importing resources.

    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
    ibm-cloud/terraform-provider-ibm