class Aws::WAFV2::Types::WebACL

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.

@!attribute [rw] name

The name of the web ACL. You cannot change the name of a web ACL
after you create it.
@return [String]

@!attribute [rw] id

A unique identifier for the `WebACL`. This ID is returned in the
responses to create and list commands. You use this ID to do things
like get, update, and delete a `WebACL`.
@return [String]

@!attribute [rw] arn

The Amazon Resource Name (ARN) of the web ACL that you want to
associate with the resource.
@return [String]

@!attribute [rw] default_action

The action to perform if none of the `Rules` contained in the
`WebACL` match.
@return [Types::DefaultAction]

@!attribute [rw] description

A description of the web ACL that helps with identification.
@return [String]

@!attribute [rw] rules

The Rule statements used to identify the web requests that you want
to allow, block, or count. Each rule includes one top-level
statement that WAF uses to identify matching web requests, and
parameters that govern how WAF handles them.
@return [Array<Types::Rule>]

@!attribute [rw] visibility_config

Defines and enables Amazon CloudWatch metrics and web request sample
collection.
@return [Types::VisibilityConfig]

@!attribute [rw] capacity

The web ACL capacity units (WCUs) currently being used by this web
ACL.

WAF uses WCUs to calculate and control the operating resources that
are used to run your rules, rule groups, and web ACLs. WAF
calculates capacity differently for each rule type, to reflect the
relative cost of each rule. Simple rules that cost little to run use
fewer WCUs than more complex rules that use more processing power.
Rule group capacity is fixed at creation, which helps users plan
their web ACL WCU usage when they use a rule group. The WCU limit
for web ACLs is 1,500.
@return [Integer]

@!attribute [rw] pre_process_firewall_manager_rule_groups

The first set of rules for WAF to process in the web ACL. This is
defined in an Firewall Manager WAF policy and contains only rule
group references. You can't alter these. Any rules and rule groups
that you define for the web ACL are prioritized after these.

In the Firewall Manager WAF policy, the Firewall Manager
administrator can define a set of rule groups to run first in the
web ACL and a set of rule groups to run last. Within each set, the
administrator prioritizes the rule groups, to determine their
relative processing order.
@return [Array<Types::FirewallManagerRuleGroup>]

@!attribute [rw] post_process_firewall_manager_rule_groups

The last set of rules for WAF to process in the web ACL. This is
defined in an Firewall Manager WAF policy and contains only rule
group references. You can't alter these. Any rules and rule groups
that you define for the web ACL are prioritized before these.

In the Firewall Manager WAF policy, the Firewall Manager
administrator can define a set of rule groups to run first in the
web ACL and a set of rule groups to run last. Within each set, the
administrator prioritizes the rule groups, to determine their
relative processing order.
@return [Array<Types::FirewallManagerRuleGroup>]

@!attribute [rw] managed_by_firewall_manager

Indicates whether this web ACL is managed by Firewall Manager. If
true, then only Firewall Manager can delete the web ACL or any
Firewall Manager rule groups in the web ACL.
@return [Boolean]

@!attribute [rw] label_namespace

The label namespace prefix for this web ACL. All labels added by
rules in this web ACL have this prefix.

* The syntax for the label namespace prefix for a web ACL is the
  following:

  `awswaf:<account ID>:webacl:<web ACL name>:`

* When a rule with a label matches a web request, WAF adds the fully
  qualified label to the request. A fully qualified label is made up
  of the label namespace from the rule group or web ACL where the
  rule is defined and the label from the rule, separated by a colon:

  `<label namespace>:<label from rule>`
@return [String]

@!attribute [rw] custom_response_bodies

A map of custom response keys and content bodies. When you create a
rule with a block action, you can send a custom response to the web
request. You define these for the web ACL, and then use them in the
rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see
[Customizing web requests and responses in WAF][1] in the [WAF
Developer Guide][2].

For information about the limits on count and size for custom
request and response settings, see [WAF quotas][3] in the [WAF
Developer Guide][2].

[1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
[2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
[3]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
@return [Hash<String,Types::CustomResponseBody>]

@see docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/WebACL AWS API Documentation

Constants

SENSITIVE