ec2_modify_client_vpn_endpoint {aws.ecx}

Modify Client Vpn Endpoint

Description

Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.

Usage

ec2_modify_client_vpn_endpoint(
  ClientVpnEndpointId,
  ServerCertificateArn = NULL,
  ConnectionLogOptions = NULL,
  DnsServers = NULL,
  VpnPort = NULL,
  Description = NULL,
  SplitTunnel = NULL,
  DryRun = 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

ClientVpnEndpointId

Character. The ID of the Client VPN endpoint to modify.

ServerCertificateArn

Character. The ARN of the server certificate to be used.[optional]

ConnectionLogOptions

Object. Information about the client connection logging options.[optional]

DnsServers

Object. Information about the DNS servers to be used by Client VPN connections.[optional]

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 the VPN is split-tunnel.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[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 nextToken in the response[optional]

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 retry_time times but still not be able to get the response, an error will be thrown.

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

ClientVpnEndpointId

The ID of the Client VPN endpoint to modify.

ServerCertificateArn

The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).

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 by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.

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 the VPN is split-tunnel.

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.

SecurityGroupId

The IDs of one or more security groups to apply to the target network.

VpcId

The ID of the VPC to associate with the Client VPN endpoint.

SelfServicePortal

Specify whether to enable the self-service portal for the Client VPN endpoint.

ClientConnectOptions

The options for managing connection authorization for new client connections.