| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAF::RegexMatchSet; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str'); | ||
| 5 | has RegexMatchSetId => (is => 'ro', isa => 'Str'); | ||
| 6 | has RegexMatchTuples => (is => 'ro', isa => 'ArrayRef[Paws::WAF::RegexMatchTuple]'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::WAF::RegexMatchSet | ||
| 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::WAF::RegexMatchSet object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Name => $value, ..., RegexMatchTuples => $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::WAF::RegexMatchSet object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Name | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | This is B<AWS WAF Classic> documentation. For more information, see AWS | ||
| 39 | WAF Classic | ||
| 40 | (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) | ||
| 41 | in the developer guide. | ||
| 42 | |||
| 43 | B<For the latest version of AWS WAF>, use the AWS WAFV2 API and see the | ||
| 44 | AWS WAF Developer Guide | ||
| 45 | (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). | ||
| 46 | With the latest version, AWS WAF has a single set of endpoints for | ||
| 47 | regional and global use. | ||
| 48 | |||
| 49 | In a GetRegexMatchSet request, C<RegexMatchSet> is a complex type that | ||
| 50 | contains the C<RegexMatchSetId> and C<Name> of a C<RegexMatchSet>, and | ||
| 51 | the values that you specified when you updated the C<RegexMatchSet>. | ||
| 52 | |||
| 53 | The values are contained in a C<RegexMatchTuple> object, which specify | ||
| 54 | the parts of web requests that you want AWS WAF to inspect and the | ||
| 55 | values that you want AWS WAF to search for. If a C<RegexMatchSet> | ||
| 56 | contains more than one C<RegexMatchTuple> object, a request needs to | ||
| 57 | match the settings in only one C<ByteMatchTuple> to be considered a | ||
| 58 | match. | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 Name => Str | ||
| 64 | |||
| 65 | A friendly name or description of the RegexMatchSet. You can't change | ||
| 66 | C<Name> after you create a C<RegexMatchSet>. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 RegexMatchSetId => Str | ||
| 70 | |||
| 71 | The C<RegexMatchSetId> for a C<RegexMatchSet>. You use | ||
| 72 | C<RegexMatchSetId> to get information about a C<RegexMatchSet> (see | ||
| 73 | GetRegexMatchSet), update a C<RegexMatchSet> (see UpdateRegexMatchSet), | ||
| 74 | insert a C<RegexMatchSet> into a C<Rule> or delete one from a C<Rule> | ||
| 75 | (see UpdateRule), and delete a C<RegexMatchSet> from AWS WAF (see | ||
| 76 | DeleteRegexMatchSet). | ||
| 77 | |||
| 78 | C<RegexMatchSetId> is returned by CreateRegexMatchSet and by | ||
| 79 | ListRegexMatchSets. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 RegexMatchTuples => ArrayRef[L<Paws::WAF::RegexMatchTuple>] | ||
| 83 | |||
| 84 | Contains an array of RegexMatchTuple objects. Each C<RegexMatchTuple> | ||
| 85 | object contains: | ||
| 86 | |||
| 87 | =over | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | The part of a web request that you want AWS WAF to inspect, such as a | ||
| 92 | query string or the value of the C<User-Agent> header. | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | The identifier of the pattern (a regular expression) that you want AWS | ||
| 97 | WAF to look for. For more information, see RegexPatternSet. | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | Whether to perform any conversions on the request, such as converting | ||
| 102 | it to lowercase, before inspecting it for the specified string. | ||
| 103 | |||
| 104 | =back | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head1 SEE ALSO | ||
| 110 | |||
| 111 | This class forms part of L<Paws>, describing an object used in L<Paws::WAF> | ||
| 112 | |||
| 113 | =head1 BUGS and CONTRIBUTIONS | ||
| 114 | |||
| 115 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 116 | |||
| 117 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 118 | |||
| 119 | =cut | ||
| 120 |