Package software.amazon.awssdk.services.ec2.model

Interface ClientVpnEndpoint.Builder

    • Method Detail

      • clientVpnEndpointId

        ClientVpnEndpoint.Builder clientVpnEndpointId​(String clientVpnEndpointId)

        The ID of the Client VPN endpoint.

        Parameters:
        clientVpnEndpointId - The ID of the Client VPN endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        ClientVpnEndpoint.Builder description​(String description)

        A brief description of the endpoint.

        Parameters:
        description - A brief description of the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        ClientVpnEndpoint.Builder status​(ClientVpnEndpointStatus status)

        The current state of the Client VPN endpoint.

        Parameters:
        status - The current state of the Client VPN endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationTime

        ClientVpnEndpoint.Builder creationTime​(String creationTime)

        The date and time the Client VPN endpoint was created.

        Parameters:
        creationTime - The date and time the Client VPN endpoint was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deletionTime

        ClientVpnEndpoint.Builder deletionTime​(String deletionTime)

        The date and time the Client VPN endpoint was deleted, if applicable.

        Parameters:
        deletionTime - The date and time the Client VPN endpoint was deleted, if applicable.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dnsName

        ClientVpnEndpoint.Builder dnsName​(String dnsName)

        The DNS name to be used by clients when connecting to the Client VPN endpoint.

        Parameters:
        dnsName - The DNS name to be used by clients when connecting to the Client VPN endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientCidrBlock

        ClientVpnEndpoint.Builder clientCidrBlock​(String clientCidrBlock)

        The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

        Parameters:
        clientCidrBlock - The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dnsServers

        ClientVpnEndpoint.Builder dnsServers​(Collection<String> dnsServers)

        Information about the DNS servers to be used for DNS resolution.

        Parameters:
        dnsServers - Information about the DNS servers to be used for DNS resolution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dnsServers

        ClientVpnEndpoint.Builder dnsServers​(String... dnsServers)

        Information about the DNS servers to be used for DNS resolution.

        Parameters:
        dnsServers - Information about the DNS servers to be used for DNS resolution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • splitTunnel

        ClientVpnEndpoint.Builder splitTunnel​(Boolean splitTunnel)

        Indicates whether split-tunnel is enabled in the Client VPN endpoint.

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

        Parameters:
        splitTunnel - Indicates whether split-tunnel is enabled in the Client VPN endpoint.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpnProtocol

        ClientVpnEndpoint.Builder vpnProtocol​(String vpnProtocol)

        The protocol used by the VPN session.

        Parameters:
        vpnProtocol - The protocol used by the VPN session.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        VpnProtocol, VpnProtocol

      • vpnProtocol

        ClientVpnEndpoint.Builder vpnProtocol​(VpnProtocol vpnProtocol)

        The protocol used by the VPN session.

        Parameters:
        vpnProtocol - The protocol used by the VPN session.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        VpnProtocol, VpnProtocol

      • transportProtocol

        ClientVpnEndpoint.Builder transportProtocol​(String transportProtocol)

        The transport protocol used by the Client VPN endpoint.

        Parameters:
        transportProtocol - The transport protocol used by the Client VPN endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TransportProtocol, TransportProtocol

      • transportProtocol

        ClientVpnEndpoint.Builder transportProtocol​(TransportProtocol transportProtocol)

        The transport protocol used by the Client VPN endpoint.

        Parameters:
        transportProtocol - The transport protocol used by the Client VPN endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TransportProtocol, TransportProtocol

      • vpnPort

        ClientVpnEndpoint.Builder vpnPort​(Integer vpnPort)

        The port number for the Client VPN endpoint.

        Parameters:
        vpnPort - The port number for the Client VPN endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • associatedTargetNetworks

        @Deprecated
ClientVpnEndpoint.Builder associatedTargetNetworks​(Collection<AssociatedTargetNetwork> associatedTargetNetworks)
        Deprecated.
        This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.

        Information about the associated target networks. A target network is a subnet in a VPC.

        Parameters:
        associatedTargetNetworks - Information about the associated target networks. A target network is a subnet in a VPC.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • associatedTargetNetworks

        @Deprecated
ClientVpnEndpoint.Builder associatedTargetNetworks​(AssociatedTargetNetwork... associatedTargetNetworks)
        Deprecated.
        This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.

        Information about the associated target networks. A target network is a subnet in a VPC.

        Parameters:
        associatedTargetNetworks - Information about the associated target networks. A target network is a subnet in a VPC.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • associatedTargetNetworks

        @Deprecated
