ec2_create_client_vpn_endpoint: Creates a 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,
  AuthenticationOptions, ConnectionLogOptions, DnsServers,
  TransportProtocol, Description, DryRun, ClientToken, TagSpecifications)

Arguments

ClientCidrBlock

[required] 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

[required] The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide.

AuthenticationOptions

[required] Information about the authentication method to be used to authenticate clients.

ConnectionLogOptions

[required] 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 of the VPC that is to be associated with Client VPN endpoint is used as the DNS server.

TransportProtocol

The transport protocol to be used by the VPN session.

Default value: udp

Description

A brief description of the Client VPN endpoint.

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 you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

TagSpecifications

The tags to apply to the Client VPN endpoint during creation.

Request syntax

svc$create_client_vpn_endpoint(
  ClientCidrBlock = "string",
  ServerCertificateArn = "string",
  AuthenticationOptions = list(
    list(
      Type = "certificate-authentication"|"directory-service-authentication",
      ActiveDirectory = list(
        DirectoryId = "string"
      ),
      MutualAuthentication = list(
        ClientRootCertificateChainArn = "string"
      )
    )
  ),
  ConnectionLogOptions = list(
    Enabled = TRUE|FALSE,
    CloudwatchLogGroup = "string",
    CloudwatchLogStream = "string"
  ),
  DnsServers = list(
    "string"
  ),
  TransportProtocol = "tcp"|"udp",
  Description = "string",
  DryRun = TRUE|FALSE,
  ClientToken = "string",
  TagSpecifications = list(
    list(
      ResourceType = "client-vpn-endpoint"|"customer-gateway"|"dedicated-host"|"dhcp-options"|"elastic-ip"|"fleet"|"fpga-image"|"host-reservation"|"image"|"instance"|"internet-gateway"|"launch-template"|"natgateway"|"network-acl"|"network-interface"|"reserved-instances"|"route-table"|"security-group"|"snapshot"|"spot-instances-request"|"subnet"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-route-table"|"volume"|"vpc"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  )
)