| 1 | |||
| 2 | package Paws::WAFV2::GetIPSet; | ||
| 3 | use Moose; | ||
| 4 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Scope => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetIPSet'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAFV2::GetIPSetResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::WAFV2::GetIPSet - Arguments for method GetIPSet on L<Paws::WAFV2> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method GetIPSet on the | ||
| 24 | L<AWS WAFV2|Paws::WAFV2> service. Use the attributes of this class | ||
| 25 | as arguments to method GetIPSet. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetIPSet. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $wafv2 = Paws->service('WAFV2'); | ||
| 32 | my $GetIPSetResponse = $wafv2->GetIPSet( | ||
| 33 | Id => 'MyEntityId', | ||
| 34 | Name => 'MyEntityName', | ||
| 35 | Scope => 'CLOUDFRONT', | ||
| 36 | |||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $IPSet = $GetIPSetResponse->IPSet; | ||
| 41 | my $LockToken = $GetIPSetResponse->LockToken; | ||
| 42 | |||
| 43 | # Returns a L<Paws::WAFV2::GetIPSetResponse> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/wafv2/GetIPSet> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> Id => Str | ||
| 52 | |||
| 53 | A unique identifier for the set. This ID is returned in the responses | ||
| 54 | to create and list commands. You provide it to operations like update | ||
| 55 | and delete. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> Name => Str | ||
| 60 | |||
| 61 | The name of the IP set. You cannot change the name of an C<IPSet> after | ||
| 62 | you create it. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> Scope => Str | ||
| 67 | |||
| 68 | Specifies whether this is for an Amazon CloudFront distribution or for | ||
| 69 | a regional application. A regional application can be an Application | ||
| 70 | Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync | ||
| 71 | GraphQL API. | ||
| 72 | |||
| 73 | To work with CloudFront, you must also specify the Region US East (N. | ||
| 74 | Virginia) as follows: | ||
| 75 | |||
| 76 | =over | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | CLI - Specify the Region when you use the CloudFront scope: | ||
| 81 | C<--scope=CLOUDFRONT --region=us-east-1>. | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | API and SDKs - For all calls, use the Region endpoint us-east-1. | ||
| 86 | |||
| 87 | =back | ||
| 88 | |||
| 89 | |||
| 90 | Valid values are: C<"CLOUDFRONT">, C<"REGIONAL"> | ||
| 91 | |||
| 92 | |||
| 93 | =head1 SEE ALSO | ||
| 94 | |||
| 95 | This class forms part of L<Paws>, documenting arguments for method GetIPSet in L<Paws::WAFV2> | ||
| 96 | |||
| 97 | =head1 BUGS and CONTRIBUTIONS | ||
| 98 | |||
| 99 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 100 | |||
| 101 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 102 | |||
| 103 | =cut | ||
| 104 |