Skip to content

/AWS1/CL_WARRULE

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_ruleid TYPE /AWS1/WARRESOURCEID /AWS1/WARRESOURCEID

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.

it_predicates TYPE /AWS1/CL_WARPREDICATE=>TT_PREDICATES TT_PREDICATES

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

Optional arguments:

iv_name TYPE /AWS1/WARRESOURCENAME /AWS1/WARRESOURCENAME

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

iv_metricname TYPE /AWS1/WARMETRICNAME /AWS1/WARMETRICNAME

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.

Queryable Attributes

RuleId

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.

Accessible with the following methods

Method Description
GET_RULEID() Getter for RULEID, with configurable default
ASK_RULEID() Getter for RULEID w/ exceptions if field has no value
HAS_RULEID() Determine if RULEID has a value

Name

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

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

MetricName

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.

Accessible with the following methods

Method Description
GET_METRICNAME() Getter for METRICNAME, with configurable default
ASK_METRICNAME() Getter for METRICNAME w/ exceptions if field has no value
HAS_METRICNAME() Determine if METRICNAME has a value

Predicates

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

Accessible with the following methods

Method Description
GET_PREDICATES() Getter for PREDICATES, with configurable default
ASK_PREDICATES() Getter for PREDICATES w/ exceptions if field has no value
HAS_PREDICATES() Determine if PREDICATES has a value