ServiceResource / Collection / route_tables

route_tables#

EC2.ServiceResource.route_tables#

A collection of RouteTable resources.A RouteTable Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

all()#

Creates an iterable of all RouteTable resources in the collection.

See also: AWS API Documentation

Request Syntax

route_table_iterator = ec2.route_tables.all()

Return type:: list(ec2.RouteTable)
Returns:: A list of RouteTable resources

filter(**kwargs)#

Creates an iterable of all RouteTable resources in the collection filtered by kwargs passed to method. A RouteTable collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

See also: AWS API Documentation

Request Syntax

route_table_iterator = ec2.route_tables.filter(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False,
    RouteTableIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)

Parameters:

Filters (list) –
The filters.
- association.gateway-id - The ID of the gateway involved in the association.
- 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 Amazon Web Services 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 Amazon Web 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:<key> - 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.
- vpc-id - The ID of the VPC for the route table.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –
DryRun (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.
RouteTableIds (list) –
The IDs of the route tables.

Default: Describes all your route tables.
- (string) –
NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults (integer) – The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

Return type:

list(ec2.RouteTable)

Returns:

A list of RouteTable resources

limit(**kwargs)#

Creates an iterable up to a specified amount of RouteTable resources in the collection.

See also: AWS API Documentation

Request Syntax

route_table_iterator = ec2.route_tables.limit(
    count=123
)

Parameters:: count (integer) – The limit to the number of resources in the iterable.
Return type:: list(ec2.RouteTable)
Returns:: A list of RouteTable resources

page_size(**kwargs)#

Creates an iterable of all RouteTable resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

route_table_iterator = ec2.route_tables.page_size(
    count=123
)

Parameters:: count (integer) – The number of items returned by each service call
Return type:: list(ec2.RouteTable)
Returns:: A list of RouteTable resources