We recommend new projects start with resources from the AWS provider.
aws-native.ec2.TransitGateway
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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:
- Amazon
Side intAsn - 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 stringRoute Table Id - The ID of the default association route table.
- string
- Enable or disable automatic acceptance of attachment requests. Disabled by default.
- Default
Route stringTable Association - Enable or disable automatic association with the default association route table. Enabled by default.
- Default
Route stringTable Propagation - Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
- Description string
- The description of the transit gateway.
- Dns
Support string - Enable or disable DNS support. Enabled by default.
- Multicast
Support string - Indicates whether multicast is enabled on the transit gateway
- Propagation
Default stringRoute Table Id - The ID of the default propagation route table.
- Security
Group stringReferencing Support 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 .
- List<Pulumi.
Aws Native. Inputs. Tag> - The tags for the transit gateway.
- Transit
Gateway List<string>Cidr Blocks - The transit gateway CIDR blocks.
- Vpn
Ecmp stringSupport - Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
- Amazon
Side intAsn - 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 stringRoute Table Id - The ID of the default association route table.
- string
- Enable or disable automatic acceptance of attachment requests. Disabled by default.
- Default
Route stringTable Association - Enable or disable automatic association with the default association route table. Enabled by default.
- Default
Route stringTable Propagation - Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
- Description string
- The description of the transit gateway.
- Dns
Support string - Enable or disable DNS support. Enabled by default.
- Multicast
Support string - Indicates whether multicast is enabled on the transit gateway
- Propagation
Default stringRoute Table Id - The ID of the default propagation route table.
- Security
Group stringReferencing Support 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 .
- Tag
Args - The tags for the transit gateway.
- Transit
Gateway []stringCidr Blocks - The transit gateway CIDR blocks.
- Vpn
Ecmp stringSupport - Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
- amazon
Side IntegerAsn - 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 StringRoute Table Id - The ID of the default association route table.
- String
- Enable or disable automatic acceptance of attachment requests. Disabled by default.
- default
Route StringTable Association - Enable or disable automatic association with the default association route table. Enabled by default.
- default
Route StringTable Propagation - Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
- description String
- The description of the transit gateway.
- dns
Support String - Enable or disable DNS support. Enabled by default.
- multicast
Support String - Indicates whether multicast is enabled on the transit gateway
- propagation
Default StringRoute Table Id - The ID of the default propagation route table.
- security
Group StringReferencing Support 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 .
- List<Tag>
- The tags for the transit gateway.
- transit
Gateway List<String>Cidr Blocks - The transit gateway CIDR blocks.
- vpn
Ecmp StringSupport - Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
- amazon
Side numberAsn - 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 stringRoute Table Id - The ID of the default association route table.
- string
- Enable or disable automatic acceptance of attachment requests. Disabled by default.
- default
Route stringTable Association - Enable or disable automatic association with the default association route table. Enabled by default.
- default
Route stringTable Propagation - Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
- description string
- The description of the transit gateway.
- dns
Support string - Enable or disable DNS support. Enabled by default.
- multicast
Support string - Indicates whether multicast is enabled on the transit gateway
- propagation
Default stringRoute Table Id - The ID of the default propagation route table.
- security
Group stringReferencing Support 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 .
- Tag[]
- The tags for the transit gateway.
- transit
Gateway string[]Cidr Blocks - The transit gateway CIDR blocks.
- vpn
Ecmp stringSupport - Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
- amazon_
side_ intasn - 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_ strroute_ table_ id - The ID of the default association route table.
- str
- Enable or disable automatic acceptance of attachment requests. Disabled by default.
- default_
route_ strtable_ association - Enable or disable automatic association with the default association route table. Enabled by default.
- default_
route_ strtable_ propagation - 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_ strroute_ table_ id - The ID of the default propagation route table.
- security_
group_ strreferencing_ support 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 .
- Sequence[Tag
Args] - The tags for the transit gateway.
- transit_
gateway_ Sequence[str]cidr_ blocks - The transit gateway CIDR blocks.
- vpn_
ecmp_ strsupport - Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
- amazon
Side NumberAsn - 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 StringRoute Table Id - The ID of the default association route table.
- String
- Enable or disable automatic acceptance of attachment requests. Disabled by default.
- default
Route StringTable Association - Enable or disable automatic association with the default association route table. Enabled by default.
- default
Route StringTable Propagation - Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
- description String
- The description of the transit gateway.
- dns
Support String - Enable or disable DNS support. Enabled by default.
- multicast
Support String - Indicates whether multicast is enabled on the transit gateway
- propagation
Default StringRoute Table Id - The ID of the default propagation route table.
- security
Group StringReferencing Support 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 .
- List<Property Map>
- The tags for the transit gateway.
- transit
Gateway List<String>Cidr Blocks - The transit gateway CIDR blocks.
- vpn
Ecmp StringSupport - 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:
- Aws
Id string - The ID of the transit gateway.
- Id string
- The provider-assigned unique ID for this managed resource.
- Transit
Gateway stringArn
- Aws
Id string - The ID of the transit gateway.
- Id string
- The provider-assigned unique ID for this managed resource.
- Transit
Gateway stringArn
- aws
Id String - The ID of the transit gateway.
- id String
- The provider-assigned unique ID for this managed resource.
- transit
Gateway StringArn
- aws
Id string - The ID of the transit gateway.
- id string
- The provider-assigned unique ID for this managed resource.
- transit
Gateway stringArn
- aws_
id str - The ID of the transit gateway.
- id str
- The provider-assigned unique ID for this managed resource.
- transit_
gateway_ strarn
- aws
Id String - The ID of the transit gateway.
- id String
- The provider-assigned unique ID for this managed resource.
- transit
Gateway StringArn
Supporting Types
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.