Class: Aws::EC2::Types::DescribeClientVpnAuthorizationRulesRequest

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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_vpn_endpoint_idString

The ID of the Client VPN endpoint.

Returns:

  • (String)


12838
12839
12840
12841
12842
12843
12844
12845
12846
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12838

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


12838
12839
12840
12841
12842
12843
12844
12845
12846
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12838

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

#filtersArray<Types::Filter>

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

  • description - The description of the authorization rule.

  • destination-cidr - The CIDR of the network to which the authorization rule applies.

  • group-id - The ID of the Active Directory group to which the authorization rule grants access.

Returns:



12838
12839
12840
12841
12842
12843
12844
12845
12846
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12838

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


12838
12839
12840
12841
12842
12843
12844
12845
12846
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12838

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

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)


12838
12839
12840
12841
12842
12843
12844
12845
12846
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12838

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