#[non_exhaustive]pub struct VpnConnection {Show 16 fields
pub category: Option<String>,
pub transit_gateway_id: Option<String>,
pub core_network_arn: Option<String>,
pub core_network_attachment_arn: Option<String>,
pub gateway_association_state: Option<GatewayAssociationState>,
pub options: Option<VpnConnectionOptions>,
pub routes: Option<Vec<VpnStaticRoute>>,
pub tags: Option<Vec<Tag>>,
pub vgw_telemetry: Option<Vec<VgwTelemetry>>,
pub pre_shared_key_arn: Option<String>,
pub vpn_connection_id: Option<String>,
pub state: Option<VpnState>,
pub customer_gateway_configuration: Option<String>,
pub type: Option<GatewayType>,
pub customer_gateway_id: Option<String>,
pub vpn_gateway_id: Option<String>,
}
Expand description
Describes a VPN connection.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.category: Option<String>
The category of the VPN connection. A value of VPN
indicates an Amazon Web Services VPN connection. A value of VPN-Classic
indicates an Amazon Web Services Classic VPN connection.
transit_gateway_id: Option<String>
The ID of the transit gateway associated with the VPN connection.
core_network_arn: Option<String>
The ARN of the core network.
core_network_attachment_arn: Option<String>
The ARN of the core network attachment.
gateway_association_state: Option<GatewayAssociationState>
The current state of the gateway association.
options: Option<VpnConnectionOptions>
The VPN connection options.
routes: Option<Vec<VpnStaticRoute>>
The static routes associated with the VPN connection.
Any tags assigned to the VPN connection.
vgw_telemetry: Option<Vec<VgwTelemetry>>
Information about the VPN tunnel.
The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
vpn_connection_id: Option<String>
The ID of the VPN connection.
state: Option<VpnState>
The current state of the VPN connection.
customer_gateway_configuration: Option<String>
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection
response; however, it's present in the DescribeVpnConnections
response only if the VPN connection is in the pending
or available
state.
type: Option<GatewayType>
The type of VPN connection.
customer_gateway_id: Option<String>
The ID of the customer gateway at your end of the VPN connection.
vpn_gateway_id: Option<String>
The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
Implementations§
Source§impl VpnConnection
impl VpnConnection
Sourcepub fn category(&self) -> Option<&str>
pub fn category(&self) -> Option<&str>
The category of the VPN connection. A value of VPN
indicates an Amazon Web Services VPN connection. A value of VPN-Classic
indicates an Amazon Web Services Classic VPN connection.
Sourcepub fn transit_gateway_id(&self) -> Option<&str>
pub fn transit_gateway_id(&self) -> Option<&str>
The ID of the transit gateway associated with the VPN connection.
Sourcepub fn core_network_arn(&self) -> Option<&str>
pub fn core_network_arn(&self) -> Option<&str>
The ARN of the core network.
Sourcepub fn core_network_attachment_arn(&self) -> Option<&str>
pub fn core_network_attachment_arn(&self) -> Option<&str>
The ARN of the core network attachment.
Sourcepub fn gateway_association_state(&self) -> Option<&GatewayAssociationState>
pub fn gateway_association_state(&self) -> Option<&GatewayAssociationState>
The current state of the gateway association.
Sourcepub fn options(&self) -> Option<&VpnConnectionOptions>
pub fn options(&self) -> Option<&VpnConnectionOptions>
The VPN connection options.
Sourcepub fn routes(&self) -> &[VpnStaticRoute]
pub fn routes(&self) -> &[VpnStaticRoute]
The static routes associated with the VPN connection.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .routes.is_none()
.
Any tags assigned to the VPN connection.
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()
.
Sourcepub fn vgw_telemetry(&self) -> &[VgwTelemetry]
pub fn vgw_telemetry(&self) -> &[VgwTelemetry]
Information about the VPN tunnel.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vgw_telemetry.is_none()
.
The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
Sourcepub fn vpn_connection_id(&self) -> Option<&str>
pub fn vpn_connection_id(&self) -> Option<&str>
The ID of the VPN connection.
Sourcepub fn customer_gateway_configuration(&self) -> Option<&str>
pub fn customer_gateway_configuration(&self) -> Option<&str>
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection
response; however, it's present in the DescribeVpnConnections
response only if the VPN connection is in the pending
or available
state.
Sourcepub fn type(&self) -> Option<&GatewayType>
pub fn type(&self) -> Option<&GatewayType>
The type of VPN connection.
Sourcepub fn customer_gateway_id(&self) -> Option<&str>
pub fn customer_gateway_id(&self) -> Option<&str>
The ID of the customer gateway at your end of the VPN connection.
Sourcepub fn vpn_gateway_id(&self) -> Option<&str>
pub fn vpn_gateway_id(&self) -> Option<&str>
The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
Source§impl VpnConnection
impl VpnConnection
Sourcepub fn builder() -> VpnConnectionBuilder
pub fn builder() -> VpnConnectionBuilder
Creates a new builder-style object to manufacture VpnConnection
.
Trait Implementations§
Source§impl Clone for VpnConnection
impl Clone for VpnConnection
Source§fn clone(&self) -> VpnConnection
fn clone(&self) -> VpnConnection
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for VpnConnection
impl Debug for VpnConnection
Source§impl PartialEq for VpnConnection
impl PartialEq for VpnConnection
impl StructuralPartialEq for VpnConnection
Auto Trait Implementations§
impl Freeze for VpnConnection
impl RefUnwindSafe for VpnConnection
impl Send for VpnConnection
impl Sync for VpnConnection
impl Unpin for VpnConnection
impl UnwindSafe for VpnConnection
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);