GET

/#Action=ModifyClientVpnEndpoint

http://ec2.{region}.amazonaws.com/#Action=ModifyClientVpnEndpoint

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

Access Token Required: API Key

Query Params

ClientVpnEndpointIdstringrequired

The ID of the Client VPN endpoint to modify.

ServerCertificateArnstring

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

ConnectionLogOptionsobject

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: <ul> <li> Client connection requests </li> <li> Client connection results (successful and unsuccessful) </li> <li> Reasons for unsuccessful client connection requests </li> <li> Client connection termination time </li> </ul>

DnsServersobject

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

VpnPortinteger

The port number to assign to the Client VPN endpoint for TCP and UDP traffic. Valid Values: <code>443</code> | <code>1194</code> Default Value: <code>443</code>

Descriptionstring

A brief description of the Client VPN endpoint.

SplitTunnelboolean

Indicates whether the VPN is split-tunnel. For information about split-tunnel VPN endpoints, see <a href="https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html">Split-tunnel Client VPN endpoint</a> in the Client VPN Administrator Guide.

DryRunboolean

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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

SecurityGroupIdarray

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

VpcIdstring

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

SelfServicePortalstring

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

Allowed:

ClientConnectOptionsobject

The options for managing connection authorization for new client connections.

SessionTimeoutHoursinteger

The maximum VPN session duration time in hours. Valid values: <code>8 | 10 | 12 | 24</code> Default value: <code>24</code>

ClientLoginBannerOptionsobject

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

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://ec2.{region}.amazonaws.com/#Action=ModifyClientVpnEndpoint' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}