File Coverage

blib/lib/Paws/WAFRegional/CreateRateBasedRule.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::WAFRegional::CreateRateBasedRule;
3 1     1   536 use Moose;
  1         4  
  1         8  
4             has ChangeToken => (is => 'ro', isa => 'Str', required => 1);
5             has MetricName => (is => 'ro', isa => 'Str', required => 1);
6             has Name => (is => 'ro', isa => 'Str', required => 1);
7             has RateKey => (is => 'ro', isa => 'Str', required => 1);
8             has RateLimit => (is => 'ro', isa => 'Int', required => 1);
9              
10 1     1   6510 use MooseX::ClassAttribute;
  1         4  
  1         11  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateRateBasedRule');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAFRegional::CreateRateBasedRuleResponse');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::WAFRegional::CreateRateBasedRule - Arguments for method CreateRateBasedRule on Paws::WAFRegional
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method CreateRateBasedRule on the
26             AWS WAF Regional service. Use the attributes of this class
27             as arguments to method CreateRateBasedRule.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateRateBasedRule.
30              
31             As an example:
32              
33             $service_obj->CreateRateBasedRule(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 B<REQUIRED> ChangeToken => Str
41              
42             The C<ChangeToken> that you used to submit the C<CreateRateBasedRule>
43             request. You can also use this value to query the status of the
44             request. For more information, see GetChangeTokenStatus.
45              
46              
47              
48             =head2 B<REQUIRED> MetricName => Str
49              
50             A friendly name or description for the metrics for this
51             C<RateBasedRule>. The name can contain only alphanumeric characters
52             (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change
53             the name of the metric after you create the C<RateBasedRule>.
54              
55              
56              
57             =head2 B<REQUIRED> Name => Str
58              
59             A friendly name or description of the RateBasedRule. You can't change
60             the name of a C<RateBasedRule> after you create it.
61              
62              
63              
64             =head2 B<REQUIRED> RateKey => Str
65              
66             The field that AWS WAF uses to determine if requests are likely
67             arriving from a single source and thus subject to rate monitoring. The
68             only valid value for C<RateKey> is C<IP>. C<IP> indicates that requests
69             that arrive from the same IP address are subject to the C<RateLimit>
70             that is specified in the C<RateBasedRule>.
71              
72             Valid values are: C<"IP">
73              
74             =head2 B<REQUIRED> RateLimit => Int
75              
76             The maximum number of requests, which have an identical value in the
77             field that is specified by C<RateKey>, allowed in a five-minute period.
78             If the number of requests exceeds the C<RateLimit> and the other
79             predicates specified in the rule are also met, AWS WAF triggers the
80             action that is specified for this rule.
81              
82              
83              
84              
85             =head1 SEE ALSO
86              
87             This class forms part of L<Paws>, documenting arguments for method CreateRateBasedRule in L<Paws::WAFRegional>
88              
89             =head1 BUGS and CONTRIBUTIONS
90              
91             The source code is located here: https://github.com/pplu/aws-sdk-perl
92              
93             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
94              
95             =cut
96