amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.ModifyClientVpnEndpoint

Description

Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.

Synopsis

Creating a Request

data ModifyClientVpnEndpoint Source #

See: newModifyClientVpnEndpoint smart constructor.

Constructors

ModifyClientVpnEndpoint' 

Fields

  • clientConnectOptions :: Maybe ClientConnectOptions

    The options for managing connection authorization for new client connections.

  • clientLoginBannerOptions :: Maybe ClientLoginBannerOptions

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

  • connectionLogOptions :: Maybe 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
  • description :: Maybe Text

    A brief description of the Client VPN endpoint.

  • dnsServers :: Maybe DnsServersOptionsModifyStructure

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

  • dryRun :: Maybe 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.

  • securityGroupIds :: Maybe [Text]

    The IDs of one or more security groups to apply to the target network.

  • selfServicePortal :: Maybe SelfServicePortal

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

  • serverCertificateArn :: Maybe Text

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

  • sessionTimeoutHours :: Maybe Int

    The maximum VPN session duration time in hours.

    Valid values: 8 | 10 | 12 | 24

    Default value: 24

  • splitTunnel :: Maybe Bool

    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.

  • vpcId :: Maybe Text

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

  • vpnPort :: Maybe Int

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

    Valid Values: 443 | 1194

    Default Value: 443

  • clientVpnEndpointId :: Text

    The ID of the Client VPN endpoint to modify.

Instances

Instances details
ToHeaders ModifyClientVpnEndpoint Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

ToPath ModifyClientVpnEndpoint Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

ToQuery ModifyClientVpnEndpoint Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

AWSRequest ModifyClientVpnEndpoint Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

Generic ModifyClientVpnEndpoint Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

Associated Types

type Rep ModifyClientVpnEndpoint :: Type -> Type #

Read ModifyClientVpnEndpoint Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

Show ModifyClientVpnEndpoint Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

NFData ModifyClientVpnEndpoint Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

Methods

rnf :: ModifyClientVpnEndpoint -> () #

Eq ModifyClientVpnEndpoint Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

Hashable ModifyClientVpnEndpoint Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

type AWSResponse ModifyClientVpnEndpoint Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

type Rep ModifyClientVpnEndpoint Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

type Rep ModifyClientVpnEndpoint = D1 ('MetaData "ModifyClientVpnEndpoint" "Amazonka.EC2.ModifyClientVpnEndpoint" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyClientVpnEndpoint'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientConnectOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientConnectOptions)) :*: (S1 ('MetaSel ('Just "clientLoginBannerOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientLoginBannerOptions)) :*: S1 ('MetaSel ('Just "connectionLogOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionLogOptions)))) :*: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dnsServers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DnsServersOptionsModifyStructure))) :*: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "selfServicePortal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SelfServicePortal)) :*: (S1 ('MetaSel ('Just "serverCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sessionTimeoutHours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "splitTunnel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "vpnPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "clientVpnEndpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newModifyClientVpnEndpoint Source #

Create a value of ModifyClientVpnEndpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ModifyClientVpnEndpoint, modifyClientVpnEndpoint_clientConnectOptions - The options for managing connection authorization for new client connections.

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

ModifyClientVpnEndpoint, modifyClientVpnEndpoint_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

ModifyClientVpnEndpoint, modifyClientVpnEndpoint_description - A brief description of the Client VPN endpoint.

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

$sel:dryRun:ModifyClientVpnEndpoint', modifyClientVpnEndpoint_dryRun - 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.

ModifyClientVpnEndpoint, modifyClientVpnEndpoint_securityGroupIds - The IDs of one or more security groups to apply to the target network.

$sel:selfServicePortal:ModifyClientVpnEndpoint', modifyClientVpnEndpoint_selfServicePortal - Specify whether to enable the self-service portal for the Client VPN endpoint.

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

ModifyClientVpnEndpoint, modifyClientVpnEndpoint_sessionTimeoutHours - The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

ModifyClientVpnEndpoint, modifyClientVpnEndpoint_splitTunnel - 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.

