Struct aws_sdk_ec2::operation::create_client_vpn_endpoint::CreateClientVpnEndpointInput

#[non_exhaustive]
pub struct CreateClientVpnEndpointInput {

    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>,
}

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.

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 How to ensure 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

client_login_banner_options: Option<ClientLoginBannerOptions>

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

Implementations

impl CreateClientVpnEndpointInput

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.

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

The ARN of the server certificate. For more information, see the Certificate Manager User Guide.

pub fn authentication_options( &self ) -> Option<&[ClientVpnAuthenticationRequest]>

Information about the authentication method to be used to authenticate clients.

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

pub fn dns_servers(&self) -> Option<&[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.

pub fn transport_protocol(&self) -> Option<&TransportProtocol>

The transport protocol to be used by the VPN session.

Default value: udp

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

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

A brief description of the Client VPN endpoint.

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.

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.

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 How to ensure idempotency.

pub fn tag_specifications(&self) -> Option<&[TagSpecification]>

The tags to apply to the Client VPN endpoint during creation.

pub fn security_group_ids(&self) -> Option<&[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.

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.

pub fn self_service_portal(&self) -> Option<&SelfServicePortal>

Specify whether to enable the self-service portal for the Client VPN endpoint.

Default Value: enabled

pub fn client_connect_options(&self) -> Option<&ClientConnectOptions>

The options for managing connection authorization for new client connections.

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

pub fn client_login_banner_options(&self) -> Option<&ClientLoginBannerOptions>

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

impl CreateClientVpnEndpointInput

pub fn builder() -> CreateClientVpnEndpointInputBuilder

Creates a new builder-style object to manufacture CreateClientVpnEndpointInput.

Trait Implementations

impl Clone for CreateClientVpnEndpointInput

fn clone(&self) -> CreateClientVpnEndpointInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateClientVpnEndpointInput

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

Formats the value using the given formatter.

impl PartialEq<CreateClientVpnEndpointInput> for CreateClientVpnEndpointInput

fn eq(&self, other: &CreateClientVpnEndpointInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateClientVpnEndpointInput