Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.
ec2_terminate_client_vpn_connections(
ClientVpnEndpointId,
ConnectionId = NULL,
Username = NULL,
DryRun = 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()
)Character. The ID of the Client VPN endpoint to which the client is connected.
Character. The ID of the client connection to be terminated.[optional]
Character. The name of the user who initiated the connection.[optional]
Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]
Logical. Whether to simplify the result and handle nextToken
in the response[optional]
Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]
Logical. Whether to show an error message when a network error occurs.
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.
Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.
Character. The region of the AWS service.
A list object or a character vector
The ID of the Client VPN endpoint to which the client is connected.
The ID of the client connection to be terminated.
The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.
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.