Skip to content

EC2  >  Structures  >  RouteServer

RouteServer

Structure Class

RouteServer dataclass

Bases: _SerdeShape

Describes a route server and its configuration.

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.

Attributes

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

The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. 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.

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

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. The default value is 1. Only valid if persistRoutesState 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.

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

The current state of route persistence for the route server.

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

The unique identifier of the route server.

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

Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

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

The ARN of the SNS topic where notifications are published.

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

The current state of the route server.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

Any tags assigned to the route server.