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 CreateRoute API operation.

Syntax

New-EC2Route
-RouteTableId <String>
-DestinationCidrBlock <String>
-GatewayId <String>
-InstanceId <String>
-NetworkInterfaceId <String>
-DestinationIpv6CidrBlock <String>
-EgressOnlyInternetGatewayId <String>
-NatGatewayId <String>
-TransitGatewayId <String>
-VpcPeeringConnectionId <String>
-Force <SwitchParameter>

Description

Creates a route in a route table within a VPC. You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway. When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:
  • 192.0.2.0/24 (goes to some target A)
  • 192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

Parameters

-DestinationCidrBlock <String>
The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match.
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-DestinationIpv6CidrBlock <String>
The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
Required?False
Position?Named
Accept pipeline input?False
-EgressOnlyInternetGatewayId <String>
[IPv6 traffic only] The ID of an egress-only internet gateway.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-GatewayId <String>
The ID of an internet gateway or virtual private gateway attached to your VPC.
Required?False
Position?3
Accept pipeline input?True (ByPropertyName)
-InstanceId <String>
The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
Required?False
Position?4
Accept pipeline input?True (ByPropertyName)
-NatGatewayId <String>
[IPv4 traffic only] The ID of a NAT gateway.
Required?False
Position?Named
Accept pipeline input?False
-NetworkInterfaceId <String>
The ID of a network interface.
Required?False
Position?5
Accept pipeline input?True (ByPropertyName)
-RouteTableId <String>
The ID of the route table for the route.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-TransitGatewayId <String>
The ID of a transit gateway.
Required?False
Position?Named
Accept pipeline input?False
-VpcPeeringConnectionId <String>
The ID of a VPC peering connection.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

System.String
You can pipe a String object to this cmdlet for the RouteTableId parameter.

Outputs

System.Boolean
This cmdlet returns a System.Boolean object. The service call response (type Amazon.EC2.Model.CreateRouteResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\> New-EC2Route -RouteTableId rtb-1a2b3c4d -DestinationCidrBlock 0.0.0.0/0 -GatewayId igw-1a2b3c4d
    
True
This example creates the specified route for the specified route table. The route matches all traffic and sends it to the specified Internet gateway.
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