Paws::WAFRegional::CreateRateBasedRule - Arguments for method CreateRateBasedRule on Paws::WAFRegional
This class represents the parameters used for calling the method CreateRateBasedRule on the AWS WAF Regional service. Use the attributes of this class as arguments to method CreateRateBasedRule.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateRateBasedRule.
my $waf-regional = Paws->service('WAFRegional'); my $CreateRateBasedRuleResponse = $waf -regional->CreateRateBasedRule( ChangeToken => 'MyChangeToken', MetricName => 'MyMetricName', Name => 'MyResourceName', RateKey => 'IP', RateLimit => 1, Tags => [ { Key => 'MyTagKey', # min: 1, max: 128 Value => 'MyTagValue', # max: 256 }, ... ], # OPTIONAL ); # Results: my $ChangeToken = $CreateRateBasedRuleResponse->ChangeToken; my $Rule = $CreateRateBasedRuleResponse->Rule; # Returns a L<Paws::WAFRegional::CreateRateBasedRuleResponse> object.
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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/waf-regional/CreateRateBasedRule
The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
ChangeToken
CreateRateBasedRule
A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.
RateBasedRule
A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it.
The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.
RateKey
IP
RateLimit
Valid values are: "IP"
"IP"
The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
This class forms part of Paws, documenting arguments for method CreateRateBasedRule in Paws::WAFRegional
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws
CPAN shell
perl -MCPAN -e shell install Paws
For more information on module installation, please visit the detailed CPAN module installation guide.