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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::SearchTransitGatewayRoutesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #filters ⇒ Array<Types::Filter>

  One or more filters.

• #max_results ⇒ Integer

  The maximum number of routes to return.

• #transit_gateway_route_table_id ⇒ String

  The ID of the transit gateway route table.

Instance Attribute Details

#dry_run ⇒ Boolean

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)

# File 'lib/aws-sdk-ec2/types.rb', line 61083

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

#filters ⇒ Array<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. 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`).

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-ec2/types.rb', line 61083

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

#max_results ⇒ Integer

The maximum number of routes to return. If a value is not provided, the default is 1000.

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 61083

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

#transit_gateway_route_table_id ⇒ String

The ID of the transit gateway route table.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 61083

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