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

ibm.TgGateway

Explore with Pulumi AI

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

    Create, update and delete for the transit gateway resource. For more information, about transit location, see managing transit gateways.

    Example Usage

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

const newTgGw = new ibm.TgGateway("newTgGw", {
    global: true,
    location: "us-south",
    resourceGroup: "30951d2dff914dafb26455a88c0c0092",
});

    import pulumi
import pulumi_ibm as ibm

new_tg_gw = ibm.TgGateway("newTgGw",
    global_=True,
    location="us-south",
    resource_group="30951d2dff914dafb26455a88c0c0092")

    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.NewTgGateway(ctx, "newTgGw", &ibm.TgGatewayArgs{
			Global:        pulumi.Bool(true),
			Location:      pulumi.String("us-south"),
			ResourceGroup: pulumi.String("30951d2dff914dafb26455a88c0c0092"),
		})
		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 newTgGw = new Ibm.TgGateway("newTgGw", new()
    {
        Global = true,
        Location = "us-south",
        ResourceGroup = "30951d2dff914dafb26455a88c0c0092",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.TgGateway;
import com.pulumi.ibm.TgGatewayArgs;
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 newTgGw = new TgGateway("newTgGw", TgGatewayArgs.builder()
            .global(true)
            .location("us-south")
            .resourceGroup("30951d2dff914dafb26455a88c0c0092")
            .build());

    }
}

    resources:
  newTgGw:
    type: ibm:TgGateway
    properties:
      global: true
      location: us-south
      resourceGroup: 30951d2dff914dafb26455a88c0c0092

    Create TgGateway Resource

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

    Constructor syntax

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

@overload
def TgGateway(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              location: Optional[str] = None,
              global_: Optional[bool] = None,
              name: Optional[str] = None,
              resource_group: Optional[str] = None,
              tags: Optional[Sequence[str]] = None,
              tg_gateway_id: Optional[str] = None,
              timeouts: Optional[TgGatewayTimeoutsArgs] = None)
    func NewTgGateway(ctx *Context, name string, args TgGatewayArgs, opts ...ResourceOption) (*TgGateway, error)
    public TgGateway(string name, TgGatewayArgs args, CustomResourceOptions? opts = null)
    public TgGateway(String name, TgGatewayArgs args)
