| 1 | |||
| 2 | package Paws::WAF::UpdateRuleGroup; | ||
| 3 | use Moose; | ||
| 4 | has ChangeToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has RuleGroupId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Updates => (is => 'ro', isa => 'ArrayRef[Paws::WAF::RuleGroupUpdate]', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateRuleGroup'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAF::UpdateRuleGroupResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::WAF::UpdateRuleGroup - Arguments for method UpdateRuleGroup on L<Paws::WAF> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method UpdateRuleGroup on the | ||
| 24 | L<AWS WAF|Paws::WAF> service. Use the attributes of this class | ||
| 25 | as arguments to method UpdateRuleGroup. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateRuleGroup. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $waf = Paws->service('WAF'); | ||
| 32 | my $UpdateRuleGroupResponse = $waf->UpdateRuleGroup( | ||
| 33 | ChangeToken => 'MyChangeToken', | ||
| 34 | RuleGroupId => 'MyResourceId', | ||
| 35 | Updates => [ | ||
| 36 | { | ||
| 37 | Action => 'INSERT', # values: INSERT, DELETE | ||
| 38 | ActivatedRule => { | ||
| 39 | Priority => 1, | ||
| 40 | RuleId => 'MyResourceId', # min: 1, max: 128 | ||
| 41 | Action => { | ||
| 42 | Type => 'BLOCK', # values: BLOCK, ALLOW, COUNT | ||
| 43 | |||
| 44 | }, # OPTIONAL | ||
| 45 | ExcludedRules => [ | ||
| 46 | { | ||
| 47 | RuleId => 'MyResourceId', # min: 1, max: 128 | ||
| 48 | |||
| 49 | }, | ||
| 50 | ... | ||
| 51 | ], # OPTIONAL | ||
| 52 | OverrideAction => { | ||
| 53 | Type => 'NONE', # values: NONE, COUNT | ||
| 54 | |||
| 55 | }, # OPTIONAL | ||
| 56 | Type => 'REGULAR', # values: REGULAR, RATE_BASED, GROUP; OPTIONAL | ||
| 57 | }, | ||
| 58 | |||
| 59 | }, | ||
| 60 | ... | ||
| 61 | ], | ||
| 62 | |||
| 63 | ); | ||
| 64 | |||
| 65 | # Results: | ||
| 66 | my $ChangeToken = $UpdateRuleGroupResponse->ChangeToken; | ||
| 67 | |||
| 68 | # Returns a L<Paws::WAF::UpdateRuleGroupResponse> object. | ||
| 69 | |||
| 70 | 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. | ||
| 71 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/waf/UpdateRuleGroup> | ||
| 72 | |||
| 73 | =head1 ATTRIBUTES | ||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> ChangeToken => Str | ||
| 77 | |||
| 78 | The value returned by the most recent call to GetChangeToken. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> RuleGroupId => Str | ||
| 83 | |||
| 84 | The C<RuleGroupId> of the RuleGroup that you want to update. | ||
| 85 | C<RuleGroupId> is returned by CreateRuleGroup and by ListRuleGroups. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 B<REQUIRED> Updates => ArrayRef[L<Paws::WAF::RuleGroupUpdate>] | ||
| 90 | |||
| 91 | An array of C<RuleGroupUpdate> objects that you want to insert into or | ||
| 92 | delete from a RuleGroup. | ||
| 93 | |||
| 94 | You can only insert C<REGULAR> rules into a rule group. | ||
| 95 | |||
| 96 | C<ActivatedRule|OverrideAction> applies only when updating or adding a | ||
| 97 | C<RuleGroup> to a C<WebACL>. In this case you do not use | ||
| 98 | C<ActivatedRule|Action>. For all other update requests, | ||
| 99 | C<ActivatedRule|Action> is used instead of | ||
| 100 | C<ActivatedRule|OverrideAction>. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head1 SEE ALSO | ||
| 106 | |||
| 107 | This class forms part of L<Paws>, documenting arguments for method UpdateRuleGroup in L<Paws::WAF> | ||
| 108 | |||
| 109 | =head1 BUGS and CONTRIBUTIONS | ||
| 110 | |||
| 111 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 112 | |||
| 113 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 114 | |||
| 115 | =cut | ||
| 116 |