« blib/lib/Paws/WAFV2/UpdateIPSetResponse.pm
↑ Summary
blib/lib/Paws/WAFV2/UpdateRegexPatternSetResponse.pm »
| 1 | |||
| 2 | package Paws::WAFV2::UpdateRegexPatternSet; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has LockToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has RegularExpressionList => (is => 'ro', isa => 'ArrayRef[Paws::WAFV2::Regex]', required => 1); | ||
| 9 | has Scope => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateRegexPatternSet'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAFV2::UpdateRegexPatternSetResponse'); | ||
| 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::UpdateRegexPatternSet - Arguments for method UpdateRegexPatternSet on L<Paws::WAFV2> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method UpdateRegexPatternSet on the | ||
| 27 | L<AWS WAFV2|Paws::WAFV2> service. Use the attributes of this class | ||
| 28 | as arguments to method UpdateRegexPatternSet. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateRegexPatternSet. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $wafv2 = Paws->service('WAFV2'); | ||
| 35 | my $UpdateRegexPatternSetResponse = $wafv2->UpdateRegexPatternSet( | ||
| 36 | Id => 'MyEntityId', | ||
| 37 | LockToken => 'MyLockToken', | ||
| 38 | Name => 'MyEntityName', | ||
| 39 | RegularExpressionList => [ | ||
| 40 | { | ||
| 41 | RegexString => 'MyRegexPatternString', # min: 1, max: 512; OPTIONAL | ||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], | ||
| 45 | Scope => 'CLOUDFRONT', | ||
| 46 | Description => 'MyEntityDescription', # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $NextLockToken = $UpdateRegexPatternSetResponse->NextLockToken; | ||
| 51 | |||
| 52 | # Returns a L<Paws::WAFV2::UpdateRegexPatternSetResponse> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/wafv2/UpdateRegexPatternSet> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Description => Str | ||
| 61 | |||
| 62 | A description of the set that helps with identification. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> Id => Str | ||
| 67 | |||
| 68 | A unique identifier for the set. This ID is returned in the responses | ||
| 69 | to create and list commands. You provide it to operations like update | ||
| 70 | and delete. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> LockToken => Str | ||
| 75 | |||
| 76 | A token used for optimistic locking. WAF returns a token to your get | ||
| 77 | and list requests, to mark the state of the entity at the time of the | ||
| 78 | request. To make changes to the entity associated with the token, you | ||
| 79 | provide the token to operations like update and delete. WAF uses the | ||
| 80 | token to ensure that no changes have been made to the entity since you | ||
| 81 | last retrieved it. If a change has been made, the update fails with a | ||
| 82 | C<WAFOptimisticLockException>. If this happens, perform another get, | ||
| 83 | and use the new token returned by that operation. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> Name => Str | ||
| 88 | |||
| 89 | The name of the set. You cannot change the name after you create the | ||
| 90 | set. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> RegularExpressionList => ArrayRef[L<Paws::WAFV2::Regex>] | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 B<REQUIRED> Scope => Str | ||
| 101 | |||
| 102 | Specifies whether this is for an Amazon CloudFront distribution or for | ||
| 103 | a regional application. A regional application can be an Application | ||
| 104 | Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync | ||
| 105 | GraphQL API. | ||
| 106 | |||
| 107 | To work with CloudFront, you must also specify the Region US East (N. | ||
| 108 | Virginia) as follows: | ||
| 109 | |||
| 110 | =over | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | CLI - Specify the Region when you use the CloudFront scope: | ||
| 115 | C<--scope=CLOUDFRONT --region=us-east-1>. | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | API and SDKs - For all calls, use the Region endpoint us-east-1. | ||
| 120 | |||
| 121 | =back | ||
| 122 | |||
| 123 | |||
| 124 | Valid values are: C<"CLOUDFRONT">, C<"REGIONAL"> | ||
| 125 | |||
| 126 | |||
| 127 | =head1 SEE ALSO | ||
| 128 | |||
| 129 | This class forms part of L<Paws>, documenting arguments for method UpdateRegexPatternSet in L<Paws::WAFV2> | ||
| 130 | |||
| 131 | =head1 BUGS and CONTRIBUTIONS | ||
| 132 | |||
| 133 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 134 | |||
| 135 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 136 | |||
| 137 | =cut | ||
| 138 |