Terminate Client Vpn Connections

ec2_terminate_client_vpn_connections

R Documentation

Terminates active Client VPN endpoint connections

Description

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.

Usage

ec2_terminate_client_vpn_connections(ClientVpnEndpointId, ConnectionId,
  Username, DryRun)

Arguments

ClientVpnEndpointId

[required] The ID of the Client VPN endpoint to which the client is connected.

ConnectionId

The ID of the client connection to be terminated.

Username

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.

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.

Value

A list with the following syntax:

list(
  ClientVpnEndpointId = "string",
  Username = "string",
  ConnectionStatuses = list(
    list(
      ConnectionId = "string",
      PreviousStatus = list(
        Code = "active"|"failed-to-terminate"|"terminating"|"terminated",
        Message = "string"
      ),
      CurrentStatus = list(
        Code = "active"|"failed-to-terminate"|"terminating"|"terminated",
        Message = "string"
      )
    )
  )
)

Request syntax

svc$terminate_client_vpn_connections(
  ClientVpnEndpointId = "string",
  ConnectionId = "string",
  Username = "string",
  DryRun = TRUE|FALSE
)