public TgGateway(String name, TgGatewayArgs args, CustomResourceOptions options)

    type: ibm:TgGateway
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 TgGatewayArgs
    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 TgGatewayArgs
    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 TgGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TgGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TgGatewayArgs
    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 tgGatewayResource = new Ibm.TgGateway("tgGatewayResource", new()
{
    Location = "string",
    Global = false,
    Name = "string",
    ResourceGroup = "string",
    Tags = new[]
    {
        "string",
    },
    TgGatewayId = "string",
    Timeouts = new Ibm.Inputs.TgGatewayTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := ibm.NewTgGateway(ctx, "tgGatewayResource", &ibm.TgGatewayArgs{
	Location:      pulumi.String("string"),
	Global:        pulumi.Bool(false),
	Name:          pulumi.String("string"),
	ResourceGroup: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TgGatewayId: pulumi.String("string"),
	Timeouts: &ibm.TgGatewayTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var tgGatewayResource = new TgGateway("tgGatewayResource", TgGatewayArgs.builder()
    .location("string")
    .global(false)
    .name("string")
    .resourceGroup("string")
    .tags("string")
    .tgGatewayId("string")
    .timeouts(TgGatewayTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    tg_gateway_resource = ibm.TgGateway("tgGatewayResource",
    location="string",
    global_=False,
    name="string",
    resource_group="string",
    tags=["string"],
    tg_gateway_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const tgGatewayResource = new ibm.TgGateway("tgGatewayResource", {
    location: "string",
    global: false,
    name: "string",
    resourceGroup: "string",
    tags: ["string"],
    tgGatewayId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: ibm:TgGateway
properties:
    global: false
    location: string
    name: string
    resourceGroup: string
    tags:
        - string
    tgGatewayId: string
    timeouts:
        create: string
        delete: string
        update: string

    TgGateway 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 TgGateway resource accepts the following input properties:

    Location string
    The location of the transit gateway. For example, us-south.
    Global bool
    The gateways with global routing (true) to connect to the networks outside their associated region.
    Name string
    The unique user-defined name for the gateway. For example, myGateway.
    ResourceGroup string
    The resource group ID where the transit gateway to be created.
    Tags List<string>
    Tags for the transit gateway instance
    TgGatewayId string
    (String) The unique identifier of the gateway ID or connection ID resource.
    Timeouts TgGatewayTimeouts
    Location string
    The location of the transit gateway. For example, us-south.
    Global bool
    The gateways with global routing (true) to connect to the networks outside their associated region.
    Name string
    The unique user-defined name for the gateway. For example, myGateway.
    ResourceGroup string
    The resource group ID where the transit gateway to be created.
    Tags []string
    Tags for the transit gateway instance
    TgGatewayId string
    (String) The unique identifier of the gateway ID or connection ID resource.
    Timeouts TgGatewayTimeoutsArgs
    location String
    The location of the transit gateway. For example, us-south.
    global Boolean
    The gateways with global routing (true) to connect to the networks outside their associated region.
    name String
    The unique user-defined name for the gateway. For example, myGateway.
    resourceGroup String
    The resource group ID where the transit gateway to be created.
    tags List<String>
    Tags for the transit gateway instance
    tgGatewayId String
    (String) The unique identifier of the gateway ID or connection ID resource.
    timeouts TgGatewayTimeouts
    location string
    The location of the transit gateway. For example, us-south.
    global boolean
    The gateways with global routing (true) to connect to the networks outside their associated region.
    name string
    The unique user-defined name for the gateway. For example, myGateway.
    resourceGroup string
    The resource group ID where the transit gateway to be created.
    tags string[]
    Tags for the transit gateway instance
    tgGatewayId string
    (String) The unique identifier of the gateway ID or connection ID resource.
    timeouts TgGatewayTimeouts
    location str
    The location of the transit gateway. For example, us-south.
    global_ bool
    The gateways with global routing (true) to connect to the networks outside their associated region.
    name str
    The unique user-defined name for the gateway. For example, myGateway.
    resource_group str
    The resource group ID where the transit gateway to be created.
    tags Sequence[str]
    Tags for the transit gateway instance
    tg_gateway_id str
    (String) The unique identifier of the gateway ID or connection ID resource.
    timeouts TgGatewayTimeoutsArgs
    location String
    The location of the transit gateway. For example, us-south.
    global Boolean
    The gateways with global routing (true) to connect to the networks outside their associated region.
    name String
    The unique user-defined name for the gateway. For example, myGateway.
    resourceGroup String
    The resource group ID where the transit gateway to be created.
    tags List<String>
    Tags for the transit gateway instance
    tgGatewayId String
    (String) The unique identifier of the gateway ID or connection ID resource.
    timeouts Property Map

    Outputs

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

    CreatedAt string
    (Timestamp) The date and time the connection is created.
    Crn string
    (String) The CRN of the gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceCrn string
    The crn of the resource
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Status string
    (String) The configuration status of the connection, such as Available, pending.
    UpdatedAt string
    (Timestamp) The date and time the connection is last updated.
    CreatedAt string
    (Timestamp) The date and time the connection is created.
    Crn string
    (String) The CRN of the gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceCrn string
    The crn of the resource
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Status string
    (String) The configuration status of the connection, such as Available, pending.
    UpdatedAt string
    (Timestamp) The date and time the connection is last updated.
    createdAt String
    (Timestamp) The date and time the connection is created.
    crn String
    (String) The CRN of the gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn String
    The crn of the resource
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    status String
    (String) The configuration status of the connection, such as Available, pending.
    updatedAt String
    (Timestamp) The date and time the connection is last updated.
    createdAt string
    (Timestamp) The date and time the connection is created.
    crn string
    (String) The CRN of the gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    resourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn string
    The crn of the resource
    resourceGroupName string
    The resource group name in which resource is provisioned
    resourceName string
    The name of the resource
    resourceStatus string
    The status of the resource
    status string
    (String) The configuration status of the connection, such as Available, pending.
    updatedAt string
    (Timestamp) The date and time the connection is last updated.
    created_at str
    (Timestamp) The date and time the connection is created.
    crn str
    (String) The CRN of the gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    resource_controller_url str
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resource_crn str
    The crn of the resource
    resource_group_name str
    The resource group name in which resource is provisioned
    resource_name str
    The name of the resource
    resource_status str
    The status of the resource
    status str
    (String) The configuration status of the connection, such as Available, pending.
    updated_at str
    (Timestamp) The date and time the connection is last updated.
    createdAt String
    (Timestamp) The date and time the connection is created.
    crn String
    (String) The CRN of the gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn String
    The crn of the resource
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    status String
    (String) The configuration status of the connection, such as Available, pending.
    updatedAt String
    (Timestamp) The date and time the connection is last updated.

    Look up Existing TgGateway Resource

    Get an existing TgGateway 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?: TgGatewayState, opts?: CustomResourceOptions): TgGateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        global_: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_controller_url: Optional[str] = None,
        resource_crn: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        resource_name: Optional[str] = None,
        resource_status: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        tg_gateway_id: Optional[str] = None,
        timeouts: Optional[TgGatewayTimeoutsArgs] = None,
        updated_at: Optional[str] = None) -> TgGateway
    func GetTgGateway(ctx *Context, name string, id IDInput, state *TgGatewayState, opts ...ResourceOption) (*TgGateway, error)
    public static TgGateway Get(string name, Input<string> id, TgGatewayState? state, CustomResourceOptions? opts = null)
    public static TgGateway get(String name, Output<String> id, TgGatewayState state, CustomResourceOptions options)
    resources:  _:    type: ibm:TgGateway    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:
    CreatedAt string
    (Timestamp) The date and time the connection is created.
    Crn string
    (String) The CRN of the gateway.
    Global bool
    The gateways with global routing (true) to connect to the networks outside their associated region.
    Location string
    The location of the transit gateway. For example, us-south.
    Name string
    The unique user-defined name for the gateway. For example, myGateway.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceCrn string
    The crn of the resource
    ResourceGroup string
    The resource group ID where the transit gateway to be created.
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Status string
    (String) The configuration status of the connection, such as Available, pending.
    Tags List<string>
    Tags for the transit gateway instance
    TgGatewayId string
    (String) The unique identifier of the gateway ID or connection ID resource.
    Timeouts TgGatewayTimeouts
    UpdatedAt string
    (Timestamp) The date and time the connection is last updated.
    CreatedAt string
    (Timestamp) The date and time the connection is created.
    Crn string
    (String) The CRN of the gateway.
    Global bool
    The gateways with global routing (true) to connect to the networks outside their associated region.
    Location string
    The location of the transit gateway. For example, us-south.
    Name string
    The unique user-defined name for the gateway. For example, myGateway.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceCrn string
    The crn of the resource
    ResourceGroup string
    The resource group ID where the transit gateway to be created.
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Status string
    (String) The configuration status of the connection, such as Available, pending.
    Tags []string
    Tags for the transit gateway instance
    TgGatewayId string
    (String) The unique identifier of the gateway ID or connection ID resource.
    Timeouts TgGatewayTimeoutsArgs
    UpdatedAt string
    (Timestamp) The date and time the connection is last updated.
    createdAt String
    (Timestamp) The date and time the connection is created.
    crn String
    (String) The CRN of the gateway.
    global Boolean
    The gateways with global routing (true) to connect to the networks outside their associated region.
    location String
    The location of the transit gateway. For example, us-south.
    name String
    The unique user-defined name for the gateway. For example, myGateway.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn String
    The crn of the resource
    resourceGroup String
    The resource group ID where the transit gateway to be created.
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    status String
    (String) The configuration status of the connection, such as Available, pending.
    tags List<String>
    Tags for the transit gateway instance
    tgGatewayId String
    (String) The unique identifier of the gateway ID or connection ID resource.
    timeouts TgGatewayTimeouts
    updatedAt String
    (Timestamp) The date and time the connection is last updated.
    createdAt string
    (Timestamp) The date and time the connection is created.
    crn string
    (String) The CRN of the gateway.
    global boolean
    The gateways with global routing (true) to connect to the networks outside their associated region.
    location string
    The location of the transit gateway. For example, us-south.
    name string
    The unique user-defined name for the gateway. For example, myGateway.
    resourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn string
    The crn of the resource
    resourceGroup string
    The resource group ID where the transit gateway to be created.
    resourceGroupName string
    The resource group name in which resource is provisioned
    resourceName string
    The name of the resource
    resourceStatus string
    The status of the resource
    status string
    (String) The configuration status of the connection, such as Available, pending.
    tags string[]
    Tags for the transit gateway instance
    tgGatewayId string
    (String) The unique identifier of the gateway ID or connection ID resource.
    timeouts TgGatewayTimeouts
    updatedAt string
    (Timestamp) The date and time the connection is last updated.
    created_at str
    (Timestamp) The date and time the connection is created.
    crn str
    (String) The CRN of the gateway.
    global_ bool
    The gateways with global routing (true) to connect to the networks outside their associated region.
    location str
    The location of the transit gateway. For example, us-south.
    name str
    The unique user-defined name for the gateway. For example, myGateway.
    resource_controller_url str
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resource_crn str
    The crn of the resource
    resource_group str
    The resource group ID where the transit gateway to be created.
    resource_group_name str
    The resource group name in which resource is provisioned
    resource_name str
    The name of the resource
    resource_status str
    The status of the resource
    status str
    (String) The configuration status of the connection, such as Available, pending.
    tags Sequence[str]
    Tags for the transit gateway instance
    tg_gateway_id str
    (String) The unique identifier of the gateway ID or connection ID resource.
    timeouts TgGatewayTimeoutsArgs
    updated_at str
    (Timestamp) The date and time the connection is last updated.
    createdAt String
    (Timestamp) The date and time the connection is created.
    crn String
    (String) The CRN of the gateway.
    global Boolean
    The gateways with global routing (true) to connect to the networks outside their associated region.
    location String
    The location of the transit gateway. For example, us-south.
    name String
    The unique user-defined name for the gateway. For example, myGateway.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn String
    The crn of the resource
    resourceGroup String
    The resource group ID where the transit gateway to be created.
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    status String
    (String) The configuration status of the connection, such as Available, pending.
    tags List<String>
    Tags for the transit gateway instance
    tgGatewayId String
    (String) The unique identifier of the gateway ID or connection ID resource.
    timeouts Property Map
    updatedAt String
    (Timestamp) The date and time the connection is last updated.

    Supporting Types

    TgGatewayTimeouts, TgGatewayTimeoutsArgs

    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

    Import

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

    Example

    $ pulumi import ibm:index/tgGateway:TgGateway example 5ffda12064634723b079acdb018ef308

    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