Class: Aws::EC2::Types::DescribeClientVpnConnectionsRequest

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 DescribeClientVpnConnectionsRequest data as a hash:

{
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "NextToken",
  max_results: 1,
  dry_run: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_vpn_endpoint_idString

The ID of the Client VPN endpoint.

Returns:

  • (String)


12204
12205
12206
12207
12208
12209
12210
12211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12204

class DescribeClientVpnConnectionsRequest < Struct.new(
  :client_vpn_endpoint_id,
  :filters,
  :next_token,
  :max_results,
  :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)


12204
12205
12206
12207
12208
12209
12210
12211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12204

class DescribeClientVpnConnectionsRequest < Struct.new(
  :client_vpn_endpoint_id,
  :filters,
  :next_token,
  :max_results,
  :dry_run)
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more filters. Filter names and values are case-sensitive.

  • connection-id - The ID of the connection.

  • username - For Active Directory client authentication, the user name of the client who established the client connection.

Returns:



12204
12205
12206
12207
12208
12209
12210
12211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12204

class DescribeClientVpnConnectionsRequest < Struct.new(
  :client_vpn_endpoint_id,
  :filters,
  :next_token,
  :max_results,
  :dry_run)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

Returns:

  • (Integer)


12204
12205
12206
12207
12208
12209
12210
12211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12204

class DescribeClientVpnConnectionsRequest < Struct.new(
  :client_vpn_endpoint_id,
  :filters,
  :next_token,
  :max_results,
  :dry_run)
  include Aws::Structure
end

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)


12204
12205
12206
12207
12208
12209
12210
12211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12204

class DescribeClientVpnConnectionsRequest < Struct.new(
  :client_vpn_endpoint_id,
  :filters,
  :next_token,
  :max_results,
  :dry_run)
  include Aws::Structure
end