Class: Aws::EC2::Types::DescribeRouteTablesRequest

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

Overview

Note:

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

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  route_table_ids: ["String"],
  next_token: "String",
  max_results: 1,
}

See Also:

Instance Attribute Summary collapse

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) 


14097
14098
14099
14100
14101
14102
14103
14104
 
# File 'lib/aws-sdk-ec2/types.rb', line 14097

class DescribeRouteTablesRequest < Struct.new(
  :filters,
  :dry_run,
  :route_table_ids,
  :next_token,
  :max_results)
  include Aws::Structure
end

#filters ⇒ Array<Types::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`:&lt;key&gt; - 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.

  • ‘transit-gateway-id` - The ID of a transit gateway.

  • ‘vpc-id` - The ID of the VPC for the route table.

Returns:



14097
14098
14099
14100
14101
14102
14103
14104
 
# File 'lib/aws-sdk-ec2/types.rb', line 14097

class DescribeRouteTablesRequest < Struct.new(
  :filters,
  :dry_run,
  :route_table_ids,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 100.

Returns:

  • (Integer) 


14097
14098
14099
14100
14101
14102
14103
14104
 
# File 'lib/aws-sdk-ec2/types.rb', line 14097

class DescribeRouteTablesRequest < Struct.new(
  :filters,
  :dry_run,
  :route_table_ids,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_token ⇒ String

The token to retrieve the next page of results.

Returns:

  • (String) 


14097
14098
14099
14100
14101
14102
14103
14104
 
# File 'lib/aws-sdk-ec2/types.rb', line 14097

class DescribeRouteTablesRequest < Struct.new(
  :filters,
  :dry_run,
  :route_table_ids,
  :next_token,
  :max_results)
  include Aws::Structure
end

#route_table_ids ⇒ Array<String>

One or more route table IDs.

Default: Describes all your route tables.

Returns:

  • (Array<String>) 


14097
14098
14099
14100
14101
14102
14103
14104
 
# File 'lib/aws-sdk-ec2/types.rb', line 14097

class DescribeRouteTablesRequest < Struct.new(
  :filters,
  :dry_run,
  :route_table_ids,
  :next_token,
  :max_results)
  include Aws::Structure
end