#[non_exhaustive]pub struct CreateClientVpnEndpointInput {Show 20 fields
pub client_cidr_block: Option<String>,
pub server_certificate_arn: Option<String>,
pub authentication_options: Option<Vec<ClientVpnAuthenticationRequest>>,
pub connection_log_options: Option<ConnectionLogOptions>,
pub dns_servers: Option<Vec<String>>,
pub transport_protocol: Option<TransportProtocol>,
pub vpn_port: Option<i32>,
pub description: Option<String>,
pub split_tunnel: Option<bool>,
pub dry_run: Option<bool>,
pub client_token: Option<String>,
pub tag_specifications: Option<Vec<TagSpecification>>,
pub security_group_ids: Option<Vec<String>>,
pub vpc_id: Option<String>,
pub self_service_portal: Option<SelfServicePortal>,
pub client_connect_options: Option<ClientConnectOptions>,
pub session_timeout_hours: Option<i32>,
pub client_login_banner_options: Option<ClientLoginBannerOptions>,
pub client_route_enforcement_options: Option<ClientRouteEnforcementOptions>,
pub disconnect_on_session_timeout: Option<bool>,
}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_cidr_block: Option<String>The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.
server_certificate_arn: Option<String>The ARN of the server certificate. For more information, see the Certificate Manager User Guide.
authentication_options: Option<Vec<ClientVpnAuthenticationRequest>>Information about the authentication method to be used to authenticate clients.
connection_log_options: Option<ConnectionLogOptions>Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
-
Client connection requests
-
Client connection results (successful and unsuccessful)
-
Reasons for unsuccessful client connection requests
-
Client connection termination time
dns_servers: Option<Vec<String>>Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
transport_protocol: Option<TransportProtocol>The transport protocol to be used by the VPN session.
Default value: udp
vpn_port: Option<i32>The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
description: Option<String>A brief description of the Client VPN endpoint.
split_tunnel: Option<bool>Indicates whether split-tunnel is enabled on the Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
dry_run: Option<bool>Checks 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.
client_token: Option<String>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
tag_specifications: Option<Vec<TagSpecification>>The tags to apply to the Client VPN endpoint during creation.
security_group_ids: Option<Vec<String>>The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.
vpc_id: Option<String>The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.
self_service_portal: Option<SelfServicePortal>Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
client_connect_options: Option<ClientConnectOptions>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<ClientRouteEnforcementOptions>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 timeout specified in 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 CreateClientVpnEndpointInput
impl CreateClientVpnEndpointInput
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 to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.
Sourcepub fn server_certificate_arn(&self) -> Option<&str>
pub fn server_certificate_arn(&self) -> Option<&str>
The ARN of the server certificate. For more information, see the Certificate Manager User Guide.
Sourcepub fn authentication_options(&self) -> &[ClientVpnAuthenticationRequest]
pub fn authentication_options(&self) -> &[ClientVpnAuthenticationRequest]
Information about the authentication method to be used to authenticate clients.
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<&ConnectionLogOptions>
pub fn connection_log_options(&self) -> Option<&ConnectionLogOptions>
Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
-
Client connection requests
-
Client connection results (successful and unsuccessful)
-
Reasons for unsuccessful client connection requests
-
Client connection termination time
Sourcepub fn dns_servers(&self) -> &[String]
pub fn dns_servers(&self) -> &[String]
Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS 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 .dns_servers.is_none().
Sourcepub fn transport_protocol(&self) -> Option<&TransportProtocol>
pub fn transport_protocol(&self) -> Option<&TransportProtocol>
The transport protocol to be used by the VPN session.
Default value: udp
Sourcepub fn vpn_port(&self) -> Option<i32>
pub fn vpn_port(&self) -> Option<i32>
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A brief description of the Client VPN endpoint.
Sourcepub fn split_tunnel(&self) -> Option<bool>
pub fn split_tunnel(&self) -> Option<bool>
Indicates whether split-tunnel is enabled on the Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
Sourcepub fn dry_run(&self) -> Option<bool>
pub fn dry_run(&self) -> Option<bool>
Checks 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.
Sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Sourcepub fn tag_specifications(&self) -> &[TagSpecification]
pub fn tag_specifications(&self) -> &[TagSpecification]
The tags to apply to the Client VPN endpoint during creation.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tag_specifications.is_none().
Sourcepub fn security_group_ids(&self) -> &[String]
pub fn security_group_ids(&self) -> &[String]
The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.
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 vpc_id(&self) -> Option<&str>
pub fn vpc_id(&self) -> Option<&str>
The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.
Sourcepub fn self_service_portal(&self) -> Option<&SelfServicePortal>
pub fn self_service_portal(&self) -> Option<&SelfServicePortal>
Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
Sourcepub fn client_connect_options(&self) -> Option<&ClientConnectOptions>
pub fn client_connect_options(&self) -> Option<&ClientConnectOptions>
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<&ClientRouteEnforcementOptions>
pub fn client_route_enforcement_options( &self, ) -> Option<&ClientRouteEnforcementOptions>
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 timeout specified in 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 CreateClientVpnEndpointInput
impl CreateClientVpnEndpointInput
Sourcepub fn builder() -> CreateClientVpnEndpointInputBuilder
pub fn builder() -> CreateClientVpnEndpointInputBuilder
Creates a new builder-style object to manufacture CreateClientVpnEndpointInput.
Trait Implementations§
Source§impl Clone for CreateClientVpnEndpointInput
impl Clone for CreateClientVpnEndpointInput
Source§fn clone(&self) -> CreateClientVpnEndpointInput
fn clone(&self) -> CreateClientVpnEndpointInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CreateClientVpnEndpointInput
impl Debug for CreateClientVpnEndpointInput
Source§impl PartialEq for CreateClientVpnEndpointInput
impl PartialEq for CreateClientVpnEndpointInput
Source§fn eq(&self, other: &CreateClientVpnEndpointInput) -> bool
fn eq(&self, other: &CreateClientVpnEndpointInput) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for CreateClientVpnEndpointInput
Auto Trait Implementations§
impl Freeze for CreateClientVpnEndpointInput
impl RefUnwindSafe for CreateClientVpnEndpointInput
impl Send for CreateClientVpnEndpointInput
impl Sync for CreateClientVpnEndpointInput
impl Unpin for CreateClientVpnEndpointInput
impl UnwindSafe for CreateClientVpnEndpointInput
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);