ModifyClientVpnEndpoint, modifyClientVpnEndpoint_vpcId - The ID of the VPC to associate with the Client VPN endpoint.

ModifyClientVpnEndpoint, modifyClientVpnEndpoint_vpnPort - The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Valid Values: 443 | 1194

Default Value: 443

ModifyClientVpnEndpoint, modifyClientVpnEndpoint_clientVpnEndpointId - The ID of the Client VPN endpoint to modify.

Request Lenses

modifyClientVpnEndpoint_clientConnectOptions :: Lens' ModifyClientVpnEndpoint (Maybe ClientConnectOptions) Source #

The options for managing connection authorization for new client connections.

modifyClientVpnEndpoint_clientLoginBannerOptions :: Lens' ModifyClientVpnEndpoint (Maybe ClientLoginBannerOptions) Source #

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

modifyClientVpnEndpoint_connectionLogOptions :: Lens' ModifyClientVpnEndpoint (Maybe ConnectionLogOptions) Source #

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

modifyClientVpnEndpoint_description :: Lens' ModifyClientVpnEndpoint (Maybe Text) Source #

A brief description of the Client VPN endpoint.

modifyClientVpnEndpoint_dnsServers :: Lens' ModifyClientVpnEndpoint (Maybe DnsServersOptionsModifyStructure) Source #

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

modifyClientVpnEndpoint_dryRun :: Lens' ModifyClientVpnEndpoint (Maybe Bool) Source #

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.

modifyClientVpnEndpoint_securityGroupIds :: Lens' ModifyClientVpnEndpoint (Maybe [Text]) Source #

The IDs of one or more security groups to apply to the target network.

modifyClientVpnEndpoint_selfServicePortal :: Lens' ModifyClientVpnEndpoint (Maybe SelfServicePortal) Source #

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

modifyClientVpnEndpoint_serverCertificateArn :: Lens' ModifyClientVpnEndpoint (Maybe Text) Source #

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

modifyClientVpnEndpoint_sessionTimeoutHours :: Lens' ModifyClientVpnEndpoint (Maybe Int) Source #

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

modifyClientVpnEndpoint_splitTunnel :: Lens' ModifyClientVpnEndpoint (Maybe Bool) Source #

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.

modifyClientVpnEndpoint_vpcId :: Lens' ModifyClientVpnEndpoint (Maybe Text) Source #

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

modifyClientVpnEndpoint_vpnPort :: Lens' ModifyClientVpnEndpoint (Maybe Int) Source #

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

Valid Values: 443 | 1194

Default Value: 443

Destructuring the Response

data ModifyClientVpnEndpointResponse Source #

See: newModifyClientVpnEndpointResponse smart constructor.

Constructors

ModifyClientVpnEndpointResponse' 

Fields

Instances

Instances details
Generic ModifyClientVpnEndpointResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

Associated Types

type Rep ModifyClientVpnEndpointResponse :: Type -> Type #

Read ModifyClientVpnEndpointResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

Show ModifyClientVpnEndpointResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

NFData ModifyClientVpnEndpointResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

Eq ModifyClientVpnEndpointResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

type Rep ModifyClientVpnEndpointResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyClientVpnEndpoint

type Rep ModifyClientVpnEndpointResponse = D1 ('MetaData "ModifyClientVpnEndpointResponse" "Amazonka.EC2.ModifyClientVpnEndpoint" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyClientVpnEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "return'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyClientVpnEndpointResponse Source #

Create a value of ModifyClientVpnEndpointResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:return':ModifyClientVpnEndpointResponse', modifyClientVpnEndpointResponse_return - Returns true if the request succeeds; otherwise, it returns an error.

$sel:httpStatus:ModifyClientVpnEndpointResponse', modifyClientVpnEndpointResponse_httpStatus - The response's http status code.

Response Lenses

modifyClientVpnEndpointResponse_return :: Lens' ModifyClientVpnEndpointResponse (Maybe Bool) Source #

Returns true if the request succeeds; otherwise, it returns an error.