ModifyClientVpnEndpoint - Amazon Elastic Compute Cloud

ModifyClientVpnEndpoint

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

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

ClientVpnEndpointId

The ID of the Client VPN endpoint to modify.

Type: String

Required: Yes

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

Type: ConnectionLogOptions object

Required: No

Description

A brief description of the Client VPN endpoint.

Type: String

Required: No

DnsServers

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

Type: DnsServersOptionsModifyStructure object

Required: No

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.

Type: Boolean

Required: No

SecurityGroupId.N

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

Type: Array of strings

Required: No

ServerCertificateArn

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

Type: String

Required: No

SplitTunnel

Indicates whether the VPN is split-tunnel.

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

Type: Boolean

Required: No

VpcId

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

Type: String

Required: No

VpnPort

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

Valid Values: 443 | 1194

Default Value: 443

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

return

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

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Example

Example

This example modifies a Client VPN endpoint's description.

Sample Request

https://ec2.amazonaws.com/?Action=ModifyClientVpnEndpoint &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &Description=my-client-vpn-endpoint &AUTHPARAMS

Sample Response

<ModifyClientVpnEndpointResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>fe4813d3-1e79-4f67-bbd7-3186eEXAMPLE</requestId> <return>true</return> </ModifyClientVpnEndpointResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: