Skip to content

WebACL

Source code in docs_src/capo_waf/types/web_acl.py
class WebACL(TypedDict, closed=True):
    web_acl_id: "capo_waf.types.resource_id.ResourceId"
    """<p>A unique identifier for a <code>WebACL</code>. You use <code>WebACLId</code> to get information about a <code>WebACL</code> (see <a>GetWebACL</a>), update a <code>WebACL</code> (see <a>UpdateWebACL</a>), and delete a <code>WebACL</code> from AWS WAF (see <a>DeleteWebACL</a>).</p> <p> <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>.</p>"""
    name: NotRequired["capo_waf.types.resource_name.ResourceName"]
    """<p>A friendly name or description of the <code>WebACL</code>. You can't change the name of a <code>WebACL</code> after you create it.</p>"""
    metric_name: NotRequired["capo_waf.types.metric_name.MetricName"]
    """<p>A friendly name or description for the metrics for this <code>WebACL</code>. 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 <code>MetricName</code> after you create the <code>WebACL</code>.</p>"""
    default_action: "capo_waf.types.waf_action.WafAction"
    """<p>The action to perform if none of the <code>Rules</code> contained in the <code>WebACL</code> match. The action is specified by the <a>WafAction</a> object.</p>"""
    rules: "capo_waf.types.activated_rules.ActivatedRules"
    """<p>An array that contains the action for each <code>Rule</code> in a <code>WebACL</code>, the priority of the <code>Rule</code>, and the ID of the <code>Rule</code>.</p>"""
    web_acl_arn: NotRequired["capo_waf.types.resource_arn.ResourceArn"]
    """<p>Tha Amazon Resource Name (ARN) of the web ACL.</p>"""

default_action instance-attribute

default_action: WafAction

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

metric_name instance-attribute

metric_name: NotRequired[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.

name instance-attribute

name: NotRequired[ResourceName]

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

rules instance-attribute

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

web_acl_arn instance-attribute

web_acl_arn: NotRequired[ResourceArn]

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

web_acl_id instance-attribute

web_acl_id: ResourceId

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.