You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::TerminateClientVpnConnectionsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing TerminateClientVpnConnectionsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  connection_id: "VpnConnectionId",
  username: "String",
  dry_run: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_vpn_endpoint_id ⇒ String

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

Returns:

  • (String) —

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

#connection_id ⇒ String

The ID of the client connection to be terminated.

Returns:

  • (String) —

    The ID of the client connection to be terminated.

#dry_run ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#username ⇒ String

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.

Returns:

  • (String) —

    The name of the user who initiated the connection.