| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAF::WebACL; | ||
| 3 | use Moose; | ||
| 4 | has DefaultAction => (is => 'ro', isa => 'Paws::WAF::WafAction', required => 1); | ||
| 5 | has MetricName => (is => 'ro', isa => 'Str'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str'); | ||
| 7 | has Rules => (is => 'ro', isa => 'ArrayRef[Paws::WAF::ActivatedRule]', required => 1); | ||
| 8 | has WebACLArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has WebACLId => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::WAF::WebACL | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::WAF::WebACL object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { DefaultAction => $value, ..., WebACLId => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::WAF::WebACL object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->DefaultAction | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | This is B<AWS WAF Classic> documentation. For more information, see AWS | ||
| 42 | WAF Classic | ||
| 43 | (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) | ||
| 44 | in the developer guide. | ||
| 45 | |||
| 46 | B<For the latest version of AWS WAF>, use the AWS WAFV2 API and see the | ||
| 47 | AWS WAF Developer Guide | ||
| 48 | (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). | ||
| 49 | With the latest version, AWS WAF has a single set of endpoints for | ||
| 50 | regional and global use. | ||
| 51 | |||
| 52 | Contains the C<Rules> that identify the requests that you want to | ||
| 53 | allow, block, or count. In a C<WebACL>, you also specify a default | ||
| 54 | action (C<ALLOW> or C<BLOCK>), and the action for each C<Rule> that you | ||
| 55 | add to a C<WebACL>, for example, block requests from specified IP | ||
| 56 | addresses or block requests from specified referrers. You also | ||
| 57 | associate the C<WebACL> with a CloudFront distribution to identify the | ||
| 58 | requests that you want AWS WAF to filter. If you add more than one | ||
| 59 | C<Rule> to a C<WebACL>, a request needs to match only one of the | ||
| 60 | specifications to be allowed, blocked, or counted. For more | ||
| 61 | information, see UpdateWebACL. | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> DefaultAction => L<Paws::WAF::WafAction> | ||
| 67 | |||
| 68 | The action to perform if none of the C<Rules> contained in the | ||
| 69 | C<WebACL> match. The action is specified by the WafAction object. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 MetricName => Str | ||
| 73 | |||
| 74 | A friendly name or description for the metrics for this C<WebACL>. The | ||
| 75 | name can contain only alphanumeric characters (A-Z, a-z, 0-9), with | ||
| 76 | maximum length 128 and minimum length one. It can't contain whitespace | ||
| 77 | or metric names reserved for AWS WAF, including "All" and | ||
| 78 | "Default_Action." You can't change C<MetricName> after you create the | ||
| 79 | C<WebACL>. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 Name => Str | ||
| 83 | |||
| 84 | A friendly name or description of the C<WebACL>. You can't change the | ||
| 85 | name of a C<WebACL> after you create it. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> Rules => ArrayRef[L<Paws::WAF::ActivatedRule>] | ||
| 89 | |||
| 90 | An array that contains the action for each C<Rule> in a C<WebACL>, the | ||
| 91 | priority of the C<Rule>, and the ID of the C<Rule>. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 WebACLArn => Str | ||
| 95 | |||
| 96 | Tha Amazon Resource Name (ARN) of the web ACL. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> WebACLId => Str | ||
| 100 | |||
| 101 | A unique identifier for a C<WebACL>. You use C<WebACLId> to get | ||
| 102 | information about a C<WebACL> (see GetWebACL), update a C<WebACL> (see | ||
| 103 | UpdateWebACL), and delete a C<WebACL> from AWS WAF (see DeleteWebACL). | ||
| 104 | |||
| 105 | C<WebACLId> is returned by CreateWebACL and by ListWebACLs. | ||
| 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 |