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

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 C<Rule>. The
name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name
can't contain whitespace. You can't change C<MetricName> after you
create the C<Rule>.

Name => Str

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

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

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

REQUIRED RuleId => Str

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

RuleId is returned by CreateRule and by ListRules.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::WAF

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