WebAcl
A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. 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 resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, and Amazon Web Services Verified Access instance.
Types
Properties
Returns a list of ApplicationAttribute
s.
Specifies custom configurations for the associations between the web ACL and protected resources.
Specifies how WAF should handle CAPTCHA
evaluations for rules that don't have their own CaptchaConfig
settings. If you don't specify this, WAF uses its default settings for CaptchaConfig
.
Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig
settings. If you don't specify this, WAF uses its default settings for ChallengeConfig
.
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.
Specifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option.
The action to perform if none of the Rules
contained in the WebACL
match.
A description of the web ACL that helps with identification.
The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
Indicates whether this web ACL was created by Firewall Manager and is being 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. See also the properties RetrofittedByFirewallManager
, PreProcessFirewallManagerRuleGroups
, and PostProcessFirewallManagerRuleGroups
.
Configures the level of DDoS protection that applies to web ACLs associated with Application Load Balancers.
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.
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.
Indicates whether this web ACL was created by a customer account and then retrofitted by Firewall Manager. If true, then the web ACL is currently being managed by a Firewall Manager WAF policy, and only Firewall Manager can manage any Firewall Manager rule groups in the web ACL. See also the properties ManagedByFirewallManager
, PreProcessFirewallManagerRuleGroups
, and PostProcessFirewallManagerRuleGroups
.
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
Defines and enables Amazon CloudWatch metrics and web request sample collection.