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

Class: Aws::EC2::Types::DescribeClientVpnEndpointsRequest

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

{
  client_vpn_endpoint_ids: ["String"],
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_vpn_endpoint_idsArray<String>

The ID of the Client VPN endpoint.

Returns:

  • (Array<String>)


9881
9882
9883
9884
9885
9886
9887
9888
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9881

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


9881
9882
9883
9884
9885
9886
9887
9888
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9881

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

#filtersArray<Types::Filter>

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

Returns:



9881
9882
9883
9884
9885
9886
9887
9888
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9881

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


9881
9882
9883
9884
9885
9886
9887
9888
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9881

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

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)


9881
9882
9883
9884
9885
9886
9887
9888
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9881

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