Struct aws_sdk_ec2::input::create_client_vpn_endpoint_input::Builder

pub struct Builder { /* private fields */ }

A builder for CreateClientVpnEndpointInput.

Implementations

impl Builder

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. The CIDR block should be /22 or greater.

Examples found in repository

src/client.rs (line 14739)

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

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. The CIDR block should be /22 or greater.

Examples found in repository

src/client.rs (line 14747)

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

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.

Examples found in repository

src/client.rs (line 14752)

        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. For more information, see the Certificate Manager User Guide.

Examples found in repository

src/client.rs (line 14760)

        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 authentication_options(
    self,
    input: ClientVpnAuthenticationRequest
) -> Self

Appends an item to authentication_options.

To override the contents of this collection use set_authentication_options.

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

Examples found in repository

src/client.rs (line 14772)

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

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

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

Examples found in repository

src/client.rs (line 14780)

        pub fn set_authentication_options(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::ClientVpnAuthenticationRequest>>,
        ) -> Self {
            self.inner = self.inner.set_authentication_options(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 14792)

        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 14807)

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

Appends an item to dns_servers.

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.

Examples found in repository

src/client.rs (line 14816)

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

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.

Examples found in repository

src/client.rs (line 14824)

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

pub fn transport_protocol(self, input: TransportProtocol) -> Self

The transport protocol to be used by the VPN session.

Default value: udp

Examples found in repository

src/client.rs (line 14830)

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

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

The transport protocol to be used by the VPN session.

Default value: udp

Examples found in repository

src/client.rs (line 14839)

        pub fn set_transport_protocol(
            mut self,
            input: std::option::Option<crate::model::TransportProtocol>,
        ) -> Self {
            self.inner = self.inner.set_transport_protocol(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 14846)

        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 14853)

        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 14858)

        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 14863)

        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 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.

Examples found in repository

src/client.rs (line 14870)

        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 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.

Examples found in repository

src/client.rs (line 14877)

        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 14882)

        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 14887)

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

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.

Examples found in repository

src/client.rs (line 14892)

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

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.

Examples found in repository

src/client.rs (line 14897)

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

pub fn tag_specifications(self, input: TagSpecification) -> Self

Appends an item to tag_specifications.

To override the contents of this collection use set_tag_specifications.

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

Examples found in repository

src/client.rs (line 14906)

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

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

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

Examples found in repository

src/client.rs (line 14914)

        pub fn set_tag_specifications(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::TagSpecification>>,
        ) -> Self {
            self.inner = self.inner.set_tag_specifications(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. You must also specify the ID of the VPC that contains the security groups.

Examples found in repository

src/client.rs (line 14923)

        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. You must also specify the ID of the VPC that contains the security groups.

Examples found in repository

src/client.rs (line 14931)

        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. If no security group IDs are specified in the request, the default security group for the VPC is applied.

Examples found in repository

src/client.rs (line 14936)

        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. If no security group IDs are specified in the request, the default security group for the VPC is applied.

Examples found in repository

src/client.rs (line 14941)

        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.

Default Value: enabled

Examples found in repository

src/client.rs (line 14947)

        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.

Default Value: enabled

Examples found in repository

src/client.rs (line 14956)

        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 14961)

        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 14969)

        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 14976)

        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 14983)

        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 14991)

        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 14999)

        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<CreateClientVpnEndpointInput, BuildError>

Consumes the builder and constructs a CreateClientVpnEndpointInput.

Examples found in repository

src/client.rs (line 14706)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateClientVpnEndpoint,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateClientVpnEndpointError>,
        > {
            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::CreateClientVpnEndpointOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateClientVpnEndpointError>,
        > {
            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