/AWS1/CL_WAFWEBACL

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.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_webaclid TYPE /AWS1/WAFRESOURCEID /AWS1/WAFRESOURCEID

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

io_defaultaction TYPE REF TO /AWS1/CL_WAFWAFACTION /AWS1/CL_WAFWAFACTION

The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

it_rules TYPE /AWS1/CL_WAFACTIVATEDRULE=>TT_ACTIVATEDRULES TT_ACTIVATEDRULES

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Optional arguments:

iv_name TYPE /AWS1/WAFRESOURCENAME /AWS1/WAFRESOURCENAME

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

iv_metricname TYPE /AWS1/WAFMETRICNAME /AWS1/WAFMETRICNAME

A friendly name or description for the metrics for this WebACL. 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 WebACL.

iv_webaclarn TYPE /AWS1/WAFRESOURCEARN /AWS1/WAFRESOURCEARN

Tha Amazon Resource Name (ARN) of the web ACL.

---

Queryable Attributes

WebACLId

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

Accessible with the following methods

Method	Description
GET_WEBACLID()	Getter for WEBACLID, with configurable default
ASK_WEBACLID()	Getter for WEBACLID w/ exceptions if field has no value
HAS_WEBACLID()	Determine if WEBACLID has a value

Name

A friendly name or description of the WebACL. You can't change the name of a WebACL 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 WebACL. 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 WebACL.

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

DefaultAction

The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

Accessible with the following methods

Method	Description
GET_DEFAULTACTION()	Getter for DEFAULTACTION

Rules

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Accessible with the following methods

Method	Description
GET_RULES()	Getter for RULES, with configurable default
ASK_RULES()	Getter for RULES w/ exceptions if field has no value
HAS_RULES()	Determine if RULES has a value

WebACLArn

Tha Amazon Resource Name (ARN) of the web ACL.

Accessible with the following methods

Method	Description
GET_WEBACLARN()	Getter for WEBACLARN, with configurable default
ASK_WEBACLARN()	Getter for WEBACLARN w/ exceptions if field has no value
HAS_WEBACLARN()	Determine if WEBACLARN has a value