| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAFV2::IPSetSummary; | ||
| 3 | use Moose; | ||
| 4 | has ARN => (is => 'ro', isa => 'Str'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has Id => (is => 'ro', isa => 'Str'); | ||
| 7 | has LockToken => (is => 'ro', isa => 'Str'); | ||
| 8 | has Name => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::WAFV2::IPSetSummary | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::WAFV2::IPSetSummary object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { ARN => $value, ..., Name => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::WAFV2::IPSetSummary object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->ARN | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | High-level information about an IPSet, returned by operations like | ||
| 41 | create and list. This provides information like the ID, that you can | ||
| 42 | use to retrieve and manage an C<IPSet>, and the ARN, that you provide | ||
| 43 | to the IPSetReferenceStatement to use the address set in a Rule. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 ARN => Str | ||
| 49 | |||
| 50 | The Amazon Resource Name (ARN) of the entity. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Description => Str | ||
| 54 | |||
| 55 | A description of the IP set that helps with identification. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Id => Str | ||
| 59 | |||
| 60 | A unique identifier for the set. This ID is returned in the responses | ||
| 61 | to create and list commands. You provide it to operations like update | ||
| 62 | and delete. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 LockToken => Str | ||
| 66 | |||
| 67 | A token used for optimistic locking. WAF returns a token to your get | ||
| 68 | and list requests, to mark the state of the entity at the time of the | ||
| 69 | request. To make changes to the entity associated with the token, you | ||
| 70 | provide the token to operations like update and delete. WAF uses the | ||
| 71 | token to ensure that no changes have been made to the entity since you | ||
| 72 | last retrieved it. If a change has been made, the update fails with a | ||
| 73 | C<WAFOptimisticLockException>. If this happens, perform another get, | ||
| 74 | and use the new token returned by that operation. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 Name => Str | ||
| 78 | |||
| 79 | The name of the IP set. You cannot change the name of an C<IPSet> after | ||
| 80 | you create it. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, describing an object used in L<Paws::WAFV2> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |