Skip to content

Describe Route Tables

ec2_describe_route_tables R Documentation

Describes your route tables

Description

Describes your route tables. The default is to describe all your route tables. Alternatively, you can specify specific route table IDs or filter the results to include only the route tables that match specific criteria.

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 VPC User Guide.

Usage

ec2_describe_route_tables(NextToken, MaxResults, DryRun, RouteTableIds,
  Filters)

Arguments

NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
RouteTableIds

The IDs of the route tables.
Filters

The filters.

  • association.gateway-id - The ID of the gateway involved in the association.

  • 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 Amazon Web Services 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 Amazon Web Services 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. create_route_table indicates that the route was automatically created when the route table was created; create_route indicates that the route was manually added to the route table; enable_vgw_route_propagation indicates 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 - 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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for 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.

  • vpc-id - The ID of the VPC for the route table.

Value

A list with the following syntax:

list(
  RouteTables = list(
    list(
      Associations = list(
        list(
          Main = TRUE|FALSE,
          RouteTableAssociationId = "string",
          RouteTableId = "string",
          SubnetId = "string",
          GatewayId = "string",
          AssociationState = list(
            State = "associating"|"associated"|"disassociating"|"disassociated"|"failed",
            StatusMessage = "string"
          )
        )
      ),
      PropagatingVgws = list(
        list(
          GatewayId = "string"
        )
      ),
      RouteTableId = "string",
      Routes = list(
        list(
          DestinationCidrBlock = "string",
          DestinationIpv6CidrBlock = "string",
          DestinationPrefixListId = "string",
          EgressOnlyInternetGatewayId = "string",
          GatewayId = "string",
          InstanceId = "string",
          InstanceOwnerId = "string",
          NatGatewayId = "string",
          TransitGatewayId = "string",
          LocalGatewayId = "string",
          CarrierGatewayId = "string",
          NetworkInterfaceId = "string",
          Origin = "CreateRouteTable"|"CreateRoute"|"EnableVgwRoutePropagation",
          State = "active"|"blackhole",
          VpcPeeringConnectionId = "string",
          CoreNetworkArn = "string"
        )
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      VpcId = "string",
      OwnerId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_route_tables(
  NextToken = "string",
  MaxResults = 123,
  DryRun = TRUE|FALSE,
  RouteTableIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  )
)

Examples

## Not run: 
# This example describes the specified route table.
svc$describe_route_tables(
  RouteTableIds = list(
    "rtb-1f382e7d"
  )
)

## End(Not run)