#[non_exhaustive]pub struct RouteServerBuilder { /* private fields */ }
Expand description
A builder for RouteServer
.
Implementations§
Source§impl RouteServerBuilder
impl RouteServerBuilder
Sourcepub fn route_server_id(self, input: impl Into<String>) -> Self
pub fn route_server_id(self, input: impl Into<String>) -> Self
The unique identifier of the route server.
Sourcepub fn set_route_server_id(self, input: Option<String>) -> Self
pub fn set_route_server_id(self, input: Option<String>) -> Self
The unique identifier of the route server.
Sourcepub fn get_route_server_id(&self) -> &Option<String>
pub fn get_route_server_id(&self) -> &Option<String>
The unique identifier of the route server.
Sourcepub fn amazon_side_asn(self, input: i64) -> Self
pub fn amazon_side_asn(self, input: i64) -> Self
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.
Sourcepub fn set_amazon_side_asn(self, input: Option<i64>) -> Self
pub fn set_amazon_side_asn(self, input: Option<i64>) -> Self
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.
Sourcepub fn get_amazon_side_asn(&self) -> &Option<i64>
pub fn get_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.
Sourcepub fn state(self, input: RouteServerState) -> Self
pub fn state(self, input: RouteServerState) -> Self
The current state of the route server.
Sourcepub fn set_state(self, input: Option<RouteServerState>) -> Self
pub fn set_state(self, input: Option<RouteServerState>) -> Self
The current state of the route server.
Sourcepub fn get_state(&self) -> &Option<RouteServerState>
pub fn get_state(&self) -> &Option<RouteServerState>
The current state of the route server.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
Any tags assigned to the route server.
Any tags assigned to the route server.
Any tags assigned to the route server.
Sourcepub fn persist_routes_state(self, input: RouteServerPersistRoutesState) -> Self
pub fn persist_routes_state(self, input: RouteServerPersistRoutesState) -> Self
The current state of route persistence for the route server.
Sourcepub fn set_persist_routes_state(
self,
input: Option<RouteServerPersistRoutesState>,
) -> Self
pub fn set_persist_routes_state( self, input: Option<RouteServerPersistRoutesState>, ) -> Self
The current state of route persistence for the route server.
Sourcepub fn get_persist_routes_state(&self) -> &Option<RouteServerPersistRoutesState>
pub fn get_persist_routes_state(&self) -> &Option<RouteServerPersistRoutesState>
The current state of route persistence for the route server.
Sourcepub fn persist_routes_duration(self, input: i64) -> Self
pub fn persist_routes_duration(self, input: i64) -> Self
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.
Sourcepub fn set_persist_routes_duration(self, input: Option<i64>) -> Self
pub fn set_persist_routes_duration(self, input: Option<i64>) -> Self
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.
Sourcepub fn get_persist_routes_duration(&self) -> &Option<i64>
pub fn get_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.
Sourcepub fn sns_notifications_enabled(self, input: bool) -> Self
pub fn sns_notifications_enabled(self, input: bool) -> Self
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.
Sourcepub fn set_sns_notifications_enabled(self, input: Option<bool>) -> Self
pub fn set_sns_notifications_enabled(self, input: Option<bool>) -> Self
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.
Sourcepub fn get_sns_notifications_enabled(&self) -> &Option<bool>
pub fn get_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.
Sourcepub fn sns_topic_arn(self, input: impl Into<String>) -> Self
pub fn sns_topic_arn(self, input: impl Into<String>) -> Self
The ARN of the SNS topic where notifications are published.
Sourcepub fn set_sns_topic_arn(self, input: Option<String>) -> Self
pub fn set_sns_topic_arn(self, input: Option<String>) -> Self
The ARN of the SNS topic where notifications are published.
Sourcepub fn get_sns_topic_arn(&self) -> &Option<String>
pub fn get_sns_topic_arn(&self) -> &Option<String>
The ARN of the SNS topic where notifications are published.
Sourcepub fn build(self) -> RouteServer
pub fn build(self) -> RouteServer
Consumes the builder and constructs a RouteServer
.
Trait Implementations§
Source§impl Clone for RouteServerBuilder
impl Clone for RouteServerBuilder
Source§fn clone(&self) -> RouteServerBuilder
fn clone(&self) -> RouteServerBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RouteServerBuilder
impl Debug for RouteServerBuilder
Source§impl Default for RouteServerBuilder
impl Default for RouteServerBuilder
Source§fn default() -> RouteServerBuilder
fn default() -> RouteServerBuilder
Source§impl PartialEq for RouteServerBuilder
impl PartialEq for RouteServerBuilder
impl StructuralPartialEq for RouteServerBuilder
Auto Trait Implementations§
impl Freeze for RouteServerBuilder
impl RefUnwindSafe for RouteServerBuilder
impl Send for RouteServerBuilder
impl Sync for RouteServerBuilder
impl Unpin for RouteServerBuilder
impl UnwindSafe for RouteServerBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);