You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::SearchTransitGatewayRoutesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass SearchTransitGatewayRoutesRequest data as a hash:

{
  transit_gateway_route_table_id: "String", # required
  filters: [ # required
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  dry_run: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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.

Returns:

  • (Boolean)


35126
35127
35128
35129
35130
35131
35132
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35126

class SearchTransitGatewayRoutesRequest < Struct.new(
  :transit_gateway_route_table_id,
  :filters,
  :max_results,
  :dry_run)
  include Aws::Structure
end

#filtersArray<Types::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 (vpc | vpn).

  • 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 roue (propagated | static).

Returns:



35126
35127
35128
35129
35130
35131
35132
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35126

class SearchTransitGatewayRoutesRequest < Struct.new(
  :transit_gateway_route_table_id,
  :filters,
  :max_results,
  :dry_run)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of routes to return.

Returns:

  • (Integer)


35126
35127
35128
35129
35130
35131
35132
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35126

class SearchTransitGatewayRoutesRequest < Struct.new(
  :transit_gateway_route_table_id,
  :filters,
  :max_results,
  :dry_run)
  include Aws::Structure
end

#transit_gateway_route_table_idString

The ID of the transit gateway route table.

Returns:

  • (String)


35126
35127
35128
35129
35130
35131
35132
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35126

class SearchTransitGatewayRoutesRequest < Struct.new(
  :transit_gateway_route_table_id,
  :filters,
  :max_results,
  :dry_run)
  include Aws::Structure
end