class Aws::WAFV2::Types::ForwardedIPConfig

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.

<note markdown=“1”> If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

</note>

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

WAF only evaluates the first IP address found in the specified HTTP header.

@note When making an API call, you may pass ForwardedIPConfig

data as a hash:

    {
      header_name: "ForwardedIPHeaderName", # required
      fallback_behavior: "MATCH", # required, accepts MATCH, NO_MATCH
    }

@!attribute [rw] header_name

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`.

<note markdown="1"> If the specified header isn't present in the request, WAF doesn't
apply the rule to the web request at all.

 </note>
@return [String]

@!attribute [rw] fallback_behavior

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

<note markdown="1"> If the specified header isn't present in the request, WAF doesn't
apply the rule to the web request at all.

 </note>

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.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/ForwardedIPConfig AWS API Documentation

Constants

SENSITIVE