aws_waf_acl

account_id

Type: STRING

default_action

Type: STRUCT
Provider name: DefaultAction
Description: The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

• type
  Type: STRING
  Provider name: Type
  Description: Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:
  • ALLOW: AWS WAF allows requests
  • BLOCK: AWS WAF blocks requests
  • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can’t specify COUNT for the default action for a WebACL.

metric_name

Type: STRING
Provider name: MetricName
Description: 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

Type: STRING
Provider name: Name
Description: A friendly name or description of the WebACL. You can’t change the name of a WebACL after you create it.

rules

Type: UNORDERED_LIST_STRUCT
Provider name: Rules
Description: An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

• action
  Type: STRUCT
  Provider name: Action
  Description: Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:
  • ALLOW: CloudFront responds with the requested object.
  • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
  • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
  ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
  
  • type
    Type: STRING
    Provider name: Type
    Description: Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:
    • ALLOW: AWS WAF allows requests
    • BLOCK: AWS WAF blocks requests
    • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can’t specify COUNT for the default action for a WebACL.
• excluded_rules
  Type: UNORDERED_LIST_STRUCT
  Provider name: ExcludedRules
  Description: An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL. Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule. If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:
  1. Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.
  2. Submit an UpdateWebACL request that has two actions:
     • The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude.
     • The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude.
  
  
  • rule_id
    Type: STRING
    Provider name: RuleId
    Description: The unique identifier for the rule to exclude from the rule group.
    
• override_action
  Type: STRUCT
  Provider name: OverrideAction
  Description: Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
  
  • type
    Type: STRING
    Provider name: Type
    Description: COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule’s action will take place.
    
• priority
  Type: INT32
  Provider name: Priority
  Description: Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don’t need to be consecutive.
  
• rule_id
  Type: STRING
  Provider name: RuleId
  Description: The RuleId 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.
  
• type
  Type: STRING
  Provider name: Type
  Description: The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.
  

tags

Type: UNORDERED_LIST_STRING

web_acl_arn

Type: STRING
Provider name: WebACLArn
Description: Tha Amazon Resource Name (ARN) of the web ACL.

web_acl_id

Type: STRING
Provider name: WebACLId
Description: 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.