ec2_search_transit_gateway_routes {aws.ecx}

Search Transit Gateway Routes

Description

Searches for routes in the specified transit gateway route table.

Usage

ec2_search_transit_gateway_routes(
  TransitGatewayRouteTableId,
  Filter,
  MaxResults = NULL,
  DryRun = 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

TransitGatewayRouteTableId

Character. The ID of the transit gateway route table.

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]

MaxResults

Integer. The maximum number of routes to return.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[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

TransitGatewayRouteTableId

The ID of the transit gateway route table.

Filter

One or more filters. The possible values are:

• attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.

• attachment.resource-id - The resource id of the transit gateway attachment.

• attachment.resource-type - The attachment resource type. Valid values are vpc \| vpn \| direct-connect-gateway \| peering \| connect.

• prefix-list-id - The ID of the prefix list.

• route-search.exact-match - The exact match of the specified filter.

• route-search.longest-prefix-match - The longest prefix that matches the route.

• route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

• route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

• state - The state of the route (active \| blackhole).

• type - The type of route (propagated \| static).

MaxResults

The maximum number of routes to return.

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.