AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Elastic Compute Cloud (EC2) CreateTransitGateway API operation.

Syntax

New-EC2TransitGateway
-Options_AmazonSideAsn <Int64>
-Options_AutoAcceptSharedAttachment <AutoAcceptSharedAttachmentsValue>
-Options_DefaultRouteTableAssociation <DefaultRouteTableAssociationValue>
-Options_DefaultRouteTablePropagation <DefaultRouteTablePropagationValue>
-Description <String>
-Options_DnsSupport <DnsSupportValue>
-Options_MulticastSupport <MulticastSupportValue>
-TagSpecification <TagSpecification[]>
-Options_TransitGatewayCidrBlock <String[]>
-Options_VpnEcmpSupport <VpnEcmpSupportValue>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonEC2Config>

Description

Creates a transit gateway. You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway. To attach your VPCs, use CreateTransitGatewayVpcAttachment. To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection. When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.

Parameters

-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description of the transit gateway.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_AmazonSideAsn <Int64>
A 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. The default is 64512.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_AutoAcceptSharedAttachment <AutoAcceptSharedAttachmentsValue>
Enable or disable automatic acceptance of attachment requests. Disabled by default.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOptions_AutoAcceptSharedAttachments
-Options_DefaultRouteTableAssociation <DefaultRouteTableAssociationValue>
Enable or disable automatic association with the default association route table. Enabled by default.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_DefaultRouteTablePropagation <DefaultRouteTablePropagationValue>
Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_DnsSupport <DnsSupportValue>
Enable or disable DNS support. Enabled by default.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_MulticastSupport <MulticastSupportValue>
Indicates whether multicast is enabled on the transit gateway
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_TransitGatewayCidrBlock <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOptions_TransitGatewayCidrBlocks
-Options_VpnEcmpSupport <VpnEcmpSupportValue>
Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'TransitGateway'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.CreateTransitGatewayResponse). Specifying the name of a property of type Amazon.EC2.Model.CreateTransitGatewayResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TagSpecification <TagSpecification[]>
The tags to apply to the transit gateway.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTagSpecifications

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.EC2.Model.TransitGateway or Amazon.EC2.Model.CreateTransitGatewayResponse
This cmdlet returns an Amazon.EC2.Model.TransitGateway object. The service call response (type Amazon.EC2.Model.CreateTransitGatewayResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Service API Reference
Microsoft Windows Guide
VPC User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z