Struct aws_sdk_ec2::client::fluent_builders::CreateClientVpnEndpoint

pub struct CreateClientVpnEndpoint { /* private fields */ }

Fluent builder constructing a request to CreateClientVpnEndpoint.

Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.

Implementations

impl CreateClientVpnEndpoint

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateClientVpnEndpoint, AwsResponseRetryClassifier>, SdkError<CreateClientVpnEndpointError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateClientVpnEndpointOutput, SdkError<CreateClientVpnEndpointError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn client_cidr_block(self, input: impl Into<String>) -> Self

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 set_client_cidr_block(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

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

pub fn set_server_certificate_arn(self, input: Option<String>) -> Self

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

pub fn authentication_options(
    self,
    input: ClientVpnAuthenticationRequest
) -> Self

Appends an item to AuthenticationOptions.

To override the contents of this collection use set_authentication_options.

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

pub fn set_authentication_options(
    self,
    input: Option<Vec<ClientVpnAuthenticationRequest>>
) -> Self

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

pub fn connection_log_options(self, input: ConnectionLogOptions) -> Self

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 set_connection_log_options(
    self,
    input: Option<ConnectionLogOptions>
) -> Self

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, input: impl Into<String>) -> Self

Appends an item to DnsServers.

To override the contents of this collection use set_dns_servers.

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 set_dns_servers(self, input: Option<Vec<String>>) -> Self

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, input: TransportProtocol) -> Self

The transport protocol to be used by the VPN session.

Default value: udp

pub fn set_transport_protocol(self, input: Option<TransportProtocol>) -> Self

The transport protocol to be used by the VPN session.

Default value: udp

pub fn vpn_port(self, input: i32) -> Self

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Valid Values: 443 | 1194

Default Value: 443

pub fn set_vpn_port(self, input: Option<i32>) -> Self

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, input: impl Into<String>) -> Self

A brief description of the Client VPN endpoint.

pub fn set_description(self, input: Option<String>) -> Self

A brief description of the Client VPN endpoint.

pub fn split_tunnel(self, input: bool) -> Self

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 set_split_tunnel(self, input: Option<bool>) -> Self

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, input: bool) -> Self

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 set_dry_run(self, input: Option<bool>) -> Self

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, input: impl Into<String>) -> Self

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

pub fn set_client_token(self, input: Option<String>) -> Self

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, input: TagSpecification) -> Self

Appends an item to TagSpecifications.

To override the contents of this collection use set_tag_specifications.

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

pub fn set_tag_specifications(self, input: Option<Vec<TagSpecification>>) -> Self

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

pub fn security_group_ids(self, input: impl Into<String>) -> Self

Appends an item to SecurityGroupIds.

To override the contents of this collection use set_security_group_ids.

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 set_security_group_ids(self, input: Option<Vec<String>>) -> Self

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, input: impl Into<String>) -> Self

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 set_vpc_id(self, input: Option<String>) -> Self

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, input: SelfServicePortal) -> Self

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

Default Value: enabled

pub fn set_self_service_portal(self, input: Option<SelfServicePortal>) -> Self

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

Default Value: enabled

pub fn client_connect_options(self, input: ClientConnectOptions) -> Self

The options for managing connection authorization for new client connections.

pub fn set_client_connect_options(
    self,
    input: Option<ClientConnectOptions>
) -> Self

The options for managing connection authorization for new client connections.

pub fn session_timeout_hours(self, input: i32) -> Self

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

pub fn set_session_timeout_hours(self, input: Option<i32>) -> Self

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

pub fn client_login_banner_options(self, input: ClientLoginBannerOptions) -> Self

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

pub fn set_client_login_banner_options(
    self,
    input: Option<ClientLoginBannerOptions>
) -> Self

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

Trait Implementations

impl Clone for CreateClientVpnEndpoint

fn clone(&self) -> CreateClientVpnEndpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateClientVpnEndpoint

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

Formats the value using the given formatter.