ec2_describe_route_tables {aws.ecx}

Describe Route Tables

Description

Describe Route Tables

Usage

ec2_describe_route_tables(
  Filter = NULL,
  DryRun = NULL,
  RouteTableId = NULL,
  NextToken = NULL,
  MaxResults = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

RouteTableId

List. One or more route table IDs. Default: Describes all your route tables. [optional]

NextToken

Characters. The token for the next page of results[optional]

MaxResults

Integer. The maximum number of results to return with a single call.[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

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. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation 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.

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.

RouteTableId

One or more route table IDs.

Default: Describes all your route tables.

MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.