| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAFV2::LabelMatchStatement; | ||
| 3 | use Moose; | ||
| 4 | has Key => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Scope => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::WAFV2::LabelMatchStatement | ||
| 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::LabelMatchStatement object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Key => $value, ..., Scope => $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::LabelMatchStatement object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Key | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | A rule statement that defines a string match search against labels that | ||
| 38 | have been added to the web request by rules that have already run in | ||
| 39 | the web ACL. | ||
| 40 | |||
| 41 | The label match statement provides the label or namespace string to | ||
| 42 | search for. The label string can represent a part or all of the fully | ||
| 43 | qualified label name that had been added to the web request. Fully | ||
| 44 | qualified labels have a prefix, optional namespaces, and label name. | ||
| 45 | The prefix identifies the rule group or web ACL context of the rule | ||
| 46 | that added the label. If you do not provide the fully qualified name in | ||
| 47 | your label match string, WAF performs the search for labels that were | ||
| 48 | added in the same context as the label match statement. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> Key => Str | ||
| 54 | |||
| 55 | The string to match against. The setting you provide for this depends | ||
| 56 | on the match statement's C<Scope> setting: | ||
| 57 | |||
| 58 | =over | ||
| 59 | |||
| 60 | =item * | ||
| 61 | |||
| 62 | If the C<Scope> indicates C<LABEL>, then this specification must | ||
| 63 | include the name and can include any number of preceding namespace | ||
| 64 | specifications and prefix up to providing the fully qualified label | ||
| 65 | name. | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | If the C<Scope> indicates C<NAMESPACE>, then this specification can | ||
| 70 | include any number of contiguous namespace strings, and can include the | ||
| 71 | entire label namespace prefix from the rule group or web ACL where the | ||
| 72 | label originates. | ||
| 73 | |||
| 74 | =back | ||
| 75 | |||
| 76 | Labels are case sensitive and components of a label must be separated | ||
| 77 | by colon, for example C<NS1:NS2:name>. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> Scope => Str | ||
| 81 | |||
| 82 | Specify whether you want to match using the label name or just the | ||
| 83 | namespace. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head1 SEE ALSO | ||
| 88 | |||
| 89 | This class forms part of L<Paws>, describing an object used in L<Paws::WAFV2> | ||
| 90 | |||
| 91 | =head1 BUGS and CONTRIBUTIONS | ||
| 92 | |||
| 93 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 94 | |||
| 95 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 96 | |||
| 97 | =cut | ||
| 98 |