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: "ClientVpnEndpointId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  dry_run: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_vpn_endpoint_idString

The ID of the Client VPN endpoint.

Returns:

  • (String)


15936
15937
15938
15939
15940
15941
15942
15943
15944
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15936

class DescribeClientVpnRoutesRequest < Struct.new(
  :client_vpn_endpoint_id,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  SENSITIVE = []
  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)


15936
15937
15938
15939
15940
15941
15942
15943
15944
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15936

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

#filtersArray<Types::Filter>

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

  • destination-cidr - The CIDR of the route destination.

  • origin - How the route was associated with the Client VPN endpoint (associate | add-route).

  • target-subnet - The ID of the subnet through which traffic is routed.

Returns:



15936
15937
15938
15939
15940
15941
15942
15943
15944
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15936

class DescribeClientVpnRoutesRequest < Struct.new(
  :client_vpn_endpoint_id,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  SENSITIVE = []
  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)


15936
15937
15938
15939
15940
15941
15942
15943
15944
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15936

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

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)


15936
15937
15938
15939
15940
15941
15942
15943
15944
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15936

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