| ec2_create_client_vpn_endpoint {aws.ecx} | R Documentation |
Create Client Vpn Endpoint
Description
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.
Usage
ec2_create_client_vpn_endpoint(
ClientCidrBlock,
ServerCertificateArn,
Authentication,
ConnectionLogOptions,
DnsServers = NULL,
TransportProtocol = NULL,
VpnPort = NULL,
Description = NULL,
SplitTunnel = NULL,
DryRun = NULL,
ClientToken = NULL,
TagSpecification = NULL,
SecurityGroupId = NULL,
VpcId = NULL,
SelfServicePortal = NULL,
ClientConnectOptions = NULL,
simplify = TRUE,
others = list(),
print_on_error = aws_get_print_on_error(),
retry_time = aws_get_retry_time(),
network_timeout = aws_get_network_timeout(),
region = aws_get_region()
)
Arguments
ClientCidrBlock |
Character. The IPv4 address range, in CIDR notation, from which to assign client IP addresses. |
ServerCertificateArn |
Character. The ARN of the server certificate. |
Authentication |
List. Information about the authentication method to be used to authenticate clients. |
ConnectionLogOptions |
Object. Information about the client connection logging options. |
DnsServers |
List. Information about the DNS servers to be used for DNS resolution.[optional] |
TransportProtocol |
Character. The transport protocol to be used by the VPN session. Default value: |
VpnPort |
Integer. The port number to assign to the Client VPN endpoint for TCP and UDP traffic.[optional] |
Description |
Character. A brief description of the Client VPN endpoint.[optional] |
SplitTunnel |
Logical. Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.[optional] |
DryRun |
Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional] |
ClientToken |
Character. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.[optional] |
TagSpecification |
List. The tags to apply to the Client VPN endpoint during creation.[optional] |
SecurityGroupId |
List. The IDs of one or more security groups to apply to the target network.[optional] |
VpcId |
Character. The ID of the VPC to associate with the Client VPN endpoint.[optional] |
SelfServicePortal |
Character. Specify whether to enable the self-service portal for the Client VPN endpoint.[optional] |
ClientConnectOptions |
Object. The options for managing connection authorization for new client connections.[optional] |
simplify |
Logical. Whether to simplify the result and handle |
others |
Named list. The parameters that are not included in the function parameters and need to be added into the request[optional] |
print_on_error |
Logical. Whether to show an error message when a network error occurs. |
retry_time |
Integer. Number of retries for a REST request when encounter the
network issue. If the request has been sent |
network_timeout |
Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms. |
region |
Character. The region of the AWS service. |
Value
A list object or a character vector
ClientCidrBlock
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. The CIDR block should be /22 or greater.
ServerCertificateArn
The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide.
Authentication
Information about the authentication method to be used to authenticate clients.
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
DnsServers
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.
TransportProtocol
The transport protocol to be used by the VPN session.
Default value: udp
VpnPort
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 \| 1194
Default Value: 443
Description
A brief description of the Client VPN endpoint.
SplitTunnel
Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide.
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.
ClientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
TagSpecification
The tags to apply to the Client VPN endpoint during creation.
SecurityGroupId
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.
VpcId
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.
SelfServicePortal
Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
ClientConnectOptions
The options for managing connection authorization for new client connections.