#[non_exhaustive]pub struct ClientVpnEndpoint {Show 25 fields
pub client_vpn_endpoint_id: Option<String>,
pub description: Option<String>,
pub status: Option<ClientVpnEndpointStatus>,
pub creation_time: Option<String>,
pub deletion_time: Option<String>,
pub dns_name: Option<String>,
pub client_cidr_block: Option<String>,
pub dns_servers: Option<Vec<String>>,
pub split_tunnel: Option<bool>,
pub vpn_protocol: Option<VpnProtocol>,
pub transport_protocol: Option<TransportProtocol>,
pub vpn_port: Option<i32>,
pub associated_target_networks: Option<Vec<AssociatedTargetNetwork>>,
pub server_certificate_arn: Option<String>,
pub authentication_options: Option<Vec<ClientVpnAuthentication>>,
pub connection_log_options: Option<ConnectionLogResponseOptions>,
pub tags: Option<Vec<Tag>>,
pub security_group_ids: Option<Vec<String>>,
pub vpc_id: Option<String>,
pub self_service_portal_url: Option<String>,
pub client_connect_options: Option<ClientConnectResponseOptions>,
pub session_timeout_hours: Option<i32>,
pub client_login_banner_options: Option<ClientLoginBannerResponseOptions>,
pub client_route_enforcement_options: Option<ClientRouteEnforcementResponseOptions>,
pub disconnect_on_session_timeout: Option<bool>,
}Expand description
Describes a Client VPN endpoint.
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.client_vpn_endpoint_id: Option<String>The ID of the Client VPN endpoint.
description: Option<String>A brief description of the endpoint.
status: Option<ClientVpnEndpointStatus>The current state of the Client VPN endpoint.
creation_time: Option<String>The date and time the Client VPN endpoint was created.
deletion_time: Option<String>The date and time the Client VPN endpoint was deleted, if applicable.
dns_name: Option<String>The DNS name to be used by clients when connecting to the Client VPN endpoint.
client_cidr_block: Option<String>The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
dns_servers: Option<Vec<String>>Information about the DNS servers to be used for DNS resolution.
split_tunnel: Option<bool>Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
vpn_protocol: Option<VpnProtocol>The protocol used by the VPN session.
transport_protocol: Option<TransportProtocol>The transport protocol used by the Client VPN endpoint.
vpn_port: Option<i32>The port number for the Client VPN endpoint.
associated_target_networks: Option<Vec<AssociatedTargetNetwork>>Information about the associated target networks. A target network is a subnet in a VPC.
server_certificate_arn: Option<String>The ARN of the server certificate.
authentication_options: Option<Vec<ClientVpnAuthentication>>Information about the authentication method used by the Client VPN endpoint.
connection_log_options: Option<ConnectionLogResponseOptions>Information about the client connection logging options for the Client VPN endpoint.
Any tags assigned to the Client VPN endpoint.
security_group_ids: Option<Vec<String>>The IDs of the security groups for the target network.
vpc_id: Option<String>The ID of the VPC.
self_service_portal_url: Option<String>The URL of the self-service portal.
client_connect_options: Option<ClientConnectResponseOptions>The options for managing connection authorization for new client connections.
session_timeout_hours: Option<i32>The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
client_route_enforcement_options: Option<ClientRouteEnforcementResponseOptions>Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
disconnect_on_session_timeout: Option<bool>Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
Implementations§
Source§impl ClientVpnEndpoint
impl ClientVpnEndpoint
Sourcepub fn client_vpn_endpoint_id(&self) -> Option<&str>
pub fn client_vpn_endpoint_id(&self) -> Option<&str>
The ID of the Client VPN endpoint.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A brief description of the endpoint.
Sourcepub fn status(&self) -> Option<&ClientVpnEndpointStatus>
pub fn status(&self) -> Option<&ClientVpnEndpointStatus>
The current state of the Client VPN endpoint.
Sourcepub fn creation_time(&self) -> Option<&str>
pub fn creation_time(&self) -> Option<&str>
The date and time the Client VPN endpoint was created.
Sourcepub fn deletion_time(&self) -> Option<&str>
pub fn deletion_time(&self) -> Option<&str>
The date and time the Client VPN endpoint was deleted, if applicable.
Sourcepub fn dns_name(&self) -> Option<&str>
pub fn dns_name(&self) -> Option<&str>
The DNS name to be used by clients when connecting to the Client VPN endpoint.
Sourcepub fn client_cidr_block(&self) -> Option<&str>
pub fn client_cidr_block(&self) -> Option<&str>
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
Sourcepub fn dns_servers(&self) -> &[String]
pub fn dns_servers(&self) -> &[String]
Information about the DNS servers to be used for DNS resolution.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .dns_servers.is_none().
Sourcepub fn split_tunnel(&self) -> Option<bool>
pub fn split_tunnel(&self) -> Option<bool>
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
Sourcepub fn vpn_protocol(&self) -> Option<&VpnProtocol>
pub fn vpn_protocol(&self) -> Option<&VpnProtocol>
The protocol used by the VPN session.
Sourcepub fn transport_protocol(&self) -> Option<&TransportProtocol>
pub fn transport_protocol(&self) -> Option<&TransportProtocol>
The transport protocol used by the Client VPN endpoint.
Sourcepub fn associated_target_networks(&self) -> &[AssociatedTargetNetwork]
👎Deprecated: This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.
pub fn associated_target_networks(&self) -> &[AssociatedTargetNetwork]
Information about the associated target networks. A target network is a subnet in a VPC.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .associated_target_networks.is_none().
Sourcepub fn server_certificate_arn(&self) -> Option<&str>
pub fn server_certificate_arn(&self) -> Option<&str>
The ARN of the server certificate.
Sourcepub fn authentication_options(&self) -> &[ClientVpnAuthentication]
pub fn authentication_options(&self) -> &[ClientVpnAuthentication]
Information about the authentication method used by the Client VPN endpoint.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .authentication_options.is_none().
Sourcepub fn connection_log_options(&self) -> Option<&ConnectionLogResponseOptions>
pub fn connection_log_options(&self) -> Option<&ConnectionLogResponseOptions>
Information about the client connection logging options for the Client VPN endpoint.
Any tags assigned to the Client VPN endpoint.
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 security_group_ids(&self) -> &[String]
pub fn security_group_ids(&self) -> &[String]
The IDs of the security groups for the target network.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .security_group_ids.is_none().
Sourcepub fn self_service_portal_url(&self) -> Option<&str>
pub fn self_service_portal_url(&self) -> Option<&str>
The URL of the self-service portal.
Sourcepub fn client_connect_options(&self) -> Option<&ClientConnectResponseOptions>
pub fn client_connect_options(&self) -> Option<&ClientConnectResponseOptions>
The options for managing connection authorization for new client connections.
Sourcepub fn session_timeout_hours(&self) -> Option<i32>
pub fn session_timeout_hours(&self) -> Option<i32>
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
Sourcepub fn client_route_enforcement_options(
&self,
) -> Option<&ClientRouteEnforcementResponseOptions>
pub fn client_route_enforcement_options( &self, ) -> Option<&ClientRouteEnforcementResponseOptions>
Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
Sourcepub fn disconnect_on_session_timeout(&self) -> Option<bool>
pub fn disconnect_on_session_timeout(&self) -> Option<bool>
Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
Source§impl ClientVpnEndpoint
impl ClientVpnEndpoint
Sourcepub fn builder() -> ClientVpnEndpointBuilder
pub fn builder() -> ClientVpnEndpointBuilder
Creates a new builder-style object to manufacture ClientVpnEndpoint.
Trait Implementations§
Source§impl Clone for ClientVpnEndpoint
impl Clone for ClientVpnEndpoint
Source§fn clone(&self) -> ClientVpnEndpoint
fn clone(&self) -> ClientVpnEndpoint
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ClientVpnEndpoint
impl Debug for ClientVpnEndpoint
Source§impl PartialEq for ClientVpnEndpoint
impl PartialEq for ClientVpnEndpoint
impl StructuralPartialEq for ClientVpnEndpoint
Auto Trait Implementations§
impl Freeze for ClientVpnEndpoint
impl RefUnwindSafe for ClientVpnEndpoint
impl Send for ClientVpnEndpoint
impl Sync for ClientVpnEndpoint
impl Unpin for ClientVpnEndpoint
impl UnwindSafe for ClientVpnEndpoint
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);