Skip to content

EC2  >  Operations  >  get_route_server_routing_database

get_route_server_routing_database

Operation

get_route_server_routing_database async

get_route_server_routing_database(input: GetRouteServerRoutingDatabaseInput, plugins: list[Plugin] | None = None) -> GetRouteServerRoutingDatabaseOutput

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:

Name Type Description Default
input GetRouteServerRoutingDatabaseInput

An instance of GetRouteServerRoutingDatabaseInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
GetRouteServerRoutingDatabaseOutput

An instance of GetRouteServerRoutingDatabaseOutput.

Input

GetRouteServerRoutingDatabaseInput dataclass

Bases: _SerdeShape

Dataclass for GetRouteServerRoutingDatabaseInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | 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 class-attribute instance-attribute
filters: list[Filter] | None = ...

Filters to apply to the routing database query.

max_results class-attribute instance-attribute
max_results: int | None = ...

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

next_token class-attribute instance-attribute
next_token: str | None = ...

The token for the next page of results.

route_server_id class-attribute instance-attribute
route_server_id: str | None = ...

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

Output

GetRouteServerRoutingDatabaseOutput dataclass

Bases: _SerdeShape

Dataclass for GetRouteServerRoutingDatabaseOutput structure.

Attributes

are_routes_persisted class-attribute instance-attribute
are_routes_persisted: bool | None = ...

Indicates whether routes are being persisted in the routing database.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

routes class-attribute instance-attribute
routes: list[RouteServerRoute] | None = ...

The collection of routes in the route server's routing database.