NAME

Paws::WAF::Rule

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::WAF::Rule object:

  $service_obj->Method(Att1 => { MetricName => $value, ..., RuleId => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::WAF::Rule object:

  $result = $service_obj->Method(...);
  $result->Att1->MetricName

DESCRIPTION

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a "Rule" that includes the following predicates:

An "IPSet" that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44
A "ByteMatchSet" that causes AWS WAF to search for web requests for which the value of the "User-Agent" header is "BadBot".

To match the settings in this "Rule", a request must originate from 192.0.2.44 AND include a "User-Agent" header for which the value is "BadBot".

ATTRIBUTES

MetricName => Str

A friendly name or description for the metrics for this "Rule". 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 "MetricName" after you create the "Rule".

Name => Str

The friendly name or description for the "Rule". You can't change the name of a "Rule" after you create it.

REQUIRED Predicates => ArrayRef[Paws::WAF::Predicate]

The "Predicates" object contains one "Predicate" element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a "Rule".

REQUIRED RuleId => Str

A unique identifier for a "Rule". You use "RuleId" to get more information about a "Rule" (see GetRule), update a "Rule" (see UpdateRule), insert a "Rule" into a "WebACL" or delete a one from a "WebACL" (see UpdateWebACL), or delete a "Rule" from AWS WAF (see DeleteRule).

"RuleId" is returned by CreateRule and by ListRules.

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>