/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::WAFV2::ForwardedIPConfig

NAME

Paws::WAFV2::ForwardedIPConfig

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::WAFV2::ForwardedIPConfig object:

$service_obj->Method(Att1 => { FallbackBehavior => $value, ..., HeaderName => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::WAFV2::ForwardedIPConfig object:

$result = $service_obj->Method(...);
$result->Att1->FallbackBehavior

DESCRIPTION

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 for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

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

ATTRIBUTES

REQUIRED FallbackBehavior => Str

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.

REQUIRED HeaderName => Str

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.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::WAFV2

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues