/AWS1/CL_EC2=>CREATECLIENTVPNENDPOINT()
¶
About 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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CLIENTCIDRBLOCK
TYPE /AWS1/EC2STRING
/AWS1/EC2STRING
¶
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.
IV_SERVERCERTIFICATEARN
TYPE /AWS1/EC2STRING
/AWS1/EC2STRING
¶
The ARN of the server certificate. For more information, see the Certificate Manager User Guide.
IT_AUTHENTICATIONOPTIONS
TYPE /AWS1/CL_EC2CLIVPNAUTHNTCTNREQ=>TT_CLIENTVPNAUTHNTCTNREQLIST
TT_CLIENTVPNAUTHNTCTNREQLIST
¶
Information about the authentication method to be used to authenticate clients.
IO_CONNECTIONLOGOPTIONS
TYPE REF TO /AWS1/CL_EC2CONNLOGOPTIONS
/AWS1/CL_EC2CONNLOGOPTIONS
¶
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
Optional arguments:¶
IT_DNSSERVERS
TYPE /AWS1/CL_EC2VALUESTRINGLIST_W=>TT_VALUESTRINGLIST
TT_VALUESTRINGLIST
¶
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.
IV_TRANSPORTPROTOCOL
TYPE /AWS1/EC2TRANSPORTPROTOCOL
/AWS1/EC2TRANSPORTPROTOCOL
¶
The transport protocol to be used by the VPN session.
Default value:
udp
IV_VPNPORT
TYPE /AWS1/EC2INTEGER
/AWS1/EC2INTEGER
¶
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values:
443
|1194
Default Value:
443
IV_DESCRIPTION
TYPE /AWS1/EC2STRING
/AWS1/EC2STRING
¶
A brief description of the Client VPN endpoint.
IV_SPLITTUNNEL
TYPE /AWS1/EC2BOOLEAN
/AWS1/EC2BOOLEAN
¶
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.
IV_DRYRUN
TYPE /AWS1/EC2BOOLEAN
/AWS1/EC2BOOLEAN
¶
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 isUnauthorizedOperation
.
IV_CLIENTTOKEN
TYPE /AWS1/EC2STRING
/AWS1/EC2STRING
¶
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
IT_TAGSPECIFICATIONS
TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST
TT_TAGSPECIFICATIONLIST
¶
The tags to apply to the Client VPN endpoint during creation.
IT_SECURITYGROUPIDS
TYPE /AWS1/CL_EC2CLIVPNSECGRIDSET_W=>TT_CLIENTVPNSECURITYGROUPIDSET
TT_CLIENTVPNSECURITYGROUPIDSET
¶
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.
IV_VPCID
TYPE /AWS1/EC2VPCID
/AWS1/EC2VPCID
¶
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.
IV_SELFSERVICEPORTAL
TYPE /AWS1/EC2SELFSERVICEPORTAL
/AWS1/EC2SELFSERVICEPORTAL
¶
Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value:
enabled
IO_CLIENTCONNECTOPTIONS
TYPE REF TO /AWS1/CL_EC2CLIENTCNCTOPTIONS
/AWS1/CL_EC2CLIENTCNCTOPTIONS
¶
The options for managing connection authorization for new client connections.
IV_SESSIONTIMEOUTHOURS
TYPE /AWS1/EC2INTEGER
/AWS1/EC2INTEGER
¶
The maximum VPN session duration time in hours.
Valid values:
8 | 10 | 12 | 24
Default value:
24
IO_CLIENTLOGINBANNEROPTIONS
TYPE REF TO /AWS1/CL_EC2CLILOGINBANNEROPTS
/AWS1/CL_EC2CLILOGINBANNEROPTS
¶
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
IV_DISCNCTONSESSIONTIMEOUT
TYPE /AWS1/EC2BOOLEAN
/AWS1/EC2BOOLEAN
¶
Indicates whether the client VPN session is disconnected after the maximum timeout specified in
SessionTimeoutHours
is reached. Iftrue
, users are prompted to reconnect client VPN. Iffalse
, client VPN attempts to reconnect automatically. The default value isfalse
.
RETURNING¶
OO_OUTPUT
TYPE REF TO /AWS1/CL_EC2CRECLIVPNENDPTRSLT
/AWS1/CL_EC2CRECLIVPNENDPTRSLT
¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC