| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAF::RuleGroup; | ||
| 3 | use Moose; | ||
| 4 | has MetricName => (is => 'ro', isa => 'Str'); | ||
| 5 | has Name => (is => 'ro', isa => 'Str'); | ||
| 6 | has RuleGroupId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::WAF::RuleGroup | ||
| 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::RuleGroup object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { MetricName => $value, ..., RuleGroupId => $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::RuleGroup object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->MetricName | ||
| 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 | A collection of predefined rules that you can add to a web ACL. | ||
| 50 | |||
| 51 | Rule groups are subject to the following limits: | ||
| 52 | |||
| 53 | =over | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | Three rule groups per account. You can request an increase to this | ||
| 58 | limit by contacting customer support. | ||
| 59 | |||
| 60 | =item * | ||
| 61 | |||
| 62 | One rule group per web ACL. | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | Ten rules per rule group. | ||
| 67 | |||
| 68 | =back | ||
| 69 | |||
| 70 | |||
| 71 | =head1 ATTRIBUTES | ||
| 72 | |||
| 73 | |||
| 74 | =head2 MetricName => Str | ||
| 75 | |||
| 76 | A friendly name or description for the metrics for this C<RuleGroup>. | ||
| 77 | The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with | ||
| 78 | maximum length 128 and minimum length one. It can't contain whitespace | ||
| 79 | or metric names reserved for AWS WAF, including "All" and | ||
| 80 | "Default_Action." You can't change the name of the metric after you | ||
| 81 | create the C<RuleGroup>. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 Name => Str | ||
| 85 | |||
| 86 | The friendly name or description for the C<RuleGroup>. You can't change | ||
| 87 | the name of a C<RuleGroup> after you create it. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> RuleGroupId => Str | ||
| 91 | |||
| 92 | A unique identifier for a C<RuleGroup>. You use C<RuleGroupId> to get | ||
| 93 | more information about a C<RuleGroup> (see GetRuleGroup), update a | ||
| 94 | C<RuleGroup> (see UpdateRuleGroup), insert a C<RuleGroup> into a | ||
| 95 | C<WebACL> or delete a one from a C<WebACL> (see UpdateWebACL), or | ||
| 96 | delete a C<RuleGroup> from AWS WAF (see DeleteRuleGroup). | ||
| 97 | |||
| 98 | C<RuleGroupId> is returned by CreateRuleGroup and by ListRuleGroups. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head1 SEE ALSO | ||
| 103 | |||
| 104 | This class forms part of L<Paws>, describing an object used in L<Paws::WAF> | ||
| 105 | |||
| 106 | =head1 BUGS and CONTRIBUTIONS | ||
| 107 | |||
| 108 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 109 | |||
| 110 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 111 | |||
| 112 | =cut | ||
| 113 |