| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAFV2::RuleGroupSummary; | ||
| 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::RuleGroupSummary | ||
| 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::RuleGroupSummary 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::RuleGroupSummary object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->ARN | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | High-level information about a RuleGroup, returned by operations like | ||
| 41 | create and list. This provides information like the ID, that you can | ||
| 42 | use to retrieve and manage a C<RuleGroup>, and the ARN, that you | ||
| 43 | provide to the RuleGroupReferenceStatement to use the rule group in a | ||
| 44 | Rule. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 ARN => Str | ||
| 50 | |||
| 51 | The Amazon Resource Name (ARN) of the entity. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Description => Str | ||
| 55 | |||
| 56 | A description of the rule group that helps with identification. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 Id => Str | ||
| 60 | |||
| 61 | A unique identifier for the rule group. This ID is returned in the | ||
| 62 | responses to create and list commands. You provide it to operations | ||
| 63 | like update and delete. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 LockToken => Str | ||
| 67 | |||
| 68 | A token used for optimistic locking. WAF returns a token to your get | ||
| 69 | and list requests, to mark the state of the entity at the time of the | ||
| 70 | request. To make changes to the entity associated with the token, you | ||
| 71 | provide the token to operations like update and delete. WAF uses the | ||
| 72 | token to ensure that no changes have been made to the entity since you | ||
| 73 | last retrieved it. If a change has been made, the update fails with a | ||
| 74 | C<WAFOptimisticLockException>. If this happens, perform another get, | ||
| 75 | and use the new token returned by that operation. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Name => Str | ||
| 79 | |||
| 80 | The name of the data type instance. You cannot change the name after | ||
| 81 | you create the instance. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head1 SEE ALSO | ||
| 86 | |||
| 87 | This class forms part of L<Paws>, describing an object used in L<Paws::WAFV2> | ||
| 88 | |||
| 89 | =head1 BUGS and CONTRIBUTIONS | ||
| 90 | |||
| 91 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 92 | |||
| 93 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 94 | |||
| 95 | =cut | ||
| 96 |