« blib/lib/Paws/WAFV2/FirewallManagerStatement.pm
↑ Summary
blib/lib/Paws/WAFV2/GeoMatchStatement.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAFV2::ForwardedIPConfig; | ||
| 3 | use Moose; | ||
| 4 | has FallbackBehavior => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has HeaderName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::WAFV2::ForwardedIPConfig | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::WAFV2::ForwardedIPConfig object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { FallbackBehavior => $value, ..., HeaderName => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::WAFV2::ForwardedIPConfig object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->FallbackBehavior | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The configuration for inspecting IP addresses in an HTTP header that | ||
| 38 | you specify, instead of using the IP address that's reported by the web | ||
| 39 | request origin. Commonly, this is the X-Forwarded-For (XFF) header, but | ||
| 40 | you can specify any header name. | ||
| 41 | |||
| 42 | If the specified header isn't present in the request, WAF doesn't apply | ||
| 43 | the rule to the web request at all. | ||
| 44 | |||
| 45 | This configuration is used for GeoMatchStatement and | ||
| 46 | RateBasedStatement. For IPSetReferenceStatement, use | ||
| 47 | IPSetForwardedIPConfig instead. | ||
| 48 | |||
| 49 | WAF only evaluates the first IP address found in the specified HTTP | ||
| 50 | header. | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> FallbackBehavior => Str | ||
| 56 | |||
| 57 | The match status to assign to the web request if the request doesn't | ||
| 58 | have a valid IP address in the specified position. | ||
| 59 | |||
| 60 | If the specified header isn't present in the request, WAF doesn't apply | ||
| 61 | the rule to the web request at all. | ||
| 62 | |||
| 63 | You can specify the following fallback behaviors: | ||
| 64 | |||
| 65 | =over | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | C<MATCH> - Treat the web request as matching the rule statement. WAF | ||
| 70 | applies the rule action to the request. | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<NO_MATCH> - Treat the web request as not matching the rule statement. | ||
| 75 | |||
| 76 | =back | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> HeaderName => Str | ||
| 81 | |||
| 82 | The name of the HTTP header to use for the IP address. For example, to | ||
| 83 | use the X-Forwarded-For (XFF) header, set this to C<X-Forwarded-For>. | ||
| 84 | |||
| 85 | If the specified header isn't present in the request, WAF doesn't apply | ||
| 86 | the rule to the web request at all. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, describing an object used in L<Paws::WAFV2> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |