Struct aws_sdk_ec2::input::modify_client_vpn_endpoint_input::Builder

pub struct Builder { /* private fields */ }

A builder for ModifyClientVpnEndpointInput.

Implementations

impl Builder

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

The ID of the Client VPN endpoint to modify.

Examples found in repository

src/client.rs (line 63297)

        pub fn client_vpn_endpoint_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.client_vpn_endpoint_id(input.into());
            self
        }

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

The ID of the Client VPN endpoint to modify.

Examples found in repository

src/client.rs (line 63305)

        pub fn set_client_vpn_endpoint_id(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_client_vpn_endpoint_id(input);
            self
        }

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

The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).

Examples found in repository

src/client.rs (line 63310)

        pub fn server_certificate_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.server_certificate_arn(input.into());
            self
        }

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

The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).

Examples found in repository

src/client.rs (line 63318)

        pub fn set_server_certificate_arn(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_server_certificate_arn(input);
            self
        }

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

Examples found in repository

src/client.rs (line 63330)

        pub fn connection_log_options(mut self, input: crate::model::ConnectionLogOptions) -> Self {
            self.inner = self.inner.connection_log_options(input);
            self
        }

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

Examples found in repository

src/client.rs (line 63345)

        pub fn set_connection_log_options(
            mut self,
            input: std::option::Option<crate::model::ConnectionLogOptions>,
        ) -> Self {
            self.inner = self.inner.set_connection_log_options(input);
            self
        }

pub fn dns_servers(self, input: DnsServersOptionsModifyStructure) -> Self

Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.

Examples found in repository

src/client.rs (line 63353)

        pub fn dns_servers(
            mut self,
            input: crate::model::DnsServersOptionsModifyStructure,
        ) -> Self {
            self.inner = self.inner.dns_servers(input);
            self
        }

pub fn set_dns_servers(
    self,
    input: Option<DnsServersOptionsModifyStructure>
) -> Self

Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.

Examples found in repository

src/client.rs (line 63361)

        pub fn set_dns_servers(
            mut self,
            input: std::option::Option<crate::model::DnsServersOptionsModifyStructure>,
        ) -> Self {
            self.inner = self.inner.set_dns_servers(input);
            self
        }

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

Examples found in repository

src/client.rs (line 63368)

        pub fn vpn_port(mut self, input: i32) -> Self {
            self.inner = self.inner.vpn_port(input);
            self
        }

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

Examples found in repository

src/client.rs (line 63375)

        pub fn set_vpn_port(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_vpn_port(input);
            self
        }

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

A brief description of the Client VPN endpoint.

Examples found in repository

src/client.rs (line 63380)

        pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.description(input.into());
            self
        }

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

A brief description of the Client VPN endpoint.

Examples found in repository

src/client.rs (line 63385)

        pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_description(input);
            self
        }

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

Indicates whether the VPN is split-tunnel.

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.

Examples found in repository

src/client.rs (line 63391)

        pub fn split_tunnel(mut self, input: bool) -> Self {
            self.inner = self.inner.split_tunnel(input);
            self
        }

pub fn set_split_tunnel(self, input: Option<bool>) -> Self

Indicates whether the VPN is split-tunnel.

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.

Examples found in repository

src/client.rs (line 63397)

        pub fn set_split_tunnel(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_split_tunnel(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 63402)

        pub fn dry_run(mut self, input: bool) -> Self {
            self.inner = self.inner.dry_run(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 63407)

        pub fn set_dry_run(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_dry_run(input);
            self
        }

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

Appends an item to security_group_ids.

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.

Examples found in repository

src/client.rs (line 63416)

        pub fn security_group_ids(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.security_group_ids(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 63424)

        pub fn set_security_group_ids(
            mut self,
            input: std::option::Option<std::vec::Vec<std::string::String>>,
        ) -> Self {
            self.inner = self.inner.set_security_group_ids(input);
            self
        }

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

The ID of the VPC to associate with the Client VPN endpoint.

Examples found in repository

src/client.rs (line 63429)

        pub fn vpc_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.vpc_id(input.into());
            self
        }

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

The ID of the VPC to associate with the Client VPN endpoint.

Examples found in repository

src/client.rs (line 63434)

        pub fn set_vpc_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_vpc_id(input);
            self
        }

pub fn self_service_portal(self, input: SelfServicePortal) -> Self

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

Examples found in repository

src/client.rs (line 63439)

        pub fn self_service_portal(mut self, input: crate::model::SelfServicePortal) -> Self {
            self.inner = self.inner.self_service_portal(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 63447)

        pub fn set_self_service_portal(
            mut self,
            input: std::option::Option<crate::model::SelfServicePortal>,
        ) -> Self {
            self.inner = self.inner.set_self_service_portal(input);
            self
        }

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

The options for managing connection authorization for new client connections.

Examples found in repository

src/client.rs (line 63452)

        pub fn client_connect_options(mut self, input: crate::model::ClientConnectOptions) -> Self {
            self.inner = self.inner.client_connect_options(input);
            self
        }

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

The options for managing connection authorization for new client connections.

Examples found in repository

src/client.rs (line 63460)

        pub fn set_client_connect_options(
            mut self,
            input: std::option::Option<crate::model::ClientConnectOptions>,
        ) -> Self {
            self.inner = self.inner.set_client_connect_options(input);
            self
        }

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

Examples found in repository

src/client.rs (line 63467)

        pub fn session_timeout_hours(mut self, input: i32) -> Self {
            self.inner = self.inner.session_timeout_hours(input);
            self
        }

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

Examples found in repository

src/client.rs (line 63474)

        pub fn set_session_timeout_hours(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_session_timeout_hours(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 63482)

        pub fn client_login_banner_options(
            mut self,
            input: crate::model::ClientLoginBannerOptions,
        ) -> Self {
            self.inner = self.inner.client_login_banner_options(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 63490)

        pub fn set_client_login_banner_options(
            mut self,
            input: std::option::Option<crate::model::ClientLoginBannerOptions>,
        ) -> Self {
            self.inner = self.inner.set_client_login_banner_options(input);
            self
        }

pub fn build(self) -> Result<ModifyClientVpnEndpointInput, BuildError>

Consumes the builder and constructs a ModifyClientVpnEndpointInput.

Examples found in repository

src/client.rs (line 63264)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::ModifyClientVpnEndpoint,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::ModifyClientVpnEndpointError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::ModifyClientVpnEndpointOutput,
            aws_smithy_http::result::SdkError<crate::error::ModifyClientVpnEndpointError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> 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 Builder