Class: Aws::WAFV2::Types::IPSetForwardedIPConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

Note:

When making an API call, you may pass IPSetForwardedIPConfig data as a hash:

{
  header_name: "ForwardedIPHeaderName", # required
  fallback_behavior: "MATCH", # required, accepts MATCH, NO_MATCH
  position: "FIRST", # required, accepts FIRST, LAST, ANY
}

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#fallback_behaviorString

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

You can specify the following fallback behaviors:

  • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

  • NO_MATCH - Treat the web request as not matching the rule statement.

Returns:

  • (String)


4518
4519
4520
4521
4522
4523
4524
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4518

class IPSetForwardedIPConfig < Struct.new(
  :header_name,
  :fallback_behavior,
  :position)
  SENSITIVE = []
  include Aws::Structure
end

#header_nameString

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

Returns:

  • (String)


4518
4519
4520
4521
4522
4523
4524
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4518

class IPSetForwardedIPConfig < Struct.new(
  :header_name,
  :fallback_behavior,
  :position)
  SENSITIVE = []
  include Aws::Structure
end

#positionString

The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

The options for this setting are the following:

  • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

  • LAST - Inspect the last IP address in the list of IP addresses in the header.

  • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last

Returns:

  • (String)


4518
4519
4520
4521
4522
4523
4524
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4518

class IPSetForwardedIPConfig < Struct.new(
  :header_name,
  :fallback_behavior,
  :position)
  SENSITIVE = []
  include Aws::Structure
end