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

Class: Aws::EC2::Types::DescribeClientVpnRoutesRequest

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

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_vpn_endpoint_id ⇒ String

The ID of the Client VPN endpoint.

Returns:

  • (String) 


10716
10717
10718
10719
10720
10721
10722
10723
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10716

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

#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) 


10716
10717
10718
10719
10720
10721
10722
10723
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10716

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

#filters ⇒ Array<Types::Filter>

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

Returns:



10716
10717
10718
10719
10720
10721
10722
10723
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10716

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

#max_results ⇒ Integer

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) 


10716
10717
10718
10719
10720
10721
10722
10723
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10716

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

#next_token ⇒ String

The token to retrieve the next page of results.

Returns:

  • (String) 


10716
10717
10718
10719
10720
10721
10722
10723
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10716

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