route_server_routing_databases
Creates, updates, deletes, gets or lists a route_server_routing_databases resource.
Overview
| Name | route_server_routing_databases |
| Type | Resource |
| Id | aws.ec2.route_server_routing_databases |
Fields
The following fields are returned by SELECT queries:
- get_route_server_routing_database
| Name | Datatype | Description |
|---|---|---|
are_routes_persisted | boolean | Indicates whether routes are being persisted in the routing database. |
next_token | string | The token to use to retrieve the next page of results. This value is null when there are no more results to return. |
routes | string | The collection of routes in the route server's routing database. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_route_server_routing_database | select | RouteServerId, region | NextToken, MaxResults, DryRun, Filter | 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
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
RouteServerId | string | The ID of the route server for which to get the routing database. |
region | string | AWS region (default: us-east-1) |
DryRun | boolean | 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. |
Filter | array | Filters to apply to the routing database query. |
MaxResults | integer | The maximum number of routing database entries to return in a single response. |
NextToken | string | The token for the next page of results. |
SELECT examples
- get_route_server_routing_database
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.
SELECT
are_routes_persisted,
next_token,
routes
FROM aws.ec2.route_server_routing_databases
WHERE RouteServerId = '{{ RouteServerId }}' -- required
AND region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
;