Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

ExportClientVpnClientConfiguration

Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.

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.

Type: String

Required: Yes

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

Response Elements

The following elements are returned by the service.

clientConfiguration

The contents of the Client VPN endpoint configuration file.

Type: String

requestId

The ID of the request.

Type: String

Errors

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

Example

Example

This example downloads a Client VPN endpoint configuration file.

Sample Request

https://ec2.amazonaws.com/?Action=ExportClientVpnClientConfiguration &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &AUTHPARAMS

Sample Response

<ExportClientVpnClientConfigurationResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>44e88bf8-d460-4c43-80b8-a27e4EXAMPLE</requestId> <clientConfiguration>client dev tun proto udp remote cvpn-endpoint-00c5d11fc4EXAMPLE.clientvpn.us-east-1.amazonaws.com 443 remote-random-hostname resolv-retry infinite nobind persist-key persist-tun remote-cert-tls server cipher AES-256-CBC verb 3 <ca> -----BEGIN CERTIFICATE----- EXAMPLECAgmgAwIBAgIJAOjnW3hL6o+7MA0GCSqGSIb3DQEBCwUAMBAxDEXAMPLE -----END CERTIFICATE----- </ca></clientConfiguration> </ExportClientVpnClientConfigurationResponse>

See Also

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