| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAFV2::IPSetReferenceStatement; | ||
| 3 | use Moose; | ||
| 4 | has ARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has IPSetForwardedIPConfig => (is => 'ro', isa => 'Paws::WAFV2::IPSetForwardedIPConfig'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::WAFV2::IPSetReferenceStatement | ||
| 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::IPSetReferenceStatement object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { ARN => $value, ..., IPSetForwardedIPConfig => $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::IPSetReferenceStatement object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->ARN | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | A rule statement used to detect web requests coming from particular IP | ||
| 38 | addresses or address ranges. To use this, create an IPSet that | ||
| 39 | specifies the addresses you want to detect, then use the ARN of that | ||
| 40 | set in this statement. To create an IP set, see CreateIPSet. | ||
| 41 | |||
| 42 | Each IP set rule statement references an IP set. You create and | ||
| 43 | maintain the set independent of your rules. This allows you to use the | ||
| 44 | single set in multiple rules. When you update the referenced set, WAF | ||
| 45 | automatically updates all rules that reference it. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> ARN => Str | ||
| 51 | |||
| 52 | The Amazon Resource Name (ARN) of the IPSet that this statement | ||
| 53 | references. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 IPSetForwardedIPConfig => L<Paws::WAFV2::IPSetForwardedIPConfig> | ||
| 57 | |||
| 58 | The configuration for inspecting IP addresses in an HTTP header that | ||
| 59 | you specify, instead of using the IP address that's reported by the web | ||
| 60 | request origin. Commonly, this is the X-Forwarded-For (XFF) header, but | ||
| 61 | you can specify any header name. | ||
| 62 | |||
| 63 | If the specified header isn't present in the request, WAF doesn't apply | ||
| 64 | the rule to the web request at all. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head1 SEE ALSO | ||
| 69 | |||
| 70 | This class forms part of L<Paws>, describing an object used in L<Paws::WAFV2> | ||
| 71 | |||
| 72 | =head1 BUGS and CONTRIBUTIONS | ||
| 73 | |||
| 74 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 75 | |||
| 76 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 77 | |||
| 78 | =cut | ||
| 79 |