GET /#Action=ModifyClientVpnEndpoint

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

Servers

Request headers

Name Type Required Description
X-Amz-Content-Sha256 String No
X-Amz-Credential String No
X-Amz-Date String No
X-Amz-Algorithm String No
X-Amz-SignedHeaders String No
X-Amz-Security-Token String No
X-Amz-Signature String No

Query parameters

Name Type Required Description
VpnPort Integer No

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

Valid Values: 443 | 1194

Default Value: 443

Version String Yes

Possible values:

  • "2016-11-15"
ConnectionLogOptions Object No

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

ClientVpnEndpointId String Yes

The ID of the Client VPN endpoint to modify.

SplitTunnel Boolean No

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.

SelfServicePortal String No

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

Possible values:

  • "disabled"
  • "enabled"
VpcId String No

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

ClientConnectOptions Object No

The options for managing connection authorization for new client connections.

Description String No

A brief description of the Client VPN endpoint.

ClientLoginBannerOptions Object No

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

ServerCertificateArn String No

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

DnsServers Object No

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

SecurityGroupId[] Array No

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

SessionTimeoutHours Integer No

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

DryRun Boolean No

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.

Action String Yes

Possible values:

  • "ModifyClientVpnEndpoint"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.