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