Struct RouteServer

#[non_exhaustive]
pub struct RouteServer {
    pub route_server_id: Option<String>,
    pub amazon_side_asn: Option<i64>,
    pub state: Option<RouteServerState>,
    pub tags: Option<Vec<Tag>>,
    pub persist_routes_state: Option<RouteServerPersistRoutesState>,
    pub persist_routes_duration: Option<i64>,
    pub sns_notifications_enabled: Option<bool>,
    pub sns_topic_arn: Option<String>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

route_server_id: Option<String>

The unique identifier of the route server.

amazon_side_asn: Option<i64>

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.

state: Option<RouteServerState>

The current state of the route server.

tags: Option<Vec<Tag>>

Any tags assigned to the route server.

persist_routes_state: Option<RouteServerPersistRoutesState>

The current state of route persistence for the route server.

persist_routes_duration: Option<i64>

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.

sns_notifications_enabled: Option<bool>

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: Option<String>

The ARN of the SNS topic where notifications are published.

Implementations

impl RouteServer

pub fn route_server_id(&self) -> Option<&str>

The unique identifier of the route server.

pub fn amazon_side_asn(&self) -> Option<i64>

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.

pub fn state(&self) -> Option<&RouteServerState>

The current state of the route server.

pub fn tags(&self) -> &[Tag]

Any tags assigned to the route server.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn persist_routes_state(&self) -> Option<&RouteServerPersistRoutesState>

The current state of route persistence for the route server.

pub fn persist_routes_duration(&self) -> Option<i64>

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.

pub fn sns_notifications_enabled(&self) -> Option<bool>

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.

pub fn sns_topic_arn(&self) -> Option<&str>

The ARN of the SNS topic where notifications are published.

impl RouteServer

pub fn builder() -> RouteServerBuilder

Creates a new builder-style object to manufacture RouteServer.

Trait Implementations

impl Clone for RouteServer

fn clone(&self) -> RouteServer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RouteServer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for RouteServer

fn eq(&self, other: &RouteServer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RouteServer