Skip to content

get_route_server_routing_database

get_route_server_routing_database(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    route_server_id: Optional[RouteServerId] = None,
    next_token: Optional[String] = None,
    max_results: Optional[RouteServerMaxResults] = None,
    dry_run: Optional[Boolean] = None,
    filters: Optional[FilterList] = None,
) -> GetRouteServerRoutingDatabaseResult

Gets the routing database for the specified route server. The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

Route server supports the follow route table types:

  • VPC route tables not associated with subnets

  • Subnet route tables

  • Internet gateway route tables

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

Parameters:

  • route_server_id (Optional[RouteServerId], default: None ) –

    The ID of the route server for which to get the routing database.

  • next_token (Optional[String], default: None ) –

    The token for the next page of results.

  • max_results (Optional[RouteServerMaxResults], default: None ) –

    The maximum number of routing database entries to return in a single response.

  • dry_run (Optional[Boolean], default: None ) –

    A check for 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.

  • filters (Optional[FilterList], default: None ) –

    Filters to apply to the routing database query.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def get_route_server_routing_database(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    route_server_id: Optional[
        "capo_ec2.types.route_server_id.RouteServerId"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    max_results: Optional[
        "capo_ec2.types.route_server_max_results.RouteServerMaxResults"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
) -> "capo_ec2.types.get_route_server_routing_database_result.GetRouteServerRoutingDatabaseResult":
    """<p>Gets the routing database for the specified route server. The <a href="https://en.wikipedia.org/wiki/Routing_table">Routing Information Base (RIB)</a> serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.</p> <p>Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.</p> <p>Route server supports the follow route table types:</p> <ul> <li> <p>VPC route tables not associated with subnets</p> </li> <li> <p>Subnet route tables</p> </li> <li> <p>Internet gateway route tables</p> </li> </ul> <p>Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html">Transit Gateway Connect</a>.</p>

    Args:
        route_server_id: <p>The ID of the route server for which to get the routing database.</p>
        next_token: <p>The token for the next page of results.</p>
        max_results: <p>The maximum number of routing database entries to return in a single response.</p>
        dry_run: <p>A check for 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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        filters: <p>Filters to apply to the routing database query.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.get_route_server_routing_database_request.GetRouteServerRoutingDatabaseRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.get_route_server_routing_database_result.GetRouteServerRoutingDatabaseResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_route_server_routing_database

        output, http_response = (
            capo_ec2._operations.amazon_ec2.get_route_server_routing_database.get_route_server_routing_database(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRouteServerRoutingDatabase")
    )
    input_: capo_ec2.types.get_route_server_routing_database_request.GetRouteServerRoutingDatabaseRequest = {}
    if route_server_id is not None:
        input_["route_server_id"] = route_server_id
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if filters is not None:
        input_["filters"] = filters

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output