TransitGateway

Manages an EC2 Transit Gateway.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Ec2TransitGateway.TransitGateway("example", new Aws.Ec2TransitGateway.TransitGatewayArgs
        {
            Description = "example",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/ec2transitgateway"
    "github.com/pulumi/pulumi/sdk/v2/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
    })
}

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.TransitGateway("example", description="example")

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

const example = new aws.ec2transitgateway.TransitGateway("example", {
    description: "example",
});

Create a TransitGateway Resource

new TransitGateway(name: string, args?: TransitGatewayArgs, opts?: CustomResourceOptions);

def TransitGateway(resource_name, opts=None, amazon_side_asn=None, auto_accept_shared_attachments=None, default_route_table_association=None, default_route_table_propagation=None, description=None, dns_support=None, tags=None, vpn_ecmp_support=None, __props__=None);

func NewTransitGateway(ctx *Context, name string, args *TransitGatewayArgs, opts ...ResourceOption) (*TransitGateway, error)

public TransitGateway(string name, TransitGatewayArgs? args = null, CustomResourceOptions? opts = null)

name 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 str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name 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 string: The unique name of the resource.
args TransitGatewayArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

TransitGateway Resource Properties

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

Inputs

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.
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.
Tags Dictionary<string, string>: Key-value tags for the EC2 Transit Gateway.
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.
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.
Tags map[string]string: Key-value tags for the EC2 Transit Gateway.
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.
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.
tags {[key: string]: string}: Key-value tags for the EC2 Transit Gateway.
vpnEcmpSupport string: Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.

amazon_side_asn float: 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.
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.
tags Dict[str, str]: Key-value tags for the EC2 Transit Gateway.
vpn_ecmp_support str: 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

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

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

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

Look up an 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

static get(resource_name, id, opts=None, amazon_side_asn=None, arn=None, association_default_route_table_id=None, auto_accept_shared_attachments=None, default_route_table_association=None, default_route_table_propagation=None, description=None, dns_support=None, owner_id=None, propagation_default_route_table_id=None, tags=None, vpn_ecmp_support=None, __props__=None);

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)

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.

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.
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.
OwnerId string: Identifier of the AWS account that owns the EC2 Transit Gateway
PropagationDefaultRouteTableId string: Identifier of the default propagation route table
Tags Dictionary<string, string>: Key-value tags for the EC2 Transit Gateway.
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.
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.
OwnerId string: Identifier of the AWS account that owns the EC2 Transit Gateway
PropagationDefaultRouteTableId string: Identifier of the default propagation route table
Tags map[string]string: Key-value tags for the EC2 Transit Gateway.
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.
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.
ownerId string: Identifier of the AWS account that owns the EC2 Transit Gateway
propagationDefaultRouteTableId string: Identifier of the default propagation route table
tags {[key: string]: string}: Key-value tags for the EC2 Transit Gateway.
vpnEcmpSupport string: Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.

amazon_side_asn float: 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.
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.
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 Dict[str, str]: Key-value tags for the EC2 Transit Gateway.
vpn_ecmp_support str: Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud