Creates a new route server to manage dynamic routing in a VPC.
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.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- AmazonSideAsn
-
The private Autonomous System Number (ASN) for the Amazon side of the BGP session. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
Type: Long
Required: Yes
- ClientToken
-
Unique, case-sensitive identifier to ensure idempotency of the request.
Type: String
Required: No
- DryRun
-
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 isUnauthorizedOperation.Type: Boolean
Required: No
- PersistRoutes
-
Indicates whether routes should be persisted after all BGP sessions are terminated.
Type: String
Valid Values:
enable | disable | resetRequired: No
- PersistRoutesDuration
-
The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is
enabled.If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.
Type: Long
Required: No
- SnsNotificationsEnabled
-
Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS.
Type: Boolean
Required: No
- TagSpecification.N
-
The tags to apply to the route server during creation.
Type: Array of TagSpecification objects
Required: No
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- routeServer
-
Information about the created route server.
Type: RouteServer object
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
