Skip to content

Search Transit Gateway Routes

ec2_search_transit_gateway_routes R Documentation

Searches for routes in the specified transit gateway route table

Description

Searches for routes in the specified transit gateway route table.

Usage

ec2_search_transit_gateway_routes(TransitGatewayRouteTableId, Filters,
  MaxResults, DryRun)

Arguments

TransitGatewayRouteTableId

[required] The ID of the transit gateway route table.

Filters

[required] 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. If a value is not provided, the default is 1000.

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.

Value

A list with the following syntax: 

list(
  Routes = list(
    list(
      DestinationCidrBlock = "string",
      PrefixListId = "string",
      TransitGatewayRouteTableAnnouncementId = "string",
      TransitGatewayAttachments = list(
        list(
          ResourceId = "string",
          TransitGatewayAttachmentId = "string",
          ResourceType = "vpc"|"vpn"|"direct-connect-gateway"|"connect"|"peering"|"tgw-peering"
        )
      ),
      Type = "static"|"propagated",
      State = "pending"|"active"|"blackhole"|"deleting"|"deleted"
    )
  ),
  AdditionalRoutesAvailable = TRUE|FALSE
)

Request syntax

svc$search_transit_gateway_routes(
  TransitGatewayRouteTableId = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  DryRun = TRUE|FALSE
)