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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass TerminateClientVpnConnectionsRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#client_vpn_endpoint_idString

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

Returns:

  • (String)


37767
37768
37769
37770
37771
37772
37773
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37767

class TerminateClientVpnConnectionsRequest < Struct.new(
  :client_vpn_endpoint_id,
  :connection_id,
  :username,
  :dry_run)
  include Aws::Structure
end

#connection_idString

The ID of the client connection to be terminated.

Returns:

  • (String)


37767
37768
37769
37770
37771
37772
37773
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37767

class TerminateClientVpnConnectionsRequest < Struct.new(
  :client_vpn_endpoint_id,
  :connection_id,
  :username,
  :dry_run)
  include Aws::Structure
end

#dry_runBoolean

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)


37767
37768
37769
37770
37771
37772
37773
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37767

class TerminateClientVpnConnectionsRequest < Struct.new(
  :client_vpn_endpoint_id,
  :connection_id,
  :username,
  :dry_run)
  include Aws::Structure
end

#usernameString

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)


37767
37768
37769
37770
37771
37772
37773
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37767

class TerminateClientVpnConnectionsRequest < Struct.new(
  :client_vpn_endpoint_id,
  :connection_id,
  :username,
  :dry_run)
  include Aws::Structure
end