| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAFV2::IPSet; | ||
| 3 | use Moose; | ||
| 4 | has Addresses => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 5 | has ARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Description => (is => 'ro', isa => 'Str'); | ||
| 7 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has IPAddressVersion => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::WAFV2::IPSet | ||
| 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::WAFV2::IPSet object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Addresses => $value, ..., Name => $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::WAFV2::IPSet object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Addresses | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Contains one or more IP addresses or blocks of IP addresses specified | ||
| 42 | in Classless Inter-Domain Routing (CIDR) notation. WAF supports all | ||
| 43 | IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR | ||
| 44 | notation, see the Wikipedia entry Classless Inter-Domain Routing | ||
| 45 | (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). | ||
| 46 | |||
| 47 | WAF assigns an ARN to each C<IPSet> that you create. To use an IP set | ||
| 48 | in a rule, you provide the ARN to the Rule statement | ||
| 49 | IPSetReferenceStatement. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> Addresses => ArrayRef[Str|Undef] | ||
| 55 | |||
| 56 | Contains an array of strings that specify one or more IP addresses or | ||
| 57 | blocks of IP addresses in Classless Inter-Domain Routing (CIDR) | ||
| 58 | notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. | ||
| 59 | |||
| 60 | Examples: | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | To configure WAF to allow, block, or count requests that originated | ||
| 67 | from the IP address 192.0.2.44, specify C<192.0.2.44/32>. | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | To configure WAF to allow, block, or count requests that originated | ||
| 72 | from IP addresses from 192.0.2.0 to 192.0.2.255, specify | ||
| 73 | C<192.0.2.0/24>. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | To configure WAF to allow, block, or count requests that originated | ||
| 78 | from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify | ||
| 79 | C<1111:0000:0000:0000:0000:0000:0000:0111/128>. | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | To configure WAF to allow, block, or count requests that originated | ||
| 84 | from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to | ||
| 85 | 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify | ||
| 86 | C<1111:0000:0000:0000:0000:0000:0000:0000/64>. | ||
| 87 | |||
| 88 | =back | ||
| 89 | |||
| 90 | For more information about CIDR notation, see the Wikipedia entry | ||
| 91 | Classless Inter-Domain Routing | ||
| 92 | (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). | ||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> ARN => Str | ||
| 96 | |||
| 97 | The Amazon Resource Name (ARN) of the entity. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 Description => Str | ||
| 101 | |||
| 102 | A description of the IP set that helps with identification. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> Id => Str | ||
| 106 | |||
| 107 | A unique identifier for the set. This ID is returned in the responses | ||
| 108 | to create and list commands. You provide it to operations like update | ||
| 109 | and delete. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 B<REQUIRED> IPAddressVersion => Str | ||
| 113 | |||
| 114 | Specify IPV4 or IPV6. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 B<REQUIRED> Name => Str | ||
| 118 | |||
| 119 | The name of the IP set. You cannot change the name of an C<IPSet> after | ||
| 120 | you create it. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head1 SEE ALSO | ||
| 125 | |||
| 126 | This class forms part of L<Paws>, describing an object used in L<Paws::WAFV2> | ||
| 127 | |||
| 128 | =head1 BUGS and CONTRIBUTIONS | ||
| 129 | |||
| 130 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 131 | |||
| 132 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 133 | |||
| 134 | =cut | ||
| 135 |