| 1 | |||
| 2 | package Paws::WAFV2::CreateIPSet; | ||
| 3 | use Moose; | ||
| 4 | has Addresses => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has IPAddressVersion => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Scope => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::WAFV2::Tag]'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateIPSet'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAFV2::CreateIPSetResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::WAFV2::CreateIPSet - Arguments for method CreateIPSet on L<Paws::WAFV2> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateIPSet on the | ||
| 27 | L<AWS WAFV2|Paws::WAFV2> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateIPSet. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateIPSet. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $wafv2 = Paws->service('WAFV2'); | ||
| 35 | my $CreateIPSetResponse = $wafv2->CreateIPSet( | ||
| 36 | Addresses => [ | ||
| 37 | 'MyIPAddress', ... # min: 1, max: 50 | ||
| 38 | ], | ||
| 39 | IPAddressVersion => 'IPV4', | ||
| 40 | Name => 'MyEntityName', | ||
| 41 | Scope => 'CLOUDFRONT', | ||
| 42 | Description => 'MyEntityDescription', # OPTIONAL | ||
| 43 | Tags => [ | ||
| 44 | { | ||
| 45 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 46 | Value => 'MyTagValue', # max: 256 | ||
| 47 | |||
| 48 | }, | ||
| 49 | ... | ||
| 50 | ], # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $Summary = $CreateIPSetResponse->Summary; | ||
| 55 | |||
| 56 | # Returns a L<Paws::WAFV2::CreateIPSetResponse> object. | ||
| 57 | |||
| 58 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/wafv2/CreateIPSet> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> Addresses => ArrayRef[Str|Undef] | ||
| 65 | |||
| 66 | Contains an array of strings that specify one or more IP addresses or | ||
| 67 | blocks of IP addresses in Classless Inter-Domain Routing (CIDR) | ||
| 68 | notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. | ||
| 69 | |||
| 70 | Examples: | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | To configure WAF to allow, block, or count requests that originated | ||
| 77 | from the IP address 192.0.2.44, specify C<192.0.2.44/32>. | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | To configure WAF to allow, block, or count requests that originated | ||
| 82 | from IP addresses from 192.0.2.0 to 192.0.2.255, specify | ||
| 83 | C<192.0.2.0/24>. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | To configure WAF to allow, block, or count requests that originated | ||
| 88 | from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify | ||
| 89 | C<1111:0000:0000:0000:0000:0000:0000:0111/128>. | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | To configure WAF to allow, block, or count requests that originated | ||
| 94 | from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to | ||
| 95 | 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify | ||
| 96 | C<1111:0000:0000:0000:0000:0000:0000:0000/64>. | ||
| 97 | |||
| 98 | =back | ||
| 99 | |||
| 100 | For more information about CIDR notation, see the Wikipedia entry | ||
| 101 | Classless Inter-Domain Routing | ||
| 102 | (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 Description => Str | ||
| 107 | |||
| 108 | A description of the IP set that helps with identification. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 B<REQUIRED> IPAddressVersion => Str | ||
| 113 | |||
| 114 | Specify IPV4 or IPV6. | ||
| 115 | |||
| 116 | Valid values are: C<"IPV4">, C<"IPV6"> | ||
| 117 | |||
| 118 | =head2 B<REQUIRED> Name => Str | ||
| 119 | |||
| 120 | The name of the IP set. You cannot change the name of an C<IPSet> after | ||
| 121 | you create it. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 B<REQUIRED> Scope => Str | ||
| 126 | |||
| 127 | Specifies whether this is for an Amazon CloudFront distribution or for | ||
| 128 | a regional application. A regional application can be an Application | ||
| 129 | Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync | ||
| 130 | GraphQL API. | ||
| 131 | |||
| 132 | To work with CloudFront, you must also specify the Region US East (N. | ||
| 133 | Virginia) as follows: | ||
| 134 | |||
| 135 | =over | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | CLI - Specify the Region when you use the CloudFront scope: | ||
| 140 | C<--scope=CLOUDFRONT --region=us-east-1>. | ||
| 141 | |||
| 142 | =item * | ||
| 143 | |||
| 144 | API and SDKs - For all calls, use the Region endpoint us-east-1. | ||
| 145 | |||
| 146 | =back | ||
| 147 | |||
| 148 | |||
| 149 | Valid values are: C<"CLOUDFRONT">, C<"REGIONAL"> | ||
| 150 | |||
| 151 | =head2 Tags => ArrayRef[L<Paws::WAFV2::Tag>] | ||
| 152 | |||
| 153 | An array of key:value pairs to associate with the resource. | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head1 SEE ALSO | ||
| 159 | |||
| 160 | This class forms part of L<Paws>, documenting arguments for method CreateIPSet in L<Paws::WAFV2> | ||
| 161 | |||
| 162 | =head1 BUGS and CONTRIBUTIONS | ||
| 163 | |||
| 164 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 165 | |||
| 166 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 167 | |||
| 168 | =cut | ||
| 169 |