GET /#Action=CreateClientVpnEndpoint

Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.

Servers

https://ec2.{region}.amazonaws.com
https://ec2.amazonaws.com
https://ec2.{region}.amazonaws.com.cn

Request headers

Name	Type	Required
`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"`
`Authentication[]`	Array	Yes	Information about the authentication method to be used to authenticate clients.
`ConnectionLogOptions`	Object	Yes	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
`SplitTunnel`	Boolean	No	Indicates whether split-tunnel is enabled on the Client VPN endpoint. By default, split-tunnel on a VPN endpoint is disabled. 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. Default Value: `enabled` Possible values: `"disabled"` `"enabled"`
`VpcId`	String	No	The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.
`ClientConnectOptions`	Object	No	The options for managing connection authorization for new client connections.
`TransportProtocol`	String	No	The transport protocol to be used by the VPN session. Default value: `udp` Possible values: `"tcp"` `"udp"`
`ClientCidrBlock`	String	Yes	The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.
`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	Yes	The ARN of the server certificate. For more information, see the Certificate Manager User Guide.
`DnsServers[]`	Array	No	Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
`ClientToken`	String	No	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
`SecurityGroupId[]`	Array	No	The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.
`SessionTimeoutHours`	Integer	No	The maximum VPN session duration time in hours. Valid values: `8 \| 10 \| 12 \| 24` Default value: `24`
`TagSpecification[]`	Array	No	The tags to apply to the Client VPN endpoint during creation.
`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: `"CreateClientVpnEndpoint"`

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.