blib/lib/Paws/WAFRegional/CreateRateBasedRule.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::WAFRegional::CreateRateBasedRule;
3 use Moose;
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 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::WAFRegional::Tag]');
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateRateBasedRule');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAFRegional::CreateRateBasedRuleResponse');
15 class_has _result_key => (isa => 'Str', is => 'ro');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::WAFRegional::CreateRateBasedRule - Arguments for method CreateRateBasedRule on L<Paws::WAFRegional>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method CreateRateBasedRule on the
27 L<AWS WAF Regional|Paws::WAFRegional> service. Use the attributes of this class
28 as arguments to method CreateRateBasedRule.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateRateBasedRule.
31  
32 =head1 SYNOPSIS
33  
34 my $waf-regional = Paws->service('WAFRegional');
35 my $CreateRateBasedRuleResponse = $waf -regional->CreateRateBasedRule(
36 ChangeToken => 'MyChangeToken',
37 MetricName => 'MyMetricName',
38 Name => 'MyResourceName',
39 RateKey => 'IP',
40 RateLimit => 1,
41 Tags => [
42 {
43 Key => 'MyTagKey', # min: 1, max: 128
44 Value => 'MyTagValue', # max: 256
45  
46 },
47 ...
48 ], # OPTIONAL
49 );
50  
51 # Results:
52 my $ChangeToken = $CreateRateBasedRuleResponse->ChangeToken;
53 my $Rule = $CreateRateBasedRuleResponse->Rule;
54  
55 # Returns a L<Paws::WAFRegional::CreateRateBasedRuleResponse> object.
56  
57 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.
58 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/waf-regional/CreateRateBasedRule>
59  
60 =head1 ATTRIBUTES
61  
62  
63 =head2 B<REQUIRED> ChangeToken => Str
64  
65 The C<ChangeToken> that you used to submit the C<CreateRateBasedRule>
66 request. You can also use this value to query the status of the
67 request. For more information, see GetChangeTokenStatus.
68  
69  
70  
71 =head2 B<REQUIRED> MetricName => Str
72  
73 A friendly name or description for the metrics for this
74 C<RateBasedRule>. The name can contain only alphanumeric characters
75 (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It
76 can't contain whitespace or metric names reserved for AWS WAF,
77 including "All" and "Default_Action." You can't change the name of the
78 metric after you create the C<RateBasedRule>.
79  
80  
81  
82 =head2 B<REQUIRED> Name => Str
83  
84 A friendly name or description of the RateBasedRule. You can't change
85 the name of a C<RateBasedRule> after you create it.
86  
87  
88  
89 =head2 B<REQUIRED> RateKey => Str
90  
91 The field that AWS WAF uses to determine if requests are likely
92 arriving from a single source and thus subject to rate monitoring. The
93 only valid value for C<RateKey> is C<IP>. C<IP> indicates that requests
94 that arrive from the same IP address are subject to the C<RateLimit>
95 that is specified in the C<RateBasedRule>.
96  
97 Valid values are: C<"IP">
98  
99 =head2 B<REQUIRED> RateLimit => Int
100  
101 The maximum number of requests, which have an identical value in the
102 field that is specified by C<RateKey>, allowed in a five-minute period.
103 If the number of requests exceeds the C<RateLimit> and the other
104 predicates specified in the rule are also met, AWS WAF triggers the
105 action that is specified for this rule.
106  
107  
108  
109 =head2 Tags => ArrayRef[L<Paws::WAFRegional::Tag>]
110  
111  
112  
113  
114  
115  
116 =head1 SEE ALSO
117  
118 This class forms part of L<Paws>, documenting arguments for method CreateRateBasedRule in L<Paws::WAFRegional>
119  
120 =head1 BUGS and CONTRIBUTIONS
121  
122 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
123  
124 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
125  
126 =cut
127