Synopsis
Calls the Amazon Elastic Compute Cloud DescribeRouteTables API operation.
Syntax
Get-EC2RouteTable-RouteTableId <String[]>-Filter <Filter[]>-MaxResult <Int32>-NextToken <String>
Description
Describes one or more of your route tables.
Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
Parameters
-Filter <Filter[]>
One or more filters.
association.route-table-association-id- The ID of an association ID for the route table.association.route-table-id- The ID of the route table involved in the association.association.subnet-id- The ID of the subnet involved in the association.association.main- Indicates whether the route table is the main route table for the VPC (true|false). Route tables that do not have an association ID are not returned in the response.owner-id- The ID of the AWS account that owns the route table.route-table-id- The ID of the route table.route.destination-cidr-block- The IPv4 CIDR range specified in a route in the table.route.destination-ipv6-cidr-block- The IPv6 CIDR range specified in a route in the route table.route.destination-prefix-list-id- The ID (prefix) of the AWS service specified in a route in the table.route.egress-only-internet-gateway-id- The ID of an egress-only Internet gateway specified in a route in the route table.route.gateway-id- The ID of a gateway specified in a route in the table.route.instance-id- The ID of an instance specified in a route in the table.route.nat-gateway-id- The ID of a NAT gateway.route.transit-gateway-id- The ID of a transit gateway.route.origin- Describes how the route was created.CreateRouteTableindicates that the route was automatically created when the route table was created;CreateRouteindicates that the route was manually added to the route table;EnableVgwRoutePropagationindicates that the route was propagated by route propagation.route.state- The state of a route in the route table (active|blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).route.vpc-peering-connection-id- The ID of a VPC peering connection specified in a route in the table.tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value.tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.transit-gateway-id- The ID of a transit gateway.vpc-id- The ID of the VPC for the route table.
| Required? | False |
| Position? | 2 |
| Accept pipeline input? | False |
| Aliases | Filters |
-MaxResult <Int32>
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned
nextToken value. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | MaxItems, MaxResults |
-NextToken <String>
The token for the next page of results.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-RouteTableId <String[]>
One or more route table IDs.Default: Describes all your route tables.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ByPropertyName) |
| Aliases | RouteTableIds |
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
You can pipe a String[] object to this cmdlet for the RouteTableId parameter.
Outputs
This cmdlet returns a collection of Amazon.EC2.Model.RouteTable objects.
The service call response (type Amazon.EC2.Model.DescribeRouteTablesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)
Examples
Example 1
Get-EC2RouteTable
DestinationCidrBlock : 10.0.0.0/16
DestinationPrefixListId :
GatewayId : local
InstanceId :
InstanceOwnerId :
NetworkInterfaceId :
Origin : CreateRouteTable
State : active
VpcPeeringConnectionId :
DestinationCidrBlock : 0.0.0.0/0
DestinationPrefixListId :
GatewayId : igw-1a2b3c4d
InstanceId :
InstanceOwnerId :
NetworkInterfaceId :
Origin : CreateRoute
State : active
VpcPeeringConnectionId :This example describes all your route tables.
Example 2
PS C:\>Get-EC2RouteTable -RouteTableId rtb-1a2b3c4dThis example returns details for the specified route table.
Example 3
Get-EC2RouteTable -Filter @{ Name="vpc-id"; Value="vpc-1a2b3c4d" }
Associations : {rtbassoc-12345678}
PropagatingVgws : {}
Routes : {, }
RouteTableId : rtb-1a2b3c4d
Tags : {}
VpcId : vpc-1a2b3c4dThis example describes the route tables for the specified VPC.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
