Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ec2transitgateway
  5. TransitGateway
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.ec2transitgateway.TransitGateway

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Manages an EC2 Transit Gateway.

Example Usage

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

const example = new aws.ec2transitgateway.TransitGateway("example", {description: "example"});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.TransitGateway("example", description="example")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2transitgateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2transitgateway.NewTransitGateway(ctx, "example", &ec2transitgateway.TransitGatewayArgs{
			Description: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ec2TransitGateway.TransitGateway("example", new()
    {
        Description = "example",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.TransitGateway;
import com.pulumi.aws.ec2transitgateway.TransitGatewayArgs;
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 example = new TransitGateway("example", TransitGatewayArgs.builder()
            .description("example")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ec2transitgateway:TransitGateway
    properties:
      description: example
Copy

Create TransitGateway Resource

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

Constructor syntax

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

@overload
def TransitGateway(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   amazon_side_asn: Optional[int] = None,
                   auto_accept_shared_attachments: Optional[str] = None,
                   default_route_table_association: Optional[str] = None,
                   default_route_table_propagation: Optional[str] = None,
                   description: Optional[str] = None,
                   dns_support: Optional[str] = None,
                   multicast_support: Optional[str] = None,
                   security_group_referencing_support: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   transit_gateway_cidr_blocks: Optional[Sequence[str]] = None,
                   vpn_ecmp_support: Optional[str] = None)
func NewTransitGateway(ctx *Context, name string, args *TransitGatewayArgs, opts ...ResourceOption) (*TransitGateway, error)
public TransitGateway(string name, TransitGatewayArgs? args = null, CustomResourceOptions? opts = null)
public TransitGateway(String name, TransitGatewayArgs args)
public TransitGateway(String name, TransitGatewayArgs args, CustomResourceOptions options)

type: aws:ec2transitgateway:TransitGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args TransitGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args TransitGatewayArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args TransitGatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args TransitGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TransitGatewayArgs
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 transitGatewayResource = new Aws.Ec2TransitGateway.TransitGateway("transitGatewayResource", new()
{
    AmazonSideAsn = 0,
    AutoAcceptSharedAttachments = "string",
    DefaultRouteTableAssociation = "string",
    DefaultRouteTablePropagation = "string",
    Description = "string",
    DnsSupport = "string",
    MulticastSupport = "string",
    SecurityGroupReferencingSupport = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TransitGatewayCidrBlocks = new[]
    {
        "string",
    },
    VpnEcmpSupport = "string",
});
Copy
example, err := ec2transitgateway.NewTransitGateway(ctx, "transitGatewayResource", &ec2transitgateway.TransitGatewayArgs{
	AmazonSideAsn:                   pulumi.Int(0),
	AutoAcceptSharedAttachments:     pulumi.String("string"),
	DefaultRouteTableAssociation:    pulumi.String("string"),
	DefaultRouteTablePropagation:    pulumi.String("string"),
	Description:                     pulumi.String("string"),
	DnsSupport:                      pulumi.String("string"),
	MulticastSupport:                pulumi.String("string"),
	SecurityGroupReferencingSupport: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TransitGatewayCidrBlocks: pulumi.StringArray{
		pulumi.String("string"),
	},
	VpnEcmpSupport: pulumi.String("string"),
})
Copy
var transitGatewayResource = new TransitGateway("transitGatewayResource", TransitGatewayArgs.builder()
    .amazonSideAsn(0)
    .autoAcceptSharedAttachments("string")
    .defaultRouteTableAssociation("string")
    .defaultRouteTablePropagation("string")
    .description("string")
    .dnsSupport("string")
    .multicastSupport("string")
    .securityGroupReferencingSupport("string")
    .tags(Map.of("string", "string"))
    .transitGatewayCidrBlocks("string")
    .vpnEcmpSupport("string")
    .build());
Copy
transit_gateway_resource = aws.ec2transitgateway.TransitGateway("transitGatewayResource",
    amazon_side_asn=0,
    auto_accept_shared_attachments="string",
    default_route_table_association="string",
    default_route_table_propagation="string",
    description="string",
    dns_support="string",
    multicast_support="string",
    security_group_referencing_support="string",
    tags={
        "string": "string",
    },
    transit_gateway_cidr_blocks=["string"],
    vpn_ecmp_support="string")
Copy
const transitGatewayResource = new aws.ec2transitgateway.TransitGateway("transitGatewayResource", {
    amazonSideAsn: 0,
    autoAcceptSharedAttachments: "string",
    defaultRouteTableAssociation: "string",
    defaultRouteTablePropagation: "string",
    description: "string",
    dnsSupport: "string",
    multicastSupport: "string",
    securityGroupReferencingSupport: "string",
    tags: {
        string: "string",
    },
    transitGatewayCidrBlocks: ["string"],
    vpnEcmpSupport: "string",
});
Copy
type: aws:ec2transitgateway:TransitGateway
properties:
    amazonSideAsn: 0
    autoAcceptSharedAttachments: string
    defaultRouteTableAssociation: string
    defaultRouteTablePropagation: string
    description: string
    dnsSupport: string
    multicastSupport: string
    securityGroupReferencingSupport: string
    tags:
        string: string
    transitGatewayCidrBlocks:
        - string
    vpnEcmpSupport: string
Copy

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

AmazonSideAsn int

Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.

NOTE: Modifying amazon_side_asn on a Transit Gateway with active BGP sessions is not allowed. You must first delete all Transit Gateway attachments that have BGP configured prior to modifying amazon_side_asn.

AutoAcceptSharedAttachments string
Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
DefaultRouteTableAssociation string
Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
DefaultRouteTablePropagation string
Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
Description string
Description of the EC2 Transit Gateway.
DnsSupport string
Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
MulticastSupport Changes to this property will trigger replacement. string
Whether Multicast support is enabled. Required to use ec2_transit_gateway_multicast_domain. Valid values: disable, enable. Default value: disable.
SecurityGroupReferencingSupport string
Whether Security Group Referencing Support is enabled. Valid values: disable, enable. Default value: disable.
Tags Dictionary<string, string>
Key-value tags for the EC2 Transit Gateway. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TransitGatewayCidrBlocks List<string>
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
VpnEcmpSupport string
Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.
AmazonSideAsn int

Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.

NOTE: Modifying amazon_side_asn on a Transit Gateway with active BGP sessions is not allowed. You must first delete all Transit Gateway attachments that have BGP configured prior to modifying amazon_side_asn.

AutoAcceptSharedAttachments string
Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
DefaultRouteTableAssociation string
Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
DefaultRouteTablePropagation string
Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
Description string
Description of the EC2 Transit Gateway.
DnsSupport string
Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
MulticastSupport Changes to this property will trigger replacement. string
Whether Multicast support is enabled. Required to use ec2_transit_gateway_multicast_domain. Valid values: disable, enable. Default value: disable.
SecurityGroupReferencingSupport string
Whether Security Group Referencing Support is enabled. Valid values: disable, enable. Default value: disable.
Tags map[string]string
Key-value tags for the EC2 Transit Gateway. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TransitGatewayCidrBlocks []string
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
VpnEcmpSupport string
Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.
amazonSideAsn Integer

Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.

NOTE: Modifying amazon_side_asn on a Transit Gateway with active BGP sessions is not allowed. You must first delete all Transit Gateway attachments that have BGP configured prior to modifying amazon_side_asn.

autoAcceptSharedAttachments String
Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
defaultRouteTableAssociation String
Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
defaultRouteTablePropagation String
Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
description String
Description of the EC2 Transit Gateway.
dnsSupport String
Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
multicastSupport Changes to this property will trigger replacement. String
Whether Multicast support is enabled. Required to use ec2_transit_gateway_multicast_domain. Valid values: disable, enable. Default value: disable.
securityGroupReferencingSupport String
Whether Security Group Referencing Support is enabled. Valid values: disable, enable. Default value: disable.
tags Map<String,String>
Key-value tags for the EC2 Transit Gateway. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
transitGatewayCidrBlocks List<String>
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
vpnEcmpSupport String
Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.
amazonSideAsn number

Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.

NOTE: Modifying amazon_side_asn on a Transit Gateway with active BGP sessions is not allowed. You must first delete all Transit Gateway attachments that have BGP configured prior to modifying amazon_side_asn.

autoAcceptSharedAttachments string
Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
defaultRouteTableAssociation string
Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
defaultRouteTablePropagation string
Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
description string
Description of the EC2 Transit Gateway.
dnsSupport string
Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
multicastSupport Changes to this property will trigger replacement. string
Whether Multicast support is enabled. Required to use ec2_transit_gateway_multicast_domain. Valid values: disable, enable. Default value: disable.
securityGroupReferencingSupport string
Whether Security Group Referencing Support is enabled. Valid values: disable, enable. Default value: disable.
tags {[key: string]: string}
Key-value tags for the EC2 Transit Gateway. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
transitGatewayCidrBlocks string[]
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
vpnEcmpSupport string
Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.
amazon_side_asn int

Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.

NOTE: Modifying amazon_side_asn on a Transit Gateway with active BGP sessions is not allowed. You must first delete all Transit Gateway attachments that have BGP configured prior to modifying amazon_side_asn.

auto_accept_shared_attachments str
Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
default_route_table_association str
Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
default_route_table_propagation str
Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
description str
Description of the EC2 Transit Gateway.
dns_support str
Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
multicast_support Changes to this property will trigger replacement. str
Whether Multicast support is enabled. Required to use ec2_transit_gateway_multicast_domain. Valid values: disable, enable. Default value: disable.
security_group_referencing_support str
Whether Security Group Referencing Support is enabled. Valid values: disable, enable. Default value: disable.
tags Mapping[str, str]
Key-value tags for the EC2 Transit Gateway. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
transit_gateway_cidr_blocks Sequence[str]
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
vpn_ecmp_support str
Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.
amazonSideAsn Number

Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.

NOTE: Modifying amazon_side_asn on a Transit Gateway with active BGP sessions is not allowed. You must first delete all Transit Gateway attachments that have BGP configured prior to modifying amazon_side_asn.

autoAcceptSharedAttachments String
Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
defaultRouteTableAssociation String
Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
defaultRouteTablePropagation String
Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
description String
Description of the EC2 Transit Gateway.
dnsSupport String
Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
multicastSupport Changes to this property will trigger replacement. String
Whether Multicast support is enabled. Required to use ec2_transit_gateway_multicast_domain. Valid values: disable, enable. Default value: disable.
securityGroupReferencingSupport String
Whether Security Group Referencing Support is enabled. Valid values: disable, enable. Default value: disable.
tags Map<String>
Key-value tags for the EC2 Transit Gateway. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
transitGatewayCidrBlocks List<String>
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
vpnEcmpSupport String
Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.

Outputs

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

Arn string
EC2 Transit Gateway Amazon Resource Name (ARN)
AssociationDefaultRouteTableId string
Identifier of the default association route table
Id string
The provider-assigned unique ID for this managed resource.
OwnerId string
Identifier of the AWS account that owns the EC2 Transit Gateway
PropagationDefaultRouteTableId string
Identifier of the default propagation route table
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
EC2 Transit Gateway Amazon Resource Name (ARN)
AssociationDefaultRouteTableId string
Identifier of the default association route table
Id string
The provider-assigned unique ID for this managed resource.
OwnerId string
Identifier of the AWS account that owns the EC2 Transit Gateway
PropagationDefaultRouteTableId string
Identifier of the default propagation route table
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
EC2 Transit Gateway Amazon Resource Name (ARN)
associationDefaultRouteTableId String
Identifier of the default association route table
id String
The provider-assigned unique ID for this managed resource.
ownerId String
Identifier of the AWS account that owns the EC2 Transit Gateway
propagationDefaultRouteTableId String
Identifier of the default propagation route table
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn ARN
EC2 Transit Gateway Amazon Resource Name (ARN)
associationDefaultRouteTableId string
Identifier of the default association route table
id string
The provider-assigned unique ID for this managed resource.
ownerId string
Identifier of the AWS account that owns the EC2 Transit Gateway
propagationDefaultRouteTableId string
Identifier of the default propagation route table
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
EC2 Transit Gateway Amazon Resource Name (ARN)
association_default_route_table_id str
Identifier of the default association route table
id str
The provider-assigned unique ID for this managed resource.
owner_id str
Identifier of the AWS account that owns the EC2 Transit Gateway
propagation_default_route_table_id str
Identifier of the default propagation route table
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn
EC2 Transit Gateway Amazon Resource Name (ARN)
associationDefaultRouteTableId String
Identifier of the default association route table
id String
The provider-assigned unique ID for this managed resource.
ownerId String
Identifier of the AWS account that owns the EC2 Transit Gateway
propagationDefaultRouteTableId String
Identifier of the default propagation route table
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing TransitGateway Resource

Get an existing TransitGateway 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?: TransitGatewayState, opts?: CustomResourceOptions): TransitGateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        amazon_side_asn: Optional[int] = None,
        arn: Optional[str] = None,
        association_default_route_table_id: Optional[str] = None,
        auto_accept_shared_attachments: Optional[str] = None,
        default_route_table_association: Optional[str] = None,
        default_route_table_propagation: Optional[str] = None,
        description: Optional[str] = None,
        dns_support: Optional[str] = None,
        multicast_support: Optional[str] = None,
        owner_id: Optional[str] = None,
        propagation_default_route_table_id: Optional[str] = None,
        security_group_referencing_support: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        transit_gateway_cidr_blocks: Optional[Sequence[str]] = None,
        vpn_ecmp_support: Optional[str] = None) -> TransitGateway
func GetTransitGateway(ctx *Context, name string, id IDInput, state *TransitGatewayState, opts ...ResourceOption) (*TransitGateway, error)
public static TransitGateway Get(string name, Input<string> id, TransitGatewayState? state, CustomResourceOptions? opts = null)
public static TransitGateway get(String name, Output<String> id, TransitGatewayState state, CustomResourceOptions options)
resources:  _:    type: aws:ec2transitgateway:TransitGateway    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AmazonSideAsn int

Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.

NOTE: Modifying amazon_side_asn on a Transit Gateway with active BGP sessions is not allowed. You must first delete all Transit Gateway attachments that have BGP configured prior to modifying amazon_side_asn.

Arn string
EC2 Transit Gateway Amazon Resource Name (ARN)
AssociationDefaultRouteTableId string
Identifier of the default association route table
AutoAcceptSharedAttachments string
Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
DefaultRouteTableAssociation string
Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
DefaultRouteTablePropagation string
Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
Description string
Description of the EC2 Transit Gateway.
DnsSupport string
Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
MulticastSupport Changes to this property will trigger replacement. string
Whether Multicast support is enabled. Required to use ec2_transit_gateway_multicast_domain. Valid values: disable, enable. Default value: disable.
OwnerId string
Identifier of the AWS account that owns the EC2 Transit Gateway
PropagationDefaultRouteTableId string
Identifier of the default propagation route table
SecurityGroupReferencingSupport string
Whether Security Group Referencing Support is enabled. Valid values: disable, enable. Default value: disable.
Tags Dictionary<string, string>
Key-value tags for the EC2 Transit Gateway. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

TransitGatewayCidrBlocks List<string>
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
VpnEcmpSupport string
Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.
AmazonSideAsn int

Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.

NOTE: Modifying amazon_side_asn on a Transit Gateway with active BGP sessions is not allowed. You must first delete all Transit Gateway attachments that have BGP configured prior to modifying amazon_side_asn.

Arn string
EC2 Transit Gateway Amazon Resource Name (ARN)
AssociationDefaultRouteTableId string
Identifier of the default association route table
AutoAcceptSharedAttachments string
Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
DefaultRouteTableAssociation string
Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
DefaultRouteTablePropagation string
Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
Description string
Description of the EC2 Transit Gateway.
DnsSupport string
Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
MulticastSupport Changes to this property will trigger replacement. string
Whether Multicast support is enabled. Required to use ec2_transit_gateway_multicast_domain. Valid values: disable, enable. Default value: disable.
OwnerId string
Identifier of the AWS account that owns the EC2 Transit Gateway
PropagationDefaultRouteTableId string
Identifier of the default propagation route table
SecurityGroupReferencingSupport string
Whether Security Group Referencing Support is enabled. Valid values: disable, enable. Default value: disable.
Tags map[string]string
Key-value tags for the EC2 Transit Gateway. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

TransitGatewayCidrBlocks []string
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
VpnEcmpSupport string
Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.
amazonSideAsn Integer

Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.

NOTE: Modifying amazon_side_asn on a Transit Gateway with active BGP sessions is not allowed. You must first delete all Transit Gateway attachments that have BGP configured prior to modifying amazon_side_asn.

arn String
EC2 Transit Gateway Amazon Resource Name (ARN)
associationDefaultRouteTableId String
Identifier of the default association route table
autoAcceptSharedAttachments String
Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
defaultRouteTableAssociation String
Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
defaultRouteTablePropagation String
Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
description String
Description of the EC2 Transit Gateway.
dnsSupport String
Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
multicastSupport Changes to this property will trigger replacement. String
Whether Multicast support is enabled. Required to use ec2_transit_gateway_multicast_domain. Valid values: disable, enable. Default value: disable.
ownerId String
Identifier of the AWS account that owns the EC2 Transit Gateway
propagationDefaultRouteTableId String
Identifier of the default propagation route table
securityGroupReferencingSupport String
Whether Security Group Referencing Support is enabled. Valid values: disable, enable. Default value: disable.
tags Map<String,String>
Key-value tags for the EC2 Transit Gateway. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

transitGatewayCidrBlocks List<String>
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
vpnEcmpSupport String
Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.
amazonSideAsn number

Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.

NOTE: Modifying amazon_side_asn on a Transit Gateway with active BGP sessions is not allowed. You must first delete all Transit Gateway attachments that have BGP configured prior to modifying amazon_side_asn.

arn ARN
EC2 Transit Gateway Amazon Resource Name (ARN)
associationDefaultRouteTableId string
Identifier of the default association route table
autoAcceptSharedAttachments string
Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
defaultRouteTableAssociation string
Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
defaultRouteTablePropagation string
Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
description string
Description of the EC2 Transit Gateway.
dnsSupport string
Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
multicastSupport Changes to this property will trigger replacement. string
Whether Multicast support is enabled. Required to use ec2_transit_gateway_multicast_domain. Valid values: disable, enable. Default value: disable.
ownerId string
Identifier of the AWS account that owns the EC2 Transit Gateway
propagationDefaultRouteTableId string
Identifier of the default propagation route table
securityGroupReferencingSupport string
Whether Security Group Referencing Support is enabled. Valid values: disable, enable. Default value: disable.
tags {[key: string]: string}
Key-value tags for the EC2 Transit Gateway. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

transitGatewayCidrBlocks string[]
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
vpnEcmpSupport string
Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.
amazon_side_asn int

Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.

NOTE: Modifying amazon_side_asn on a Transit Gateway with active BGP sessions is not allowed. You must first delete all Transit Gateway attachments that have BGP configured prior to modifying amazon_side_asn.

arn str
EC2 Transit Gateway Amazon Resource Name (ARN)
association_default_route_table_id str
Identifier of the default association route table
auto_accept_shared_attachments str
Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
default_route_table_association str
Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
default_route_table_propagation str
Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
description str
Description of the EC2 Transit Gateway.
dns_support str
Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
multicast_support Changes to this property will trigger replacement. str
Whether Multicast support is enabled. Required to use ec2_transit_gateway_multicast_domain. Valid values: disable, enable. Default value: disable.
owner_id str
Identifier of the AWS account that owns the EC2 Transit Gateway
propagation_default_route_table_id str
Identifier of the default propagation route table
security_group_referencing_support str
Whether Security Group Referencing Support is enabled. Valid values: disable, enable. Default value: disable.
tags Mapping[str, str]
Key-value tags for the EC2 Transit Gateway. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

transit_gateway_cidr_blocks Sequence[str]
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
vpn_ecmp_support str
Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.
amazonSideAsn Number

Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.

NOTE: Modifying amazon_side_asn on a Transit Gateway with active BGP sessions is not allowed. You must first delete all Transit Gateway attachments that have BGP configured prior to modifying amazon_side_asn.

arn
EC2 Transit Gateway Amazon Resource Name (ARN)
associationDefaultRouteTableId String
Identifier of the default association route table
autoAcceptSharedAttachments String
Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
defaultRouteTableAssociation String
Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
defaultRouteTablePropagation String
Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
description String
Description of the EC2 Transit Gateway.
dnsSupport String
Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
multicastSupport Changes to this property will trigger replacement. String
Whether Multicast support is enabled. Required to use ec2_transit_gateway_multicast_domain. Valid values: disable, enable. Default value: disable.
ownerId String
Identifier of the AWS account that owns the EC2 Transit Gateway
propagationDefaultRouteTableId String
Identifier of the default propagation route table
securityGroupReferencingSupport String
Whether Security Group Referencing Support is enabled. Valid values: disable, enable. Default value: disable.
tags Map<String>
Key-value tags for the EC2 Transit Gateway. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

transitGatewayCidrBlocks List<String>
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
vpnEcmpSupport String
Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.

Import

Using pulumi import, import aws_ec2_transit_gateway using the EC2 Transit Gateway identifier. For example:

$ pulumi import aws:ec2transitgateway/transitGateway:TransitGateway example tgw-12345678
Copy

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

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws