NAME

Paws::WAF::CreateRateBasedRule - Arguments for method CreateRateBasedRule on Paws::WAF

DESCRIPTION

This class represents the parameters used for calling the method CreateRateBasedRule on the AWS WAF 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.

SYNOPSIS

    my $waf = Paws->service('WAF');
    my $CreateRateBasedRuleResponse = $waf->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::WAF::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/CreateRateBasedRule>

ATTRIBUTES

REQUIRED ChangeToken => Str

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.

REQUIRED MetricName => Str

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".

REQUIRED Name => Str

A friendly name or description of the RateBasedRule. You can't change the name of a "RateBasedRule" after you create it.

REQUIRED RateKey => Str

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".

Valid values are: "IP"

REQUIRED RateLimit => Int

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.

Tags => ArrayRef[Paws::WAF::Tag]

BUGS and CONTRIBUTIONS

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>