Struct ModifyRouteServerInput

#[non_exhaustive]
pub struct ModifyRouteServerInput {
    pub route_server_id: Option<String>,
    pub persist_routes: Option<RouteServerPersistRoutesAction>,
    pub persist_routes_duration: Option<i64>,
    pub sns_notifications_enabled: Option<bool>,
    pub dry_run: Option<bool>,
}

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 ID of the route server to modify.

persist_routes: Option<RouteServerPersistRoutesAction>

Specifies whether to persist routes after all BGP sessions are terminated.

• enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.

• disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.

• reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.

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. 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.

sns_notifications_enabled: Option<bool>

Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

dry_run: Option<bool>

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.

Implementations

impl ModifyRouteServerInput

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

The ID of the route server to modify.

pub fn persist_routes(&self) -> Option<&RouteServerPersistRoutesAction>

Specifies whether to persist routes after all BGP sessions are terminated.

• enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.

• disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.

• reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.

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. 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.

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

Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

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

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.

impl ModifyRouteServerInput

pub fn builder() -> ModifyRouteServerInputBuilder

Creates a new builder-style object to manufacture ModifyRouteServerInput.

Trait Implementations

impl Clone for ModifyRouteServerInput

fn clone(&self) -> ModifyRouteServerInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModifyRouteServerInput

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

Formats the value using the given formatter.

impl PartialEq for ModifyRouteServerInput

fn eq(&self, other: &ModifyRouteServerInput) -> 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 ModifyRouteServerInput