GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::WAFV2::IPSetForwardedIPConfig(3) User Contributed Perl Documentation Paws::WAFV2::IPSetForwardedIPConfig(3)

Paws::WAFV2::IPSetForwardedIPConfig

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::IPSetForwardedIPConfig object:

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

Results returned from an API call

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

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

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.

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.

REQUIRED Position => Str

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

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

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>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.