ClientVpnEndpoint.Builder associatedTargetNetworks​(Consumer<AssociatedTargetNetwork.Builder>... associatedTargetNetworks)
        Deprecated.
        This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.

        Information about the associated target networks. A target network is a subnet in a VPC.

        This is a convenience method that creates an instance of the AssociatedTargetNetwork.Builder avoiding the need to create one manually via AssociatedTargetNetwork.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #associatedTargetNetworks(List).

        Parameters:
        associatedTargetNetworks - a consumer that will call methods on AssociatedTargetNetwork.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #associatedTargetNetworks(java.util.Collection)

      • serverCertificateArn

        ClientVpnEndpoint.Builder serverCertificateArn​(String serverCertificateArn)

        The ARN of the server certificate.

        Parameters:
        serverCertificateArn - The ARN of the server certificate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • authenticationOptions

        ClientVpnEndpoint.Builder authenticationOptions​(Collection<ClientVpnAuthentication> authenticationOptions)

        Information about the authentication method used by the Client VPN endpoint.

        Parameters:
        authenticationOptions - Information about the authentication method used by the Client VPN endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • authenticationOptions

        ClientVpnEndpoint.Builder authenticationOptions​(ClientVpnAuthentication... authenticationOptions)

        Information about the authentication method used by the Client VPN endpoint.

        Parameters:
        authenticationOptions - Information about the authentication method used by the Client VPN endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • connectionLogOptions

        ClientVpnEndpoint.Builder connectionLogOptions​(ConnectionLogResponseOptions connectionLogOptions)

        Information about the client connection logging options for the Client VPN endpoint.

        Parameters:
        connectionLogOptions - Information about the client connection logging options for the Client VPN endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        ClientVpnEndpoint.Builder tags​(Collection<Tag> tags)

        Any tags assigned to the Client VPN endpoint.

        Parameters:
        tags - Any tags assigned to the Client VPN endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        ClientVpnEndpoint.Builder tags​(Tag... tags)

        Any tags assigned to the Client VPN endpoint.

        Parameters:
        tags - Any tags assigned to the Client VPN endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        ClientVpnEndpoint.Builder tags​(Consumer<Tag.Builder>... tags)

        Any tags assigned to the Client VPN endpoint.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • securityGroupIds

        ClientVpnEndpoint.Builder securityGroupIds​(Collection<String> securityGroupIds)

        The IDs of the security groups for the target network.

        Parameters:
        securityGroupIds - The IDs of the security groups for the target network.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • securityGroupIds

        ClientVpnEndpoint.Builder securityGroupIds​(String... securityGroupIds)

        The IDs of the security groups for the target network.

        Parameters:
        securityGroupIds - The IDs of the security groups for the target network.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcId

        ClientVpnEndpoint.Builder vpcId​(String vpcId)

        The ID of the VPC.

        Parameters:
        vpcId - The ID of the VPC.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • selfServicePortalUrl

        ClientVpnEndpoint.Builder selfServicePortalUrl​(String selfServicePortalUrl)

        The URL of the self-service portal.

        Parameters:
        selfServicePortalUrl - The URL of the self-service portal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientConnectOptions

        ClientVpnEndpoint.Builder clientConnectOptions​(ClientConnectResponseOptions clientConnectOptions)

        The options for managing connection authorization for new client connections.

        Parameters:
        clientConnectOptions - The options for managing connection authorization for new client connections.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sessionTimeoutHours

        ClientVpnEndpoint.Builder sessionTimeoutHours​(Integer sessionTimeoutHours)

        The maximum VPN session duration time in hours.

        Valid values: 8 | 10 | 12 | 24

        Default value: 24

        Parameters:
        sessionTimeoutHours - The maximum VPN session duration time in hours.

        Valid values: 8 | 10 | 12 | 24

        Default value: 24

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientLoginBannerOptions

        ClientVpnEndpoint.Builder clientLoginBannerOptions​(ClientLoginBannerResponseOptions clientLoginBannerOptions)

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

        Parameters:
        clientLoginBannerOptions - Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientRouteEnforcementOptions

        ClientVpnEndpoint.Builder clientRouteEnforcementOptions​(ClientRouteEnforcementResponseOptions 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • disconnectOnSessionTimeout

        ClientVpnEndpoint.Builder disconnectOnSessionTimeout​(Boolean disconnectOnSessionTimeout)

        Indicates whether the client VPN session is disconnected after the maximum 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.

        Parameters:
        disconnectOnSessionTimeout - Indicates whether the client VPN session is disconnected after the maximum 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endpointIpAddressType

        ClientVpnEndpoint.Builder endpointIpAddressType​(String endpointIpAddressType)

        The IP address type of the Client VPN endpoint. Possible values are ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.

        Parameters:
        endpointIpAddressType - The IP address type of the Client VPN endpoint. Possible values are ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EndpointIpAddressType, EndpointIpAddressType

      • endpointIpAddressType

        ClientVpnEndpoint.Builder endpointIpAddressType​(EndpointIpAddressType endpointIpAddressType)

        The IP address type of the Client VPN endpoint. Possible values are ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.

        Parameters:
        endpointIpAddressType - The IP address type of the Client VPN endpoint. Possible values are ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EndpointIpAddressType, EndpointIpAddressType

      • trafficIpAddressType

        ClientVpnEndpoint.Builder trafficIpAddressType​(String trafficIpAddressType)

        The IP address type of the Client VPN endpoint. Possible values are either ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.

        Parameters:
        trafficIpAddressType - The IP address type of the Client VPN endpoint. Possible values are either ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TrafficIpAddressType, TrafficIpAddressType

      • trafficIpAddressType

        ClientVpnEndpoint.Builder trafficIpAddressType​(TrafficIpAddressType trafficIpAddressType)

        The IP address type of the Client VPN endpoint. Possible values are either ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.

        Parameters:
        trafficIpAddressType - The IP address type of the Client VPN endpoint. Possible values are either ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TrafficIpAddressType, TrafficIpAddressType