Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ec2
  5. TransitGateway

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ec2.TransitGateway

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::EC2::TransitGateway

    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,
                   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,
                   propagation_default_route_table_id: Optional[str] = None,
                   security_group_referencing_support: Optional[str] = None,
                   tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:ec2:TransitGateway
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 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.
    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 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.
    name String
    The unique name of the resource.
    args TransitGatewayArgs
    The arguments to resource properties.
    options 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 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
    A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs. The default is 64512.
    AssociationDefaultRouteTableId string
    The ID of the default association route table.
    AutoAcceptSharedAttachments string
    Enable or disable automatic acceptance of attachment requests. Disabled by default.
    DefaultRouteTableAssociation string
    Enable or disable automatic association with the default association route table. Enabled by default.
    DefaultRouteTablePropagation string
    Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
    Description string
    The description of the transit gateway.
    DnsSupport string
    Enable or disable DNS support. Enabled by default.
    MulticastSupport string
    Indicates whether multicast is enabled on the transit gateway
    PropagationDefaultRouteTableId string
    The ID of the default propagation route table.
    SecurityGroupReferencingSupport string

    Enables you to reference a security group across VPCs attached to a transit gateway (TGW). Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

    For important information about this feature, see Create a transit gateway in the AWS Transit Gateway Guide .

    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags for the transit gateway.
    TransitGatewayCidrBlocks List<string>
    The transit gateway CIDR blocks.
    VpnEcmpSupport string
    Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
    AmazonSideAsn int
    A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs. The default is 64512.
    AssociationDefaultRouteTableId string
    The ID of the default association route table.
    AutoAcceptSharedAttachments string
    Enable or disable automatic acceptance of attachment requests. Disabled by default.
    DefaultRouteTableAssociation string
    Enable or disable automatic association with the default association route table. Enabled by default.
    DefaultRouteTablePropagation string
    Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
    Description string
    The description of the transit gateway.
    DnsSupport string
    Enable or disable DNS support. Enabled by default.
    MulticastSupport string
    Indicates whether multicast is enabled on the transit gateway
    PropagationDefaultRouteTableId string
    The ID of the default propagation route table.
    SecurityGroupReferencingSupport string

    Enables you to reference a security group across VPCs attached to a transit gateway (TGW). Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

    For important information about this feature, see Create a transit gateway in the AWS Transit Gateway Guide .

    Tags TagArgs
    The tags for the transit gateway.
    TransitGatewayCidrBlocks []string
    The transit gateway CIDR blocks.
    VpnEcmpSupport string
    Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
    amazonSideAsn Integer
    A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs. The default is 64512.
    associationDefaultRouteTableId String
    The ID of the default association route table.
    autoAcceptSharedAttachments String
    Enable or disable automatic acceptance of attachment requests. Disabled by default.
    defaultRouteTableAssociation String
    Enable or disable automatic association with the default association route table. Enabled by default.
    defaultRouteTablePropagation String
    Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
    description String
    The description of the transit gateway.
    dnsSupport String
    Enable or disable DNS support. Enabled by default.
    multicastSupport String
    Indicates whether multicast is enabled on the transit gateway
    propagationDefaultRouteTableId String
    The ID of the default propagation route table.
    securityGroupReferencingSupport String

    Enables you to reference a security group across VPCs attached to a transit gateway (TGW). Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

    For important information about this feature, see Create a transit gateway in the AWS Transit Gateway Guide .

    tags List<Tag>
    The tags for the transit gateway.
    transitGatewayCidrBlocks List<String>
    The transit gateway CIDR blocks.
    vpnEcmpSupport String
    Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
    amazonSideAsn number
    A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs. The default is 64512.
    associationDefaultRouteTableId string
    The ID of the default association route table.
    autoAcceptSharedAttachments string
    Enable or disable automatic acceptance of attachment requests. Disabled by default.
    defaultRouteTableAssociation string
    Enable or disable automatic association with the default association route table. Enabled by default.
    defaultRouteTablePropagation string
    Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
    description string
    The description of the transit gateway.
    dnsSupport string
    Enable or disable DNS support. Enabled by default.
    multicastSupport string
    Indicates whether multicast is enabled on the transit gateway
    propagationDefaultRouteTableId string
    The ID of the default propagation route table.
    securityGroupReferencingSupport string

    Enables you to reference a security group across VPCs attached to a transit gateway (TGW). Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

    For important information about this feature, see Create a transit gateway in the AWS Transit Gateway Guide .

    tags Tag[]
    The tags for the transit gateway.
    transitGatewayCidrBlocks string[]
    The transit gateway CIDR blocks.
    vpnEcmpSupport string
    Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
    amazon_side_asn int
    A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs. The default is 64512.
    association_default_route_table_id str
    The ID of the default association route table.
    auto_accept_shared_attachments str
    Enable or disable automatic acceptance of attachment requests. Disabled by default.
    default_route_table_association str
    Enable or disable automatic association with the default association route table. Enabled by default.
    default_route_table_propagation str
    Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
    description str
    The description of the transit gateway.
    dns_support str
    Enable or disable DNS support. Enabled by default.
    multicast_support str
    Indicates whether multicast is enabled on the transit gateway
    propagation_default_route_table_id str
    The ID of the default propagation route table.
    security_group_referencing_support str

    Enables you to reference a security group across VPCs attached to a transit gateway (TGW). Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

    For important information about this feature, see Create a transit gateway in the AWS Transit Gateway Guide .

    tags Sequence[TagArgs]
    The tags for the transit gateway.
    transit_gateway_cidr_blocks Sequence[str]
    The transit gateway CIDR blocks.
    vpn_ecmp_support str
    Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
    amazonSideAsn Number
    A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs. The default is 64512.
    associationDefaultRouteTableId String
    The ID of the default association route table.
    autoAcceptSharedAttachments String
    Enable or disable automatic acceptance of attachment requests. Disabled by default.
    defaultRouteTableAssociation String
    Enable or disable automatic association with the default association route table. Enabled by default.
    defaultRouteTablePropagation String
    Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
    description String
    The description of the transit gateway.
    dnsSupport String
    Enable or disable DNS support. Enabled by default.
    multicastSupport String
    Indicates whether multicast is enabled on the transit gateway
    propagationDefaultRouteTableId String
    The ID of the default propagation route table.
    securityGroupReferencingSupport String

    Enables you to reference a security group across VPCs attached to a transit gateway (TGW). Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

    For important information about this feature, see Create a transit gateway in the AWS Transit Gateway Guide .

    tags List<Property Map>
    The tags for the transit gateway.
    transitGatewayCidrBlocks List<String>
    The transit gateway CIDR blocks.
    vpnEcmpSupport String
    Enable or disable Equal Cost Multipath Protocol support. Enabled by default.

    Outputs

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

    AwsId string
    The ID of the transit gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    TransitGatewayArn string
    AwsId string
    The ID of the transit gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    TransitGatewayArn string
    awsId String
    The ID of the transit gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    transitGatewayArn String
    awsId string
    The ID of the transit gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    transitGatewayArn string
    aws_id str
    The ID of the transit gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    transit_gateway_arn str
    awsId String
    The ID of the transit gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    transitGatewayArn String

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native