AWS WAFV2

2022/10/27 - AWS WAFV2 - 13 updated api methods

Changes  This release adds the following: Challenge rule action, to silently verify client browsers; rule group rule action override to any valid rule action, not just Count; token sharing between protected applications for challenge/CAPTCHA token; targeted rules option for Bot Control managed rule group.

CheckCapacity (updated) Link ¶
Changes (request)
{'Rules': {'Action': {'Challenge': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                 'Value': 'string'}]}}},
           'ChallengeConfig': {'ImmunityTimeProperty': {'ImmunityTime': 'long'}},
           'Statement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesBotControlRuleSet': {'InspectionLevel': 'COMMON '
                                                                                                                                           '| '
                                                                                                                                           'TARGETED'}},
                                                       'RuleActionOverrides': [{'ActionToUse': {'Allow': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                       'Value': 'string'}]}},
                                                                                                'Block': {'CustomResponse': {'CustomResponseBodyKey': 'string',
                                                                                                                             'ResponseCode': 'integer',
                                                                                                                             'ResponseHeaders': [{'Name': 'string',
                                                                                                                                                  'Value': 'string'}]}},
                                                                                                'Captcha': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                         'Value': 'string'}]}},
                                                                                                'Challenge': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                           'Value': 'string'}]}},
                                                                                                'Count': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                       'Value': 'string'}]}}},
                                                                                'Name': 'string'}]},
                         'RuleGroupReferenceStatement': {'RuleActionOverrides': [{'ActionToUse': {'Allow': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                         'Value': 'string'}]}},
                                                                                                  'Block': {'CustomResponse': {'CustomResponseBodyKey': 'string',
                                                                                                                               'ResponseCode': 'integer',
                                                                                                                               'ResponseHeaders': [{'Name': 'string',
                                                                                                                                                    'Value': 'string'}]}},
                                                                                                  'Captcha': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                           'Value': 'string'}]}},
                                                                                                  'Challenge': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                             'Value': 'string'}]}},
                                                                                                  'Count': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                         'Value': 'string'}]}}},
                                                                                  'Name': 'string'}]}}}}

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL .

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.

See also: AWS API Documentation

Request Syntax

client.check_capacity(
    Scope='CLOUDFRONT'|'REGIONAL',
    Rules=[
        {
            'Name': 'string',
            'Priority': 123,
            'Statement': {
                'ByteMatchStatement': {
                    'SearchString': b'bytes',
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ],
                    'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
                },
                'SqliMatchStatement': {
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ],
                    'SensitivityLevel': 'LOW'|'HIGH'
                },
                'XssMatchStatement': {
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ]
                },
                'SizeConstraintStatement': {
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
                    'Size': 123,
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ]
                },
                'GeoMatchStatement': {
                    'CountryCodes': [
                        'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK',
                    ],
                    'ForwardedIPConfig': {
                        'HeaderName': 'string',
                        'FallbackBehavior': 'MATCH'|'NO_MATCH'
                    }
                },
                'RuleGroupReferenceStatement': {
                    'ARN': 'string',
                    'ExcludedRules': [
                        {
                            'Name': 'string'
                        },
                    ],
                    'RuleActionOverrides': [
                        {
                            'Name': 'string',
                            'ActionToUse': {
                                'Block': {
                                    'CustomResponse': {
                                        'ResponseCode': 123,
                                        'CustomResponseBodyKey': 'string',
                                        'ResponseHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Allow': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Count': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Captcha': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Challenge': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                }
                            }
                        },
                    ]
                },
                'IPSetReferenceStatement': {
                    'ARN': 'string',
                    'IPSetForwardedIPConfig': {
                        'HeaderName': 'string',
                        'FallbackBehavior': 'MATCH'|'NO_MATCH',
                        'Position': 'FIRST'|'LAST'|'ANY'
                    }
                },
                'RegexPatternSetReferenceStatement': {
                    'ARN': 'string',
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ]
                },
                'RateBasedStatement': {
                    'Limit': 123,
                    'AggregateKeyType': 'IP'|'FORWARDED_IP',
                    'ScopeDownStatement': {'... recursive ...'},
                    'ForwardedIPConfig': {
                        'HeaderName': 'string',
                        'FallbackBehavior': 'MATCH'|'NO_MATCH'
                    }
                },
                'AndStatement': {
                    'Statements': [
                        {'... recursive ...'},
                    ]
                },
                'OrStatement': {
                    'Statements': [
                        {'... recursive ...'},
                    ]
                },
                'NotStatement': {
                    'Statement': {'... recursive ...'}
                },
                'ManagedRuleGroupStatement': {
                    'VendorName': 'string',
                    'Name': 'string',
                    'Version': 'string',
                    'ExcludedRules': [
                        {
                            'Name': 'string'
                        },
                    ],
                    'ScopeDownStatement': {'... recursive ...'},
                    'ManagedRuleGroupConfigs': [
                        {
                            'LoginPath': 'string',
                            'PayloadType': 'JSON'|'FORM_ENCODED',
                            'UsernameField': {
                                'Identifier': 'string'
                            },
                            'PasswordField': {
                                'Identifier': 'string'
                            },
                            'AWSManagedRulesBotControlRuleSet': {
                                'InspectionLevel': 'COMMON'|'TARGETED'
                            }
                        },
                    ],
                    'RuleActionOverrides': [
                        {
                            'Name': 'string',
                            'ActionToUse': {
                                'Block': {
                                    'CustomResponse': {
                                        'ResponseCode': 123,
                                        'CustomResponseBodyKey': 'string',
                                        'ResponseHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Allow': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Count': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Captcha': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Challenge': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                }
                            }
                        },
                    ]
                },
                'LabelMatchStatement': {
                    'Scope': 'LABEL'|'NAMESPACE',
                    'Key': 'string'
                },
                'RegexMatchStatement': {
                    'RegexString': 'string',
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ]
                }
            },
            'Action': {
                'Block': {
                    'CustomResponse': {
                        'ResponseCode': 123,
                        'CustomResponseBodyKey': 'string',
                        'ResponseHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Allow': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Count': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Captcha': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Challenge': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                }
            },
            'OverrideAction': {
                'Count': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'None': {}

            },
            'RuleLabels': [
                {
                    'Name': 'string'
                },
            ],
            'VisibilityConfig': {
                'SampledRequestsEnabled': True|False,
                'CloudWatchMetricsEnabled': True|False,
                'MetricName': 'string'
            },
            'CaptchaConfig': {
                'ImmunityTimeProperty': {
                    'ImmunityTime': 123
                }
            },
            'ChallengeConfig': {
                'ImmunityTimeProperty': {
                    'ImmunityTime': 123
                }
            }
        },
    ]
)
type Scope

string

param Scope

[REQUIRED]

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1 .

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

type Rules

list

param Rules

[REQUIRED]

An array of Rule that you're configuring to use in a rule group or web ACL.

  • (dict) --

    A single rule, which you can use in a WebACL or RuleGroup to identify 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.

    • Name (string) -- [REQUIRED]

      The name of the rule. You can't change the name of a Rule after you create it.

    • Priority (integer) -- [REQUIRED]

      If you define more than one Rule in a WebACL , WAF evaluates each request against the Rules in order based on the value of Priority . WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

    • Statement (dict) -- [REQUIRED]

      The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .

      • ByteMatchStatement (dict) --

        A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

        • SearchString (bytes) -- [REQUIRED]

          A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 50 bytes.

          Valid values depend on the component that you specify for inspection in FieldToMatch :

          • Method : The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request.

          • UriPath : The value that you want WAF to search for in the URI path, for example, /images/daily-ad.jpg .

          If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

          If you're using the WAF API

          Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

          For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90 , in the value of SearchString .

          If you're using the CLI or one of the Amazon Web Services SDKs

          The value that you want WAF to search for. The SDK automatically base64 encodes the value.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

        • PositionalConstraint (string) -- [REQUIRED]

          The area within the portion of the web request that you want WAF to search for SearchString . Valid values include the following:

          CONTAINS

          The specified part of the web request must include the value of SearchString , but the location doesn't matter.

          CONTAINS_WORD

          The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:

          • SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and ;BadBot .

          • SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot; .

          EXACTLY

          The value of the specified part of the web request must exactly match the value of SearchString .

          STARTS_WITH

          The value of SearchString must appear at the beginning of the specified part of the web request.

          ENDS_WITH

          The value of SearchString must appear at the end of the specified part of the web request.

      • SqliMatchStatement (dict) --

        A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

        • SensitivityLevel (string) --

          The sensitivity that you want WAF to use to inspect for SQL injection attacks.

          HIGH detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the WAF Developer Guide .

          LOW is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.

          Default: LOW

      • XssMatchStatement (dict) --

        A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

      • SizeConstraintStatement (dict) --

        A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

        If you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.

        If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • ComparisonOperator (string) -- [REQUIRED]

          The operator to use to compare the request part to the size setting.

        • Size (integer) -- [REQUIRED]

          The size, in byte, to compare to the request part, after any transformations.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

      • GeoMatchStatement (dict) --

        A rule statement used to identify web requests based on country of origin.

        • CountryCodes (list) --

          An array of two-character country codes, for example, [ "US", "CN" ] , from the alpha-2 country ISO codes of the ISO 3166 international standard.

          • (string) --

        • ForwardedIPConfig (dict) --

          The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

          Note

          If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • HeaderName (string) -- [REQUIRED]

            The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For .

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • FallbackBehavior (string) -- [REQUIRED]

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

            You can specify the following fallback behaviors:

            • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

      • RuleGroupReferenceStatement (dict) --

        A rule statement used to run the rules that are defined in a RuleGroup . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

        You cannot nest a RuleGroupReferenceStatement , for example for use inside a NotStatement or OrStatement . You can only use a rule group reference statement at the top level inside a web ACL.

        • ARN (string) -- [REQUIRED]

          The Amazon Resource Name (ARN) of the entity.

        • ExcludedRules (list) --

          Rules in the referenced rule group whose actions are set to Count .

          Note

          Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

          • (dict) --

            Specifies a single rule in a rule group whose action you want to override to Count .

            Note

            Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

            • Name (string) -- [REQUIRED]

              The name of the rule whose action you want to override to Count .

        • RuleActionOverrides (list) --

          Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

          You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

          • (dict) --

            Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

            You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

            • Name (string) -- [REQUIRED]

              The name of the rule to override.

            • ActionToUse (dict) -- [REQUIRED]

              The override action to use, in place of the configured action of the rule in the rule group.

              • Block (dict) --

                Instructs WAF to block the web request.

                • CustomResponse (dict) --

                  Defines a custom response for the web request.

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

                  • ResponseCode (integer) -- [REQUIRED]

                    The HTTP status code to return to the client.

                    For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide .

                  • CustomResponseBodyKey (string) --

                    References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

                  • ResponseHeaders (list) --

                    The HTTP headers to use in the response. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Allow (dict) --

                Instructs WAF to allow the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Count (dict) --

                Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Captcha (dict) --

                Instructs WAF to run a CAPTCHA check against the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Challenge (dict) --

                Instructs WAF to run a Challenge check against the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

      • IPSetReferenceStatement (dict) --

        A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet .

        Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

        • ARN (string) -- [REQUIRED]

          The Amazon Resource Name (ARN) of the IPSet that this statement references.

        • IPSetForwardedIPConfig (dict) --

          The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

          Note

          If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • HeaderName (string) -- [REQUIRED]

            The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For .

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • FallbackBehavior (string) -- [REQUIRED]

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

            You can specify the following fallback behaviors:

            • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

          • Position (string) -- [REQUIRED]

            The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

            The options for this setting are the following:

            • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

            • LAST - Inspect the last IP address in the list of IP addresses in the header.

            • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.

      • RegexPatternSetReferenceStatement (dict) --

        A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet .

        Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

        • ARN (string) -- [REQUIRED]

          The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

      • RateBasedStatement (dict) --

        A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

        WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

        When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.

        You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

        • An IP match statement with an IP set that specified the address 192.0.2.44.

        • A string match statement that searches in the User-Agent header for the string BadBot.

        In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.

        You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement . You can define a RateBasedStatement inside a web ACL and inside a rule group.

        • Limit (integer) -- [REQUIRED]

          The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement , this limit is applied only to the requests that match the statement.

        • AggregateKeyType (string) -- [REQUIRED]

          Setting that indicates how to aggregate the request counts. The options are the following:

          • IP - Aggregate the request counts on the IP address from the web request origin.

          • FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig , to specify the header to use.

        • ScopeDownStatement (dict) --

          An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement. Requests are only tracked by the rate-based statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

        • ForwardedIPConfig (dict) --

          The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

          Note

          If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          This is required if AggregateKeyType is set to FORWARDED_IP .

          • HeaderName (string) -- [REQUIRED]

            The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For .

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • FallbackBehavior (string) -- [REQUIRED]

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

            You can specify the following fallback behaviors:

            • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

      • AndStatement (dict) --

        A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement .

        • Statements (list) -- [REQUIRED]

          The statements to combine with AND logic. You can use any statements that can be nested.

          • (dict) --

            The processing guidance for a Rule , used by WAF to determine whether a web request matches the rule.

            For example specifications, see the examples section of CreateWebACL .

      • OrStatement (dict) --

        A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement .

        • Statements (list) -- [REQUIRED]

          The statements to combine with OR logic. You can use any statements that can be nested.

          • (dict) --

            The processing guidance for a Rule , used by WAF to determine whether a web request matches the rule.

            For example specifications, see the examples section of CreateWebACL .

      • NotStatement (dict) --

        A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement .

        • Statement (dict) --

          The statement to negate. You can use any statement that can be nested.

      • ManagedRuleGroupStatement (dict) --

        A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups .

        You cannot nest a ManagedRuleGroupStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.

        Note

        You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet . For more information, see WAF Pricing .

        • VendorName (string) -- [REQUIRED]

          The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

        • Name (string) -- [REQUIRED]

          The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

        • Version (string) --

          The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

        • ExcludedRules (list) --

          Rules in the referenced rule group whose actions are set to Count .

          Note

          Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

          • (dict) --

            Specifies a single rule in a rule group whose action you want to override to Count .

            Note

            Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

            • Name (string) -- [REQUIRED]

              The name of the rule whose action you want to override to Count .

        • ScopeDownStatement (dict) --

          An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

        • ManagedRuleGroupConfigs (list) --

          Additional information that's used by a managed rule group. Many managed rule groups don't require this.

          Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

          • (dict) --

            Additional information that's used by a managed rule group. Many managed rule groups don't require this.

            Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

            For example specifications, see the examples section of CreateWebACL .

            • LoginPath (string) --

              The path of the login endpoint for your application. For example, for the URL https://example.com/web/login , you would provide the path /web/login .

            • PayloadType (string) --

              The payload type for your login endpoint, either JSON or form encoded.

            • UsernameField (dict) --

              Details about your login page username field.

              • Identifier (string) -- [REQUIRED]

                The name of the username field. For example /form/username .

            • PasswordField (dict) --

              Details about your login page password field.

              • Identifier (string) -- [REQUIRED]

                The name of the password field. For example /form/password .

            • AWSManagedRulesBotControlRuleSet (dict) --

              Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide .

              • InspectionLevel (string) -- [REQUIRED]

                The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group .

        • RuleActionOverrides (list) --

          Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

          You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

          • (dict) --

            Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

            You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

            • Name (string) -- [REQUIRED]

              The name of the rule to override.

            • ActionToUse (dict) -- [REQUIRED]

              The override action to use, in place of the configured action of the rule in the rule group.

              • Block (dict) --

                Instructs WAF to block the web request.

                • CustomResponse (dict) --

                  Defines a custom response for the web request.

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

                  • ResponseCode (integer) -- [REQUIRED]

                    The HTTP status code to return to the client.

                    For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide .

                  • CustomResponseBodyKey (string) --

                    References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

                  • ResponseHeaders (list) --

                    The HTTP headers to use in the response. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Allow (dict) --

                Instructs WAF to allow the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Count (dict) --

                Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Captcha (dict) --

                Instructs WAF to run a CAPTCHA check against the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Challenge (dict) --

                Instructs WAF to run a Challenge check against the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

      • LabelMatchStatement (dict) --

        A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.

        The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

        • Scope (string) -- [REQUIRED]

          Specify whether you want to match using the label name or just the namespace.

        • Key (string) -- [REQUIRED]

          The string to match against. The setting you provide for this depends on the match statement's Scope setting:

          • If the Scope indicates LABEL , then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name.

          • If the Scope indicates NAMESPACE , then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.

          Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name .

      • RegexMatchStatement (dict) --

        A rule statement used to search web request components for a match against a single regular expression.

        • RegexString (string) -- [REQUIRED]

          The string representing the regular expression.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

    • Action (dict) --

      The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

      This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement .

      You must specify either this Action setting or the rule OverrideAction setting, but not both:

      • If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.

      • If the rule statement references a rule group, use the override action setting and not this action setting.

      • Block (dict) --

        Instructs WAF to block the web request.

        • CustomResponse (dict) --

          Defines a custom response for the web request.

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

          • ResponseCode (integer) -- [REQUIRED]

            The HTTP status code to return to the client.

            For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide .

          • CustomResponseBodyKey (string) --

            References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

          • ResponseHeaders (list) --

            The HTTP headers to use in the response. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • Allow (dict) --

        Instructs WAF to allow the web request.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • Count (dict) --

        Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • Captcha (dict) --

        Instructs WAF to run a CAPTCHA check against the web request.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • Challenge (dict) --

        Instructs WAF to run a Challenge check against the web request.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

    • OverrideAction (dict) --

      The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

      You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement .

      Note

      This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

      • Count (dict) --

        Override the rule group evaluation result to count only.

        Note

        This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • None (dict) --

        Don't override the rule group evaluation result. This is the most common setting.

    • RuleLabels (list) --

      Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

      Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement .

      For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:

      • Separate each component of the label with a colon.

      • Each namespace or name can have up to 128 characters.

      • You can specify up to 5 namespaces in a label.

      • Don't use the following reserved words in your label specification: aws , waf , managed , rulegroup , webacl , regexpatternset , or ipset .

      For example, myLabelName or nameSpace1:nameSpace2:myLabelName .

      • (dict) --

        A single label container. This is used as an element of a label array in multiple contexts, for example, in RuleLabels inside a Rule and in Labels inside a SampledHTTPRequest .

        • Name (string) -- [REQUIRED]

          The label string.

    • VisibilityConfig (dict) -- [REQUIRED]

      Defines and enables Amazon CloudWatch metrics and web request sample collection.

      • SampledRequestsEnabled (boolean) -- [REQUIRED]

        A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

      • CloudWatchMetricsEnabled (boolean) -- [REQUIRED]

        A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics .

      • MetricName (string) -- [REQUIRED]

        A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for WAF, for example All and Default_Action .

    • CaptchaConfig (dict) --

      Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.

      • ImmunityTimeProperty (dict) --

        Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.

        • ImmunityTime (integer) -- [REQUIRED]

          The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

          For the Challenge action, the minimum setting is 300.

    • ChallengeConfig (dict) --

      Specifies how WAF should handle Challenge evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL.

      • ImmunityTimeProperty (dict) --

        Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.

        • ImmunityTime (integer) -- [REQUIRED]

          The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

          For the Challenge action, the minimum setting is 300.

rtype

dict

returns

Response Syntax

{
    'Capacity': 123
}

Response Structure

  • (dict) --

    • Capacity (integer) --

      The capacity required by the rules and scope.

CreateRuleGroup (updated) Link ¶
Changes (request)
{'Rules': {'Action': {'Challenge': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                 'Value': 'string'}]}}},
           'ChallengeConfig': {'ImmunityTimeProperty': {'ImmunityTime': 'long'}},
           'Statement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesBotControlRuleSet': {'InspectionLevel': 'COMMON '
                                                                                                                                           '| '
                                                                                                                                           'TARGETED'}},
                                                       'RuleActionOverrides': [{'ActionToUse': {'Allow': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                       'Value': 'string'}]}},
                                                                                                'Block': {'CustomResponse': {'CustomResponseBodyKey': 'string',
                                                                                                                             'ResponseCode': 'integer',
                                                                                                                             'ResponseHeaders': [{'Name': 'string',
                                                                                                                                                  'Value': 'string'}]}},
                                                                                                'Captcha': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                         'Value': 'string'}]}},
                                                                                                'Challenge': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                           'Value': 'string'}]}},
                                                                                                'Count': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                       'Value': 'string'}]}}},
                                                                                'Name': 'string'}]},
                         'RuleGroupReferenceStatement': {'RuleActionOverrides': [{'ActionToUse': {'Allow': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                         'Value': 'string'}]}},
                                                                                                  'Block': {'CustomResponse': {'CustomResponseBodyKey': 'string',
                                                                                                                               'ResponseCode': 'integer',
                                                                                                                               'ResponseHeaders': [{'Name': 'string',
                                                                                                                                                    'Value': 'string'}]}},
                                                                                                  'Captcha': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                           'Value': 'string'}]}},
                                                                                                  'Challenge': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                             'Value': 'string'}]}},
                                                                                                  'Count': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                         'Value': 'string'}]}}},
                                                                                  'Name': 'string'}]}}}}

Creates a RuleGroup per the specifications provided.

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL . When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

See also: AWS API Documentation

Request Syntax

client.create_rule_group(
    Name='string',
    Scope='CLOUDFRONT'|'REGIONAL',
    Capacity=123,
    Description='string',
    Rules=[
        {
            'Name': 'string',
            'Priority': 123,
            'Statement': {
                'ByteMatchStatement': {
                    'SearchString': b'bytes',
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ],
                    'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
                },
                'SqliMatchStatement': {
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ],
                    'SensitivityLevel': 'LOW'|'HIGH'
                },
                'XssMatchStatement': {
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ]
                },
                'SizeConstraintStatement': {
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
                    'Size': 123,
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ]
                },
                'GeoMatchStatement': {
                    'CountryCodes': [
                        'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK',
                    ],
                    'ForwardedIPConfig': {
                        'HeaderName': 'string',
                        'FallbackBehavior': 'MATCH'|'NO_MATCH'
                    }
                },
                'RuleGroupReferenceStatement': {
                    'ARN': 'string',
                    'ExcludedRules': [
                        {
                            'Name': 'string'
                        },
                    ],
                    'RuleActionOverrides': [
                        {
                            'Name': 'string',
                            'ActionToUse': {
                                'Block': {
                                    'CustomResponse': {
                                        'ResponseCode': 123,
                                        'CustomResponseBodyKey': 'string',
                                        'ResponseHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Allow': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Count': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Captcha': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Challenge': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                }
                            }
                        },
                    ]
                },
                'IPSetReferenceStatement': {
                    'ARN': 'string',
                    'IPSetForwardedIPConfig': {
                        'HeaderName': 'string',
                        'FallbackBehavior': 'MATCH'|'NO_MATCH',
                        'Position': 'FIRST'|'LAST'|'ANY'
                    }
                },
                'RegexPatternSetReferenceStatement': {
                    'ARN': 'string',
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ]
                },
                'RateBasedStatement': {
                    'Limit': 123,
                    'AggregateKeyType': 'IP'|'FORWARDED_IP',
                    'ScopeDownStatement': {'... recursive ...'},
                    'ForwardedIPConfig': {
                        'HeaderName': 'string',
                        'FallbackBehavior': 'MATCH'|'NO_MATCH'
                    }
                },
                'AndStatement': {
                    'Statements': [
                        {'... recursive ...'},
                    ]
                },
                'OrStatement': {
                    'Statements': [
                        {'... recursive ...'},
                    ]
                },
                'NotStatement': {
                    'Statement': {'... recursive ...'}
                },
                'ManagedRuleGroupStatement': {
                    'VendorName': 'string',
                    'Name': 'string',
                    'Version': 'string',
                    'ExcludedRules': [
                        {
                            'Name': 'string'
                        },
                    ],
                    'ScopeDownStatement': {'... recursive ...'},
                    'ManagedRuleGroupConfigs': [
                        {
                            'LoginPath': 'string',
                            'PayloadType': 'JSON'|'FORM_ENCODED',
                            'UsernameField': {
                                'Identifier': 'string'
                            },
                            'PasswordField': {
                                'Identifier': 'string'
                            },
                            'AWSManagedRulesBotControlRuleSet': {
                                'InspectionLevel': 'COMMON'|'TARGETED'
                            }
                        },
                    ],
                    'RuleActionOverrides': [
                        {
                            'Name': 'string',
                            'ActionToUse': {
                                'Block': {
                                    'CustomResponse': {
                                        'ResponseCode': 123,
                                        'CustomResponseBodyKey': 'string',
                                        'ResponseHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Allow': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Count': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Captcha': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Challenge': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                }
                            }
                        },
                    ]
                },
                'LabelMatchStatement': {
                    'Scope': 'LABEL'|'NAMESPACE',
                    'Key': 'string'
                },
                'RegexMatchStatement': {
                    'RegexString': 'string',
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ]
                }
            },
            'Action': {
                'Block': {
                    'CustomResponse': {
                        'ResponseCode': 123,
                        'CustomResponseBodyKey': 'string',
                        'ResponseHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Allow': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Count': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Captcha': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Challenge': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                }
            },
            'OverrideAction': {
                'Count': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'None': {}

            },
            'RuleLabels': [
                {
                    'Name': 'string'
                },
            ],
            'VisibilityConfig': {
                'SampledRequestsEnabled': True|False,
                'CloudWatchMetricsEnabled': True|False,
                'MetricName': 'string'
            },
            'CaptchaConfig': {
                'ImmunityTimeProperty': {
                    'ImmunityTime': 123
                }
            },
            'ChallengeConfig': {
                'ImmunityTimeProperty': {
                    'ImmunityTime': 123
                }
            }
        },
    ],
    VisibilityConfig={
        'SampledRequestsEnabled': True|False,
        'CloudWatchMetricsEnabled': True|False,
        'MetricName': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    CustomResponseBodies={
        'string': {
            'ContentType': 'TEXT_PLAIN'|'TEXT_HTML'|'APPLICATION_JSON',
            'Content': 'string'
        }
    }
)
type Name

string

param Name

[REQUIRED]

The name of the rule group. You cannot change the name of a rule group after you create it.

type Scope

string

param Scope

[REQUIRED]

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1 .

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

type Capacity

integer

param Capacity

[REQUIRED]

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity .

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.

type Description

string

param Description

A description of the rule group that helps with identification.

type Rules

list

param 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.

  • (dict) --

    A single rule, which you can use in a WebACL or RuleGroup to identify 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.

    • Name (string) -- [REQUIRED]

      The name of the rule. You can't change the name of a Rule after you create it.

    • Priority (integer) -- [REQUIRED]

      If you define more than one Rule in a WebACL , WAF evaluates each request against the Rules in order based on the value of Priority . WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

    • Statement (dict) -- [REQUIRED]

      The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .

      • ByteMatchStatement (dict) --

        A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

        • SearchString (bytes) -- [REQUIRED]

          A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 50 bytes.

          Valid values depend on the component that you specify for inspection in FieldToMatch :

          • Method : The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request.

          • UriPath : The value that you want WAF to search for in the URI path, for example, /images/daily-ad.jpg .

          If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

          If you're using the WAF API

          Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

          For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90 , in the value of SearchString .

          If you're using the CLI or one of the Amazon Web Services SDKs

          The value that you want WAF to search for. The SDK automatically base64 encodes the value.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

        • PositionalConstraint (string) -- [REQUIRED]

          The area within the portion of the web request that you want WAF to search for SearchString . Valid values include the following:

          CONTAINS

          The specified part of the web request must include the value of SearchString , but the location doesn't matter.

          CONTAINS_WORD

          The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:

          • SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and ;BadBot .

          • SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot; .

          EXACTLY

          The value of the specified part of the web request must exactly match the value of SearchString .

          STARTS_WITH

          The value of SearchString must appear at the beginning of the specified part of the web request.

          ENDS_WITH

          The value of SearchString must appear at the end of the specified part of the web request.

      • SqliMatchStatement (dict) --

        A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

        • SensitivityLevel (string) --

          The sensitivity that you want WAF to use to inspect for SQL injection attacks.

          HIGH detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the WAF Developer Guide .

          LOW is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.

          Default: LOW

      • XssMatchStatement (dict) --

        A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

      • SizeConstraintStatement (dict) --

        A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

        If you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.

        If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • ComparisonOperator (string) -- [REQUIRED]

          The operator to use to compare the request part to the size setting.

        • Size (integer) -- [REQUIRED]

          The size, in byte, to compare to the request part, after any transformations.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

      • GeoMatchStatement (dict) --

        A rule statement used to identify web requests based on country of origin.

        • CountryCodes (list) --

          An array of two-character country codes, for example, [ "US", "CN" ] , from the alpha-2 country ISO codes of the ISO 3166 international standard.

          • (string) --

        • ForwardedIPConfig (dict) --

          The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

          Note

          If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • HeaderName (string) -- [REQUIRED]

            The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For .

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • FallbackBehavior (string) -- [REQUIRED]

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

            You can specify the following fallback behaviors:

            • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

      • RuleGroupReferenceStatement (dict) --

        A rule statement used to run the rules that are defined in a RuleGroup . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

        You cannot nest a RuleGroupReferenceStatement , for example for use inside a NotStatement or OrStatement . You can only use a rule group reference statement at the top level inside a web ACL.

        • ARN (string) -- [REQUIRED]

          The Amazon Resource Name (ARN) of the entity.

        • ExcludedRules (list) --

          Rules in the referenced rule group whose actions are set to Count .

          Note

          Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

          • (dict) --

            Specifies a single rule in a rule group whose action you want to override to Count .

            Note

            Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

            • Name (string) -- [REQUIRED]

              The name of the rule whose action you want to override to Count .

        • RuleActionOverrides (list) --

          Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

          You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

          • (dict) --

            Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

            You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

            • Name (string) -- [REQUIRED]

              The name of the rule to override.

            • ActionToUse (dict) -- [REQUIRED]

              The override action to use, in place of the configured action of the rule in the rule group.

              • Block (dict) --

                Instructs WAF to block the web request.

                • CustomResponse (dict) --

                  Defines a custom response for the web request.

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

                  • ResponseCode (integer) -- [REQUIRED]

                    The HTTP status code to return to the client.

                    For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide .

                  • CustomResponseBodyKey (string) --

                    References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

                  • ResponseHeaders (list) --

                    The HTTP headers to use in the response. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Allow (dict) --

                Instructs WAF to allow the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Count (dict) --

                Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Captcha (dict) --

                Instructs WAF to run a CAPTCHA check against the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Challenge (dict) --

                Instructs WAF to run a Challenge check against the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

      • IPSetReferenceStatement (dict) --

        A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet .

        Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

        • ARN (string) -- [REQUIRED]

          The Amazon Resource Name (ARN) of the IPSet that this statement references.

        • IPSetForwardedIPConfig (dict) --

          The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

          Note

          If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • HeaderName (string) -- [REQUIRED]

            The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For .

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • FallbackBehavior (string) -- [REQUIRED]

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

            You can specify the following fallback behaviors:

            • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

          • Position (string) -- [REQUIRED]

            The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

            The options for this setting are the following:

            • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

            • LAST - Inspect the last IP address in the list of IP addresses in the header.

            • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.

      • RegexPatternSetReferenceStatement (dict) --

        A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet .

        Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

        • ARN (string) -- [REQUIRED]

          The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

      • RateBasedStatement (dict) --

        A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

        WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

        When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.

        You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

        • An IP match statement with an IP set that specified the address 192.0.2.44.

        • A string match statement that searches in the User-Agent header for the string BadBot.

        In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.

        You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement . You can define a RateBasedStatement inside a web ACL and inside a rule group.

        • Limit (integer) -- [REQUIRED]

          The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement , this limit is applied only to the requests that match the statement.

        • AggregateKeyType (string) -- [REQUIRED]

          Setting that indicates how to aggregate the request counts. The options are the following:

          • IP - Aggregate the request counts on the IP address from the web request origin.

          • FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig , to specify the header to use.

        • ScopeDownStatement (dict) --

          An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement. Requests are only tracked by the rate-based statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

        • ForwardedIPConfig (dict) --

          The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

          Note

          If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          This is required if AggregateKeyType is set to FORWARDED_IP .

          • HeaderName (string) -- [REQUIRED]

            The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For .

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • FallbackBehavior (string) -- [REQUIRED]

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

            You can specify the following fallback behaviors:

            • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

      • AndStatement (dict) --

        A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement .

        • Statements (list) -- [REQUIRED]

          The statements to combine with AND logic. You can use any statements that can be nested.

          • (dict) --

            The processing guidance for a Rule , used by WAF to determine whether a web request matches the rule.

            For example specifications, see the examples section of CreateWebACL .

      • OrStatement (dict) --

        A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement .

        • Statements (list) -- [REQUIRED]

          The statements to combine with OR logic. You can use any statements that can be nested.

          • (dict) --

            The processing guidance for a Rule , used by WAF to determine whether a web request matches the rule.

            For example specifications, see the examples section of CreateWebACL .

      • NotStatement (dict) --

        A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement .

        • Statement (dict) --

          The statement to negate. You can use any statement that can be nested.

      • ManagedRuleGroupStatement (dict) --

        A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups .

        You cannot nest a ManagedRuleGroupStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.

        Note

        You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet . For more information, see WAF Pricing .

        • VendorName (string) -- [REQUIRED]

          The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

        • Name (string) -- [REQUIRED]

          The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

        • Version (string) --

          The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

        • ExcludedRules (list) --

          Rules in the referenced rule group whose actions are set to Count .

          Note

          Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

          • (dict) --

            Specifies a single rule in a rule group whose action you want to override to Count .

            Note

            Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

            • Name (string) -- [REQUIRED]

              The name of the rule whose action you want to override to Count .

        • ScopeDownStatement (dict) --

          An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

        • ManagedRuleGroupConfigs (list) --

          Additional information that's used by a managed rule group. Many managed rule groups don't require this.

          Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

          • (dict) --

            Additional information that's used by a managed rule group. Many managed rule groups don't require this.

            Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

            For example specifications, see the examples section of CreateWebACL .

            • LoginPath (string) --

              The path of the login endpoint for your application. For example, for the URL https://example.com/web/login , you would provide the path /web/login .

            • PayloadType (string) --

              The payload type for your login endpoint, either JSON or form encoded.

            • UsernameField (dict) --

              Details about your login page username field.

              • Identifier (string) -- [REQUIRED]

                The name of the username field. For example /form/username .

            • PasswordField (dict) --

              Details about your login page password field.

              • Identifier (string) -- [REQUIRED]

                The name of the password field. For example /form/password .

            • AWSManagedRulesBotControlRuleSet (dict) --

              Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide .

              • InspectionLevel (string) -- [REQUIRED]

                The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group .

        • RuleActionOverrides (list) --

          Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

          You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

          • (dict) --

            Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

            You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

            • Name (string) -- [REQUIRED]

              The name of the rule to override.

            • ActionToUse (dict) -- [REQUIRED]

              The override action to use, in place of the configured action of the rule in the rule group.

              • Block (dict) --

                Instructs WAF to block the web request.

                • CustomResponse (dict) --

                  Defines a custom response for the web request.

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

                  • ResponseCode (integer) -- [REQUIRED]

                    The HTTP status code to return to the client.

                    For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide .

                  • CustomResponseBodyKey (string) --

                    References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

                  • ResponseHeaders (list) --

                    The HTTP headers to use in the response. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Allow (dict) --

                Instructs WAF to allow the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Count (dict) --

                Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Captcha (dict) --

                Instructs WAF to run a CAPTCHA check against the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Challenge (dict) --

                Instructs WAF to run a Challenge check against the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

      • LabelMatchStatement (dict) --

        A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.

        The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

        • Scope (string) -- [REQUIRED]

          Specify whether you want to match using the label name or just the namespace.

        • Key (string) -- [REQUIRED]

          The string to match against. The setting you provide for this depends on the match statement's Scope setting:

          • If the Scope indicates LABEL , then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name.

          • If the Scope indicates NAMESPACE , then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.

          Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name .

      • RegexMatchStatement (dict) --

        A rule statement used to search web request components for a match against a single regular expression.

        • RegexString (string) -- [REQUIRED]

          The string representing the regular expression.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

    • Action (dict) --

      The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

      This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement .

      You must specify either this Action setting or the rule OverrideAction setting, but not both:

      • If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.

      • If the rule statement references a rule group, use the override action setting and not this action setting.

      • Block (dict) --

        Instructs WAF to block the web request.

        • CustomResponse (dict) --

          Defines a custom response for the web request.

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

          • ResponseCode (integer) -- [REQUIRED]

            The HTTP status code to return to the client.

            For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide .

          • CustomResponseBodyKey (string) --

            References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

          • ResponseHeaders (list) --

            The HTTP headers to use in the response. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • Allow (dict) --

        Instructs WAF to allow the web request.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • Count (dict) --

        Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • Captcha (dict) --

        Instructs WAF to run a CAPTCHA check against the web request.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • Challenge (dict) --

        Instructs WAF to run a Challenge check against the web request.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

    • OverrideAction (dict) --

      The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

      You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement .

      Note

      This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

      • Count (dict) --

        Override the rule group evaluation result to count only.

        Note

        This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • None (dict) --

        Don't override the rule group evaluation result. This is the most common setting.

    • RuleLabels (list) --

      Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

      Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement .

      For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:

      • Separate each component of the label with a colon.

      • Each namespace or name can have up to 128 characters.

      • You can specify up to 5 namespaces in a label.

      • Don't use the following reserved words in your label specification: aws , waf , managed , rulegroup , webacl , regexpatternset , or ipset .

      For example, myLabelName or nameSpace1:nameSpace2:myLabelName .

      • (dict) --

        A single label container. This is used as an element of a label array in multiple contexts, for example, in RuleLabels inside a Rule and in Labels inside a SampledHTTPRequest .

        • Name (string) -- [REQUIRED]

          The label string.

    • VisibilityConfig (dict) -- [REQUIRED]

      Defines and enables Amazon CloudWatch metrics and web request sample collection.

      • SampledRequestsEnabled (boolean) -- [REQUIRED]

        A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

      • CloudWatchMetricsEnabled (boolean) -- [REQUIRED]

        A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics .

      • MetricName (string) -- [REQUIRED]

        A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for WAF, for example All and Default_Action .

    • CaptchaConfig (dict) --

      Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.

      • ImmunityTimeProperty (dict) --

        Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.

        • ImmunityTime (integer) -- [REQUIRED]

          The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

          For the Challenge action, the minimum setting is 300.

    • ChallengeConfig (dict) --

      Specifies how WAF should handle Challenge evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL.

      • ImmunityTimeProperty (dict) --

        Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.

        • ImmunityTime (integer) -- [REQUIRED]

          The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

          For the Challenge action, the minimum setting is 300.

type VisibilityConfig

dict

param VisibilityConfig

[REQUIRED]

Defines and enables Amazon CloudWatch metrics and web request sample collection.

  • SampledRequestsEnabled (boolean) -- [REQUIRED]

    A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

  • CloudWatchMetricsEnabled (boolean) -- [REQUIRED]

    A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics .

  • MetricName (string) -- [REQUIRED]

    A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for WAF, for example All and Default_Action .

type Tags

list

param Tags

An array of key:value pairs to associate with the resource.

  • (dict) --

    A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

    You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.

    • Key (string) -- [REQUIRED]

      Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

    • Value (string) -- [REQUIRED]

      Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

type CustomResponseBodies

dict

param CustomResponseBodies

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 rule group, and then use them in the rules that you define in the rule group.

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

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

  • (string) --

    • (dict) --

      The response body to use in a custom response to a web request. This is referenced by key from CustomResponse CustomResponseBodyKey .

      • ContentType (string) -- [REQUIRED]

        The type of content in the payload that you are defining in the Content string.

      • Content (string) -- [REQUIRED]

        The payload of the custom response.

        You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting.

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

rtype

dict

returns

Response Syntax

{
    'Summary': {
        'Name': 'string',
        'Id': 'string',
        'Description': 'string',
        'LockToken': 'string',
        'ARN': 'string'
    }
}

Response Structure

  • (dict) --

    • Summary (dict) --

      High-level information about a RuleGroup , returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup , and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule .

      • Name (string) --

        The name of the data type instance. You cannot change the name after you create the instance.

      • Id (string) --

        A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

      • Description (string) --

        A description of the rule group that helps with identification.

      • LockToken (string) --

        A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete . WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException . If this happens, perform another get , and use the new token returned by that operation.

      • ARN (string) --

        The Amazon Resource Name (ARN) of the entity.

CreateWebACL (updated) Link ¶
Changes (request)
{'ChallengeConfig': {'ImmunityTimeProperty': {'ImmunityTime': 'long'}},
 'Rules': {'Action': {'Challenge': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                 'Value': 'string'}]}}},
           'ChallengeConfig': {'ImmunityTimeProperty': {'ImmunityTime': 'long'}},
           'Statement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesBotControlRuleSet': {'InspectionLevel': 'COMMON '
                                                                                                                                           '| '
                                                                                                                                           'TARGETED'}},
                                                       'RuleActionOverrides': [{'ActionToUse': {'Allow': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                       'Value': 'string'}]}},
                                                                                                'Block': {'CustomResponse': {'CustomResponseBodyKey': 'string',
                                                                                                                             'ResponseCode': 'integer',
                                                                                                                             'ResponseHeaders': [{'Name': 'string',
                                                                                                                                                  'Value': 'string'}]}},
                                                                                                'Captcha': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                         'Value': 'string'}]}},
                                                                                                'Challenge': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                           'Value': 'string'}]}},
                                                                                                'Count': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                       'Value': 'string'}]}}},
                                                                                'Name': 'string'}]},
                         'RuleGroupReferenceStatement': {'RuleActionOverrides': [{'ActionToUse': {'Allow': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                         'Value': 'string'}]}},
                                                                                                  'Block': {'CustomResponse': {'CustomResponseBodyKey': 'string',
                                                                                                                               'ResponseCode': 'integer',
                                                                                                                               'ResponseHeaders': [{'Name': 'string',
                                                                                                                                                    'Value': 'string'}]}},
                                                                                                  'Captcha': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                           'Value': 'string'}]}},
                                                                                                  'Challenge': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                             'Value': 'string'}]}},
                                                                                                  'Count': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                         'Value': 'string'}]}}},
                                                                                  'Name': 'string'}]}}},
 'TokenDomains': ['string']}

Creates a WebACL per the specifications provided.

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, an AppSync GraphQL API, or an Amazon Cognito user pool.

See also: AWS API Documentation

Request Syntax

client.create_web_acl(
    Name='string',
    Scope='CLOUDFRONT'|'REGIONAL',
    DefaultAction={
        'Block': {
            'CustomResponse': {
                'ResponseCode': 123,
                'CustomResponseBodyKey': 'string',
                'ResponseHeaders': [
                    {
                        'Name': 'string',
                        'Value': 'string'
                    },
                ]
            }
        },
        'Allow': {
            'CustomRequestHandling': {
                'InsertHeaders': [
                    {
                        'Name': 'string',
                        'Value': 'string'
                    },
                ]
            }
        }
    },
    Description='string',
    Rules=[
        {
            'Name': 'string',
            'Priority': 123,
            'Statement': {
                'ByteMatchStatement': {
                    'SearchString': b'bytes',
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ],
                    'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
                },
                'SqliMatchStatement': {
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ],
                    'SensitivityLevel': 'LOW'|'HIGH'
                },
                'XssMatchStatement': {
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ]
                },
                'SizeConstraintStatement': {
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
                    'Size': 123,
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ]
                },
                'GeoMatchStatement': {
                    'CountryCodes': [
                        'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK',
                    ],
                    'ForwardedIPConfig': {
                        'HeaderName': 'string',
                        'FallbackBehavior': 'MATCH'|'NO_MATCH'
                    }
                },
                'RuleGroupReferenceStatement': {
                    'ARN': 'string',
                    'ExcludedRules': [
                        {
                            'Name': 'string'
                        },
                    ],
                    'RuleActionOverrides': [
                        {
                            'Name': 'string',
                            'ActionToUse': {
                                'Block': {
                                    'CustomResponse': {
                                        'ResponseCode': 123,
                                        'CustomResponseBodyKey': 'string',
                                        'ResponseHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Allow': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Count': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Captcha': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Challenge': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                }
                            }
                        },
                    ]
                },
                'IPSetReferenceStatement': {
                    'ARN': 'string',
                    'IPSetForwardedIPConfig': {
                        'HeaderName': 'string',
                        'FallbackBehavior': 'MATCH'|'NO_MATCH',
                        'Position': 'FIRST'|'LAST'|'ANY'
                    }
                },
                'RegexPatternSetReferenceStatement': {
                    'ARN': 'string',
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ]
                },
                'RateBasedStatement': {
                    'Limit': 123,
                    'AggregateKeyType': 'IP'|'FORWARDED_IP',
                    'ScopeDownStatement': {'... recursive ...'},
                    'ForwardedIPConfig': {
                        'HeaderName': 'string',
                        'FallbackBehavior': 'MATCH'|'NO_MATCH'
                    }
                },
                'AndStatement': {
                    'Statements': [
                        {'... recursive ...'},
                    ]
                },
                'OrStatement': {
                    'Statements': [
                        {'... recursive ...'},
                    ]
                },
                'NotStatement': {
                    'Statement': {'... recursive ...'}
                },
                'ManagedRuleGroupStatement': {
                    'VendorName': 'string',
                    'Name': 'string',
                    'Version': 'string',
                    'ExcludedRules': [
                        {
                            'Name': 'string'
                        },
                    ],
                    'ScopeDownStatement': {'... recursive ...'},
                    'ManagedRuleGroupConfigs': [
                        {
                            'LoginPath': 'string',
                            'PayloadType': 'JSON'|'FORM_ENCODED',
                            'UsernameField': {
                                'Identifier': 'string'
                            },
                            'PasswordField': {
                                'Identifier': 'string'
                            },
                            'AWSManagedRulesBotControlRuleSet': {
                                'InspectionLevel': 'COMMON'|'TARGETED'
                            }
                        },
                    ],
                    'RuleActionOverrides': [
                        {
                            'Name': 'string',
                            'ActionToUse': {
                                'Block': {
                                    'CustomResponse': {
                                        'ResponseCode': 123,
                                        'CustomResponseBodyKey': 'string',
                                        'ResponseHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Allow': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Count': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Captcha': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'Challenge': {
                                    'CustomRequestHandling': {
                                        'InsertHeaders': [
                                            {
                                                'Name': 'string',
                                                'Value': 'string'
                                            },
                                        ]
                                    }
                                }
                            }
                        },
                    ]
                },
                'LabelMatchStatement': {
                    'Scope': 'LABEL'|'NAMESPACE',
                    'Key': 'string'
                },
                'RegexMatchStatement': {
                    'RegexString': 'string',
                    'FieldToMatch': {
                        'SingleHeader': {
                            'Name': 'string'
                        },
                        'SingleQueryArgument': {
                            'Name': 'string'
                        },
                        'AllQueryArguments': {}
                        ,
                        'UriPath': {}
                        ,
                        'QueryString': {}
                        ,
                        'Body': {
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Method': {}
                        ,
                        'JsonBody': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedPaths': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Headers': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedHeaders': [
                                    'string',
                                ],
                                'ExcludedHeaders': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        },
                        'Cookies': {
                            'MatchPattern': {
                                'All': {}
                                ,
                                'IncludedCookies': [
                                    'string',
                                ],
                                'ExcludedCookies': [
                                    'string',
                                ]
                            },
                            'MatchScope': 'ALL'|'KEY'|'VALUE',
                            'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                        }
                    },
                    'TextTransformations': [
                        {
                            'Priority': 123,
                            'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                        },
                    ]
                }
            },
            'Action': {
                'Block': {
                    'CustomResponse': {
                        'ResponseCode': 123,
                        'CustomResponseBodyKey': 'string',
                        'ResponseHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Allow': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Count': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Captcha': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Challenge': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                }
            },
            'OverrideAction': {
                'Count': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'None': {}

            },
            'RuleLabels': [
                {
                    'Name': 'string'
                },
            ],
            'VisibilityConfig': {
                'SampledRequestsEnabled': True|False,
                'CloudWatchMetricsEnabled': True|False,
                'MetricName': 'string'
            },
            'CaptchaConfig': {
                'ImmunityTimeProperty': {
                    'ImmunityTime': 123
                }
            },
            'ChallengeConfig': {
                'ImmunityTimeProperty': {
                    'ImmunityTime': 123
                }
            }
        },
    ],
    VisibilityConfig={
        'SampledRequestsEnabled': True|False,
        'CloudWatchMetricsEnabled': True|False,
        'MetricName': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    CustomResponseBodies={
        'string': {
            'ContentType': 'TEXT_PLAIN'|'TEXT_HTML'|'APPLICATION_JSON',
            'Content': 'string'
        }
    },
    CaptchaConfig={
        'ImmunityTimeProperty': {
            'ImmunityTime': 123
        }
    },
    ChallengeConfig={
        'ImmunityTimeProperty': {
            'ImmunityTime': 123
        }
    },
    TokenDomains=[
        'string',
    ]
)
type Name

string

param Name

[REQUIRED]

The name of the web ACL. You cannot change the name of a web ACL after you create it.

type Scope

string

param Scope

[REQUIRED]

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1 .

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

type DefaultAction

dict

param DefaultAction

[REQUIRED]

The action to perform if none of the Rules contained in the WebACL match.

  • Block (dict) --

    Specifies that WAF should block requests by default.

    • CustomResponse (dict) --

      Defines a custom response for the web request.

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

      • ResponseCode (integer) -- [REQUIRED]

        The HTTP status code to return to the client.

        For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide .

      • CustomResponseBodyKey (string) --

        References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

      • ResponseHeaders (list) --

        The HTTP headers to use in the response. Duplicate header names are not allowed.

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

        • (dict) --

          A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

          • Name (string) -- [REQUIRED]

            The name of the custom header.

            For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

          • Value (string) -- [REQUIRED]

            The value of the custom header.

  • Allow (dict) --

    Specifies that WAF should allow requests by default.

    • CustomRequestHandling (dict) --

      Defines custom handling for the web request.

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

      • InsertHeaders (list) -- [REQUIRED]

        The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

        • (dict) --

          A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

          • Name (string) -- [REQUIRED]

            The name of the custom header.

            For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

          • Value (string) -- [REQUIRED]

            The value of the custom header.

type Description

string

param Description

A description of the web ACL that helps with identification.

type Rules

list

param 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.

  • (dict) --

    A single rule, which you can use in a WebACL or RuleGroup to identify 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.

    • Name (string) -- [REQUIRED]

      The name of the rule. You can't change the name of a Rule after you create it.

    • Priority (integer) -- [REQUIRED]

      If you define more than one Rule in a WebACL , WAF evaluates each request against the Rules in order based on the value of Priority . WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

    • Statement (dict) -- [REQUIRED]

      The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .

      • ByteMatchStatement (dict) --

        A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

        • SearchString (bytes) -- [REQUIRED]

          A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 50 bytes.

          Valid values depend on the component that you specify for inspection in FieldToMatch :

          • Method : The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request.

          • UriPath : The value that you want WAF to search for in the URI path, for example, /images/daily-ad.jpg .

          If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

          If you're using the WAF API

          Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

          For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90 , in the value of SearchString .

          If you're using the CLI or one of the Amazon Web Services SDKs

          The value that you want WAF to search for. The SDK automatically base64 encodes the value.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

        • PositionalConstraint (string) -- [REQUIRED]

          The area within the portion of the web request that you want WAF to search for SearchString . Valid values include the following:

          CONTAINS

          The specified part of the web request must include the value of SearchString , but the location doesn't matter.

          CONTAINS_WORD

          The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:

          • SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and ;BadBot .

          • SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot; .

          EXACTLY

          The value of the specified part of the web request must exactly match the value of SearchString .

          STARTS_WITH

          The value of SearchString must appear at the beginning of the specified part of the web request.

          ENDS_WITH

          The value of SearchString must appear at the end of the specified part of the web request.

      • SqliMatchStatement (dict) --

        A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

        • SensitivityLevel (string) --

          The sensitivity that you want WAF to use to inspect for SQL injection attacks.

          HIGH detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the WAF Developer Guide .

          LOW is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.

          Default: LOW

      • XssMatchStatement (dict) --

        A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

      • SizeConstraintStatement (dict) --

        A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

        If you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.

        If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • ComparisonOperator (string) -- [REQUIRED]

          The operator to use to compare the request part to the size setting.

        • Size (integer) -- [REQUIRED]

          The size, in byte, to compare to the request part, after any transformations.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

      • GeoMatchStatement (dict) --

        A rule statement used to identify web requests based on country of origin.

        • CountryCodes (list) --

          An array of two-character country codes, for example, [ "US", "CN" ] , from the alpha-2 country ISO codes of the ISO 3166 international standard.

          • (string) --

        • ForwardedIPConfig (dict) --

          The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

          Note

          If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • HeaderName (string) -- [REQUIRED]

            The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For .

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • FallbackBehavior (string) -- [REQUIRED]

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

            You can specify the following fallback behaviors:

            • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

      • RuleGroupReferenceStatement (dict) --

        A rule statement used to run the rules that are defined in a RuleGroup . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

        You cannot nest a RuleGroupReferenceStatement , for example for use inside a NotStatement or OrStatement . You can only use a rule group reference statement at the top level inside a web ACL.

        • ARN (string) -- [REQUIRED]

          The Amazon Resource Name (ARN) of the entity.

        • ExcludedRules (list) --

          Rules in the referenced rule group whose actions are set to Count .

          Note

          Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

          • (dict) --

            Specifies a single rule in a rule group whose action you want to override to Count .

            Note

            Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

            • Name (string) -- [REQUIRED]

              The name of the rule whose action you want to override to Count .

        • RuleActionOverrides (list) --

          Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

          You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

          • (dict) --

            Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

            You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

            • Name (string) -- [REQUIRED]

              The name of the rule to override.

            • ActionToUse (dict) -- [REQUIRED]

              The override action to use, in place of the configured action of the rule in the rule group.

              • Block (dict) --

                Instructs WAF to block the web request.

                • CustomResponse (dict) --

                  Defines a custom response for the web request.

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

                  • ResponseCode (integer) -- [REQUIRED]

                    The HTTP status code to return to the client.

                    For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide .

                  • CustomResponseBodyKey (string) --

                    References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

                  • ResponseHeaders (list) --

                    The HTTP headers to use in the response. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Allow (dict) --

                Instructs WAF to allow the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Count (dict) --

                Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Captcha (dict) --

                Instructs WAF to run a CAPTCHA check against the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Challenge (dict) --

                Instructs WAF to run a Challenge check against the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

      • IPSetReferenceStatement (dict) --

        A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet .

        Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

        • ARN (string) -- [REQUIRED]

          The Amazon Resource Name (ARN) of the IPSet that this statement references.

        • IPSetForwardedIPConfig (dict) --

          The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

          Note

          If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • HeaderName (string) -- [REQUIRED]

            The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For .

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • FallbackBehavior (string) -- [REQUIRED]

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

            You can specify the following fallback behaviors:

            • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

          • Position (string) -- [REQUIRED]

            The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

            The options for this setting are the following:

            • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

            • LAST - Inspect the last IP address in the list of IP addresses in the header.

            • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.

      • RegexPatternSetReferenceStatement (dict) --

        A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet .

        Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

        • ARN (string) -- [REQUIRED]

          The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

      • RateBasedStatement (dict) --

        A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

        WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

        When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.

        You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

        • An IP match statement with an IP set that specified the address 192.0.2.44.

        • A string match statement that searches in the User-Agent header for the string BadBot.

        In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.

        You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement . You can define a RateBasedStatement inside a web ACL and inside a rule group.

        • Limit (integer) -- [REQUIRED]

          The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement , this limit is applied only to the requests that match the statement.

        • AggregateKeyType (string) -- [REQUIRED]

          Setting that indicates how to aggregate the request counts. The options are the following:

          • IP - Aggregate the request counts on the IP address from the web request origin.

          • FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig , to specify the header to use.

        • ScopeDownStatement (dict) --

          An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement. Requests are only tracked by the rate-based statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

        • ForwardedIPConfig (dict) --

          The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

          Note

          If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          This is required if AggregateKeyType is set to FORWARDED_IP .

          • HeaderName (string) -- [REQUIRED]

            The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For .

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

          • FallbackBehavior (string) -- [REQUIRED]

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note

            If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

            You can specify the following fallback behaviors:

            • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

      • AndStatement (dict) --

        A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement .

        • Statements (list) -- [REQUIRED]

          The statements to combine with AND logic. You can use any statements that can be nested.

          • (dict) --

            The processing guidance for a Rule , used by WAF to determine whether a web request matches the rule.

            For example specifications, see the examples section of CreateWebACL .

      • OrStatement (dict) --

        A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement .

        • Statements (list) -- [REQUIRED]

          The statements to combine with OR logic. You can use any statements that can be nested.

          • (dict) --

            The processing guidance for a Rule , used by WAF to determine whether a web request matches the rule.

            For example specifications, see the examples section of CreateWebACL .

      • NotStatement (dict) --

        A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement .

        • Statement (dict) --

          The statement to negate. You can use any statement that can be nested.

      • ManagedRuleGroupStatement (dict) --

        A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups .

        You cannot nest a ManagedRuleGroupStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.

        Note

        You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet . For more information, see WAF Pricing .

        • VendorName (string) -- [REQUIRED]

          The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

        • Name (string) -- [REQUIRED]

          The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

        • Version (string) --

          The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

        • ExcludedRules (list) --

          Rules in the referenced rule group whose actions are set to Count .

          Note

          Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

          • (dict) --

            Specifies a single rule in a rule group whose action you want to override to Count .

            Note

            Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

            • Name (string) -- [REQUIRED]

              The name of the rule whose action you want to override to Count .

        • ScopeDownStatement (dict) --

          An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

        • ManagedRuleGroupConfigs (list) --

          Additional information that's used by a managed rule group. Many managed rule groups don't require this.

          Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

          • (dict) --

            Additional information that's used by a managed rule group. Many managed rule groups don't require this.

            Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

            For example specifications, see the examples section of CreateWebACL .

            • LoginPath (string) --

              The path of the login endpoint for your application. For example, for the URL https://example.com/web/login , you would provide the path /web/login .

            • PayloadType (string) --

              The payload type for your login endpoint, either JSON or form encoded.

            • UsernameField (dict) --

              Details about your login page username field.

              • Identifier (string) -- [REQUIRED]

                The name of the username field. For example /form/username .

            • PasswordField (dict) --

              Details about your login page password field.

              • Identifier (string) -- [REQUIRED]

                The name of the password field. For example /form/password .

            • AWSManagedRulesBotControlRuleSet (dict) --

              Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide .

              • InspectionLevel (string) -- [REQUIRED]

                The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group .

        • RuleActionOverrides (list) --

          Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

          You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

          • (dict) --

            Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

            You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

            • Name (string) -- [REQUIRED]

              The name of the rule to override.

            • ActionToUse (dict) -- [REQUIRED]

              The override action to use, in place of the configured action of the rule in the rule group.

              • Block (dict) --

                Instructs WAF to block the web request.

                • CustomResponse (dict) --

                  Defines a custom response for the web request.

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

                  • ResponseCode (integer) -- [REQUIRED]

                    The HTTP status code to return to the client.

                    For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide .

                  • CustomResponseBodyKey (string) --

                    References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

                  • ResponseHeaders (list) --

                    The HTTP headers to use in the response. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Allow (dict) --

                Instructs WAF to allow the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Count (dict) --

                Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Captcha (dict) --

                Instructs WAF to run a CAPTCHA check against the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

              • Challenge (dict) --

                Instructs WAF to run a Challenge check against the web request.

                • CustomRequestHandling (dict) --

                  Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

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

                  • InsertHeaders (list) -- [REQUIRED]

                    The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                    • (dict) --

                      A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                      • Name (string) -- [REQUIRED]

                        The name of the custom header.

                        For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                      • Value (string) -- [REQUIRED]

                        The value of the custom header.

      • LabelMatchStatement (dict) --

        A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.

        The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

        • Scope (string) -- [REQUIRED]

          Specify whether you want to match using the label name or just the namespace.

        • Key (string) -- [REQUIRED]

          The string to match against. The setting you provide for this depends on the match statement's Scope setting:

          • If the Scope indicates LABEL , then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name.

          • If the Scope indicates NAMESPACE , then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.

          Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name .

      • RegexMatchStatement (dict) --

        A rule statement used to search web request components for a match against a single regular expression.

        • RegexString (string) -- [REQUIRED]

          The string representing the regular expression.

        • FieldToMatch (dict) -- [REQUIRED]

          The part of the web request that you want WAF to inspect.

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) -- [REQUIRED]

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) -- [REQUIRED]

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) -- [REQUIRED]

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) -- [REQUIRED]

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) -- [REQUIRED]

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) -- [REQUIRED]

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

        • TextTransformations (list) -- [REQUIRED]

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

          • (dict) --

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

            • Priority (integer) -- [REQUIRED]

              Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

            • Type (string) -- [REQUIRED]

              You can specify the following transformation types:

              BASE64_DECODE - Decode a Base64 -encoded string.

              BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

              CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

              • \f , formfeed, decimal 12

              • \t , tab, decimal 9

              • \n , newline, decimal 10

              • \r , carriage return, decimal 13

              • \v , vertical tab, decimal 11

              • Non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

              ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

              HEX_DECODE - Decode a string of hexadecimal characters into a binary.

              HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

              JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

              LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

              MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

              NONE - Specify NONE if you don't want any text transformations.

              NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

              NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

              REMOVE_NULLS - Remove all NULL bytes from the input.

              REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

              REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

              SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

              URL_DECODE - Decode a URL-encoded value.

              URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

              UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

    • Action (dict) --

      The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

      This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement .

      You must specify either this Action setting or the rule OverrideAction setting, but not both:

      • If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.

      • If the rule statement references a rule group, use the override action setting and not this action setting.

      • Block (dict) --

        Instructs WAF to block the web request.

        • CustomResponse (dict) --

          Defines a custom response for the web request.

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

          • ResponseCode (integer) -- [REQUIRED]

            The HTTP status code to return to the client.

            For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide .

          • CustomResponseBodyKey (string) --

            References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

          • ResponseHeaders (list) --

            The HTTP headers to use in the response. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • Allow (dict) --

        Instructs WAF to allow the web request.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • Count (dict) --

        Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • Captcha (dict) --

        Instructs WAF to run a CAPTCHA check against the web request.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • Challenge (dict) --

        Instructs WAF to run a Challenge check against the web request.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

    • OverrideAction (dict) --

      The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

      You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement .

      Note

      This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

      • Count (dict) --

        Override the rule group evaluation result to count only.

        Note

        This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

        • CustomRequestHandling (dict) --

          Defines custom handling for the web request.

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

          • InsertHeaders (list) -- [REQUIRED]

            The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

            • (dict) --

              A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

              • Name (string) -- [REQUIRED]

                The name of the custom header.

                For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

              • Value (string) -- [REQUIRED]

                The value of the custom header.

      • None (dict) --

        Don't override the rule group evaluation result. This is the most common setting.

    • RuleLabels (list) --

      Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

      Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement .

      For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:

      • Separate each component of the label with a colon.

      • Each namespace or name can have up to 128 characters.

      • You can specify up to 5 namespaces in a label.

      • Don't use the following reserved words in your label specification: aws , waf , managed , rulegroup , webacl , regexpatternset , or ipset .

      For example, myLabelName or nameSpace1:nameSpace2:myLabelName .

      • (dict) --

        A single label container. This is used as an element of a label array in multiple contexts, for example, in RuleLabels inside a Rule and in Labels inside a SampledHTTPRequest .

        • Name (string) -- [REQUIRED]

          The label string.

    • VisibilityConfig (dict) -- [REQUIRED]

      Defines and enables Amazon CloudWatch metrics and web request sample collection.

      • SampledRequestsEnabled (boolean) -- [REQUIRED]

        A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

      • CloudWatchMetricsEnabled (boolean) -- [REQUIRED]

        A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics .

      • MetricName (string) -- [REQUIRED]

        A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for WAF, for example All and Default_Action .

    • CaptchaConfig (dict) --

      Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.

      • ImmunityTimeProperty (dict) --

        Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.

        • ImmunityTime (integer) -- [REQUIRED]

          The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

          For the Challenge action, the minimum setting is 300.

    • ChallengeConfig (dict) --

      Specifies how WAF should handle Challenge evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL.

      • ImmunityTimeProperty (dict) --

        Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.

        • ImmunityTime (integer) -- [REQUIRED]

          The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

          For the Challenge action, the minimum setting is 300.

type VisibilityConfig

dict

param VisibilityConfig

[REQUIRED]

Defines and enables Amazon CloudWatch metrics and web request sample collection.

  • SampledRequestsEnabled (boolean) -- [REQUIRED]

    A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

  • CloudWatchMetricsEnabled (boolean) -- [REQUIRED]

    A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics .

  • MetricName (string) -- [REQUIRED]

    A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for WAF, for example All and Default_Action .

type Tags

list

param Tags

An array of key:value pairs to associate with the resource.

  • (dict) --

    A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

    You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.

    • Key (string) -- [REQUIRED]

      Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

    • Value (string) -- [REQUIRED]

      Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

type CustomResponseBodies

dict

param CustomResponseBodies

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 in the WAF Developer Guide .

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

  • (string) --

    • (dict) --

      The response body to use in a custom response to a web request. This is referenced by key from CustomResponse CustomResponseBodyKey .

      • ContentType (string) -- [REQUIRED]

        The type of content in the payload that you are defining in the Content string.

      • Content (string) -- [REQUIRED]

        The payload of the custom response.

        You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting.

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

type CaptchaConfig

dict

param CaptchaConfig

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 .

  • ImmunityTimeProperty (dict) --

    Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.

    • ImmunityTime (integer) -- [REQUIRED]

      The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

      For the Challenge action, the minimum setting is 300.

type ChallengeConfig

dict

param ChallengeConfig

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 .

  • ImmunityTimeProperty (dict) --

    Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.

    • ImmunityTime (integer) -- [REQUIRED]

      The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

      For the Challenge action, the minimum setting is 300.

type TokenDomains

list

param TokenDomains

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.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

  • (string) --

rtype

dict

returns

Response Syntax

{
    'Summary': {
        'Name': 'string',
        'Id': 'string',
        'Description': 'string',
        'LockToken': 'string',
        'ARN': 'string'
    }
}

Response Structure

  • (dict) --

    • Summary (dict) --

      High-level information about a WebACL , returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL , and the ARN, that you provide to operations like AssociateWebACL .

      • Name (string) --

        The name of the web ACL. You cannot change the name of a web ACL after you create it.

      • Id (string) --

        The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

      • Description (string) --

        A description of the web ACL that helps with identification.

      • LockToken (string) --

        A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete . WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException . If this happens, perform another get , and use the new token returned by that operation.

      • ARN (string) --

        The Amazon Resource Name (ARN) of the entity.

DescribeManagedRuleGroup (updated) Link ¶
Changes (response)
{'Rules': {'Action': {'Challenge': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                 'Value': 'string'}]}}}}}

Provides high-level information for a managed rule group, including descriptions of the rules.

See also: AWS API Documentation

Request Syntax

client.describe_managed_rule_group(
    VendorName='string',
    Name='string',
    Scope='CLOUDFRONT'|'REGIONAL',
    VersionName='string'
)
type VendorName

string

param VendorName

[REQUIRED]

The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

type Name

string

param Name

[REQUIRED]

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

type Scope

string

param Scope

[REQUIRED]

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1 .

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

type VersionName

string

param VersionName

The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't provide this, WAF uses the vendor's default version.

rtype

dict

returns

Response Syntax

{
    'VersionName': 'string',
    'SnsTopicArn': 'string',
    'Capacity': 123,
    'Rules': [
        {
            'Name': 'string',
            'Action': {
                'Block': {
                    'CustomResponse': {
                        'ResponseCode': 123,
                        'CustomResponseBodyKey': 'string',
                        'ResponseHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Allow': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Count': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Captcha': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Challenge': {
                    'CustomRequestHandling': {
                        'InsertHeaders': [
                            {
                                'Name': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                }
            }
        },
    ],
    'LabelNamespace': 'string',
    'AvailableLabels': [
        {
            'Name': 'string'
        },
    ],
    'ConsumedLabels': [
        {
            'Name': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • VersionName (string) --

      The managed rule group's version.

    • SnsTopicArn (string) --

      The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide .

    • Capacity (integer) --

      The web ACL capacity units (WCUs) required for this rule group. WAF uses web ACL capacity units (WCU) 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 each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

    • Rules (list) --

      • (dict) --

        High-level information about a Rule , returned by operations like DescribeManagedRuleGroup . This provides information like the ID, that you can use to retrieve and manage a RuleGroup , and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule .

        • Name (string) --

          The name of the rule.

        • Action (dict) --

          The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

          • Block (dict) --

            Instructs WAF to block the web request.

            • CustomResponse (dict) --

              Defines a custom response for the web request.

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

              • ResponseCode (integer) --

                The HTTP status code to return to the client.

                For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide .

              • CustomResponseBodyKey (string) --

                References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

              • ResponseHeaders (list) --

                The HTTP headers to use in the response. Duplicate header names are not allowed.

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

                • (dict) --

                  A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                  • Name (string) --

                    The name of the custom header.

                    For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                  • Value (string) --

                    The value of the custom header.

          • Allow (dict) --

            Instructs WAF to allow the web request.

            • CustomRequestHandling (dict) --

              Defines custom handling for the web request.

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

              • InsertHeaders (list) --

                The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                • (dict) --

                  A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                  • Name (string) --

                    The name of the custom header.

                    For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                  • Value (string) --

                    The value of the custom header.

          • Count (dict) --

            Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

            • CustomRequestHandling (dict) --

              Defines custom handling for the web request.

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

              • InsertHeaders (list) --

                The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                • (dict) --

                  A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                  • Name (string) --

                    The name of the custom header.

                    For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                  • Value (string) --

                    The value of the custom header.

          • Captcha (dict) --

            Instructs WAF to run a CAPTCHA check against the web request.

            • CustomRequestHandling (dict) --

              Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

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

              • InsertHeaders (list) --

                The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                • (dict) --

                  A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                  • Name (string) --

                    The name of the custom header.

                    For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                  • Value (string) --

                    The value of the custom header.

          • Challenge (dict) --

            Instructs WAF to run a Challenge check against the web request.

            • CustomRequestHandling (dict) --

              Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

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

              • InsertHeaders (list) --

                The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                • (dict) --

                  A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                  • Name (string) --

                    The name of the custom header.

                    For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                  • Value (string) --

                    The value of the custom header.

    • LabelNamespace (string) --

      The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

      • The syntax for the label namespace prefix for a managed rule group is the following: awswaf:managed:<vendor>:<rule group 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>

    • AvailableLabels (list) --

      The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule .

      • (dict) --

        List of labels used by one or more of the rules of a RuleGroup . This summary object is used for the following rule group lists:

        • AvailableLabels - Labels that rules add to matching requests. These labels are defined in the RuleLabels for a Rule .

        • ConsumedLabels - Labels that rules match against. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

        • Name (string) --

          An individual label specification.

    • ConsumedLabels (list) --

      The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

      • (dict) --

        List of labels used by one or more of the rules of a RuleGroup . This summary object is used for the following rule group lists:

        • AvailableLabels - Labels that rules add to matching requests. These labels are defined in the RuleLabels for a Rule .

        • ConsumedLabels - Labels that rules match against. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

        • Name (string) --

          An individual label specification.

GetLoggingConfiguration (updated) Link ¶
Changes (response)
{'LoggingConfiguration': {'LoggingFilter': {'Filters': {'Conditions': {'ActionCondition': {'Action': {'CHALLENGE'}}}}}}}

Returns the LoggingConfiguration for the specified web ACL.

See also: AWS API Documentation

Request Syntax

client.get_logging_configuration(
    ResourceArn='string'
)
type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration .

rtype

dict

returns

Response Syntax

{
    'LoggingConfiguration': {
        'ResourceArn': 'string',
        'LogDestinationConfigs': [
            'string',
        ],
        'RedactedFields': [
            {
                'SingleHeader': {
                    'Name': 'string'
                },
                'SingleQueryArgument': {
                    'Name': 'string'
                },
                'AllQueryArguments': {},
                'UriPath': {},
                'QueryString': {},
                'Body': {
                    'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                },
                'Method': {},
                'JsonBody': {
                    'MatchPattern': {
                        'All': {},
                        'IncludedPaths': [
                            'string',
                        ]
                    },
                    'MatchScope': 'ALL'|'KEY'|'VALUE',
                    'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                    'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                },
                'Headers': {
                    'MatchPattern': {
                        'All': {},
                        'IncludedHeaders': [
                            'string',
                        ],
                        'ExcludedHeaders': [
                            'string',
                        ]
                    },
                    'MatchScope': 'ALL'|'KEY'|'VALUE',
                    'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                },
                'Cookies': {
                    'MatchPattern': {
                        'All': {},
                        'IncludedCookies': [
                            'string',
                        ],
                        'ExcludedCookies': [
                            'string',
                        ]
                    },
                    'MatchScope': 'ALL'|'KEY'|'VALUE',
                    'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                }
            },
        ],
        'ManagedByFirewallManager': True|False,
        'LoggingFilter': {
            'Filters': [
                {
                    'Behavior': 'KEEP'|'DROP',
                    'Requirement': 'MEETS_ALL'|'MEETS_ANY',
                    'Conditions': [
                        {
                            'ActionCondition': {
                                'Action': 'ALLOW'|'BLOCK'|'COUNT'|'CAPTCHA'|'CHALLENGE'|'EXCLUDED_AS_COUNT'
                            },
                            'LabelNameCondition': {
                                'LabelName': 'string'
                            }
                        },
                    ]
                },
            ],
            'DefaultBehavior': 'KEEP'|'DROP'
        }
    }
}

Response Structure

  • (dict) --

    • LoggingConfiguration (dict) --

      The LoggingConfiguration for the specified web ACL.

      • ResourceArn (string) --

        The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs .

      • LogDestinationConfigs (list) --

        The logging destination configuration that you want to associate with the web ACL.

        Note

        You can associate one logging destination to a web ACL.

        • (string) --

      • RedactedFields (list) --

        The parts of the request that you want to keep out of the logs. For example, if you redact the SingleHeader field, the HEADER field in the logs will be xxx .

        Note

        You can specify only the following fields for redaction: UriPath , QueryString , SingleHeader , Method , and JsonBody .

        • (dict) --

          The part of the web request that you want WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component.

          Example JSON for a QueryString field to match:

          "FieldToMatch": { "QueryString": {} }

          Example JSON for a Method field to match specification:

          "FieldToMatch": { "Method": { "Name": "DELETE" } }

          • SingleHeader (dict) --

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

            Example JSON: "SingleHeader": { "Name": "haystack" }

            Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

            • Name (string) --

              The name of the query header to inspect.

          • SingleQueryArgument (dict) --

            Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

            Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

            • Name (string) --

              The name of the query argument to inspect.

          • AllQueryArguments (dict) --

            Inspect all query arguments.

          • UriPath (dict) --

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

          • QueryString (dict) --

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body (dict) --

            Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Method (dict) --

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody (dict) --

            Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern (dict) --

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All (dict) --

                Match all of the elements. See also MatchScope in JsonBody .

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths (list) --

                Match only the specified include paths. See also MatchScope in JsonBody .

                Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                You must specify either this setting or the All setting, but not both.

                Note

                Don't use this option to include all paths. Instead, use the All setting.

                • (string) --

            • MatchScope (string) --

              The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

            • InvalidFallbackBehavior (string) --

              What WAF should do if it fails to completely parse the JSON body. The options are the following:

              • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

            • OversizeHandling (string) --

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

              Default: CONTINUE

          • Headers (dict) --

            Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern (dict) --

              The filter to use to identify the subset of headers to inspect in a web request.

              You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

              Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

              • All (dict) --

                Inspect all headers.

              • IncludedHeaders (list) --

                Inspect only the headers that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedHeaders (list) --

                Inspect only the headers whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) --

              The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) --

              What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

          • Cookies (dict) --

            Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern (dict) --

              The filter to use to identify the subset of cookies to inspect in a web request.

              You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

              Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All (dict) --

                Inspect all cookies.

              • IncludedCookies (list) --

                Inspect only the cookies that have a key that matches one of the strings specified here.

                • (string) --

              • ExcludedCookies (list) --

                Inspect only the cookies whose keys don't match any of the strings specified here.

                • (string) --

            • MatchScope (string) --

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

            • OversizeHandling (string) --

              What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

      • ManagedByFirewallManager (boolean) --

        Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.

      • LoggingFilter (dict) --

        Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

        • Filters (list) --

          The filters that you want to apply to the logs.

          • (dict) --

            A single logging filter, used in LoggingFilter .

            • Behavior (string) --

              How to handle logs that satisfy the filter's conditions and requirement.

            • Requirement (string) --

              Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

            • Conditions (list) --

              Match conditions for the filter.

              • (dict) --

                A single match condition for a Filter .

                • ActionCondition (dict) --

                  A single action condition. This is the action setting that a log record must contain in order to meet the condition.

                  • Action (string) --

                    The action setting that a log record must contain in order to meet the condition. This is the action that WAF applied to the web request.

                    For rule groups, this is either the configured rule action setting, or if you've applied a rule action override to the rule, it's the override action. The value EXCLUDED_AS_COUNT matches on excluded rules and also on rules that have a rule action override of Count.

                • LabelNameCondition (dict) --

                  A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

                  • LabelName (string) --

                    The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

        • DefaultBehavior (string) --

          Default handling for logs that don't match any of the specified filtering conditions.

GetRuleGroup (updated) Link ¶
Changes (response)
{'RuleGroup': {'Rules': {'Action': {'Challenge': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                               'Value': 'string'}]}}},
                         'ChallengeConfig': {'ImmunityTimeProperty': {'ImmunityTime': 'long'}},
                         'Statement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesBotControlRuleSet': {'InspectionLevel': 'COMMON '
                                                                                                                                                         '| '
                                                                                                                                                         'TARGETED'}},
                                                                     'RuleActionOverrides': [{'ActionToUse': {'Allow': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                                     'Value': 'string'}]}},
                                                                                                              'Block': {'CustomResponse': {'CustomResponseBodyKey': 'string',
                                                                                                                                           'ResponseCode': 'integer',
                                                                                                                                           'ResponseHeaders': [{'Name': 'string',
                                                                                                                                                                'Value': 'string'}]}},
                                                                                                              'Captcha': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                                       'Value': 'string'}]}},
                                                                                                              'Challenge': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                                         'Value': 'string'}]}},
                                                                                                              'Count': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                                     'Value': 'string'}]}}},
                                                                                              'Name': 'string'}]},
                                       'RuleGroupReferenceStatement': {'RuleActionOverrides': [{'ActionToUse': {'Allow': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                                       'Value': 'string'}]}},
                                                                                                                'Block': {'CustomResponse': {'CustomResponseBodyKey': 'string',
                                                                                                                                             'ResponseCode': 'integer',
                                                                                                                                             'ResponseHeaders': [{'Name': 'string',
                                                                                                                                                                  'Value': 'string'}]}},
                                                                                                                'Captcha': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                                         'Value': 'string'}]}},
                                                                                                                'Challenge': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                                           'Value': 'string'}]}},
                                                                                                                'Count': {'CustomRequestHandling': {'InsertHeaders': [{'Name': 'string',
                                                                                                                                                                       'Value': 'string'}]}}},
                                                                                                'Name': 'string'}]}}}}}

Retrieves the specified RuleGroup .

See also: AWS API Documentation

Request Syntax

client.get_rule_group(
    Name='string',
    Scope='CLOUDFRONT'|'REGIONAL',
    Id='string',
    ARN='string'
)
type Name

string

param Name

The name of the rule group. You cannot change the name of a rule group after you create it.

type Scope

string

param Scope

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1 .

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

type Id

string

param Id

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

type ARN

string

param ARN

The Amazon Resource Name (ARN) of the entity.

rtype

dict

returns

Response Syntax

{
    'RuleGroup': {
        'Name': 'string',
        'Id': 'string',
        'Capacity': 123,
        'ARN': 'string',
        'Description': 'string',
        'Rules': [
            {
                'Name': 'string',
                'Priority': 123,
                'Statement': {
                    'ByteMatchStatement': {
                        'SearchString': b'bytes',
                        'FieldToMatch': {
                            'SingleHeader': {
                                'Name': 'string'
                            },
                            'SingleQueryArgument': {
                                'Name': 'string'
                            },
                            'AllQueryArguments': {},
                            'UriPath': {},
                            'QueryString': {},
                            'Body': {
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Method': {},
                            'JsonBody': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedPaths': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Headers': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedHeaders': [
                                        'string',
                                    ],
                                    'ExcludedHeaders': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Cookies': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedCookies': [
                                        'string',
                                    ],
                                    'ExcludedCookies': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            }
                        },
                        'TextTransformations': [
                            {
                                'Priority': 123,
                                'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                            },
                        ],
                        'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
                    },
                    'SqliMatchStatement': {
                        'FieldToMatch': {
                            'SingleHeader': {
                                'Name': 'string'
                            },
                            'SingleQueryArgument': {
                                'Name': 'string'
                            },
                            'AllQueryArguments': {},
                            'UriPath': {},
                            'QueryString': {},
                            'Body': {
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Method': {},
                            'JsonBody': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedPaths': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Headers': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedHeaders': [
                                        'string',
                                    ],
                                    'ExcludedHeaders': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Cookies': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedCookies': [
                                        'string',
                                    ],
                                    'ExcludedCookies': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            }
                        },
                        'TextTransformations': [
                            {
                                'Priority': 123,
                                'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                            },
                        ],
                        'SensitivityLevel': 'LOW'|'HIGH'
                    },
                    'XssMatchStatement': {
                        'FieldToMatch': {
                            'SingleHeader': {
                                'Name': 'string'
                            },
                            'SingleQueryArgument': {
                                'Name': 'string'
                            },
                            'AllQueryArguments': {},
                            'UriPath': {},
                            'QueryString': {},
                            'Body': {
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Method': {},
                            'JsonBody': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedPaths': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Headers': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedHeaders': [
                                        'string',
                                    ],
                                    'ExcludedHeaders': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Cookies': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedCookies': [
                                        'string',
                                    ],
                                    'ExcludedCookies': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            }
                        },
                        'TextTransformations': [
                            {
                                'Priority': 123,
                                'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                            },
                        ]
                    },
                    'SizeConstraintStatement': {
                        'FieldToMatch': {
                            'SingleHeader': {
                                'Name': 'string'
                            },
                            'SingleQueryArgument': {
                                'Name': 'string'
                            },
                            'AllQueryArguments': {},
                            'UriPath': {},
                            'QueryString': {},
                            'Body': {
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Method': {},
                            'JsonBody': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedPaths': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Headers': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedHeaders': [
                                        'string',
                                    ],
                                    'ExcludedHeaders': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Cookies': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedCookies': [
                                        'string',
                                    ],
                                    'ExcludedCookies': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            }
                        },
                        'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
                        'Size': 123,
                        'TextTransformations': [
                            {
                                'Priority': 123,
                                'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                            },
                        ]
                    },
                    'GeoMatchStatement': {
                        'CountryCodes': [
                            'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK',
                        ],
                        'ForwardedIPConfig': {
                            'HeaderName': 'string',
                            'FallbackBehavior': 'MATCH'|'NO_MATCH'
                        }
                    },
                    'RuleGroupReferenceStatement': {
                        'ARN': 'string',
                        'ExcludedRules': [
                            {
                                'Name': 'string'
                            },
                        ],
                        'RuleActionOverrides': [
                            {
                                'Name': 'string',
                                'ActionToUse': {
                                    'Block': {
                                        'CustomResponse': {
                                            'ResponseCode': 123,
                                            'CustomResponseBodyKey': 'string',
                                            'ResponseHeaders': [
                                                {
                                                    'Name': 'string',
                                                    'Value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'Allow': {
                                        'CustomRequestHandling': {
                                            'InsertHeaders': [
                                                {
                                                    'Name': 'string',
                                                    'Value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'Count': {
                                        'CustomRequestHandling': {
                                            'InsertHeaders': [
                                                {
                                                    'Name': 'string',
                                                    'Value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'Captcha': {
                                        'CustomRequestHandling': {
                                            'InsertHeaders': [
                                                {
                                                    'Name': 'string',
                                                    'Value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'Challenge': {
                                        'CustomRequestHandling': {
                                            'InsertHeaders': [
                                                {
                                                    'Name': 'string',
                                                    'Value': 'string'
                                                },
                                            ]
                                        }
                                    }
                                }
                            },
                        ]
                    },
                    'IPSetReferenceStatement': {
                        'ARN': 'string',
                        'IPSetForwardedIPConfig': {
                            'HeaderName': 'string',
                            'FallbackBehavior': 'MATCH'|'NO_MATCH',
                            'Position': 'FIRST'|'LAST'|'ANY'
                        }
                    },
                    'RegexPatternSetReferenceStatement': {
                        'ARN': 'string',
                        'FieldToMatch': {
                            'SingleHeader': {
                                'Name': 'string'
                            },
                            'SingleQueryArgument': {
                                'Name': 'string'
                            },
                            'AllQueryArguments': {},
                            'UriPath': {},
                            'QueryString': {},
                            'Body': {
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Method': {},
                            'JsonBody': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedPaths': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Headers': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedHeaders': [
                                        'string',
                                    ],
                                    'ExcludedHeaders': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Cookies': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedCookies': [
                                        'string',
                                    ],
                                    'ExcludedCookies': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            }
                        },
                        'TextTransformations': [
                            {
                                'Priority': 123,
                                'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                            },
                        ]
                    },
                    'RateBasedStatement': {
                        'Limit': 123,
                        'AggregateKeyType': 'IP'|'FORWARDED_IP',
                        'ScopeDownStatement': {'... recursive ...'},
                        'ForwardedIPConfig': {
                            'HeaderName': 'string',
                            'FallbackBehavior': 'MATCH'|'NO_MATCH'
                        }
                    },
                    'AndStatement': {
                        'Statements': [
                            {'... recursive ...'},
                        ]
                    },
                    'OrStatement': {
                        'Statements': [
                            {'... recursive ...'},
                        ]
                    },
                    'NotStatement': {
                        'Statement': {'... recursive ...'}
                    },
                    'ManagedRuleGroupStatement': {
                        'VendorName': 'string',
                        'Name': 'string',
                        'Version': 'string',
                        'ExcludedRules': [
                            {
                                'Name': 'string'
                            },
                        ],
                        'ScopeDownStatement': {'... recursive ...'},
                        'ManagedRuleGroupConfigs': [
                            {
                                'LoginPath': 'string',
                                'PayloadType': 'JSON'|'FORM_ENCODED',
                                'UsernameField': {
                                    'Identifier': 'string'
                                },
                                'PasswordField': {
                                    'Identifier': 'string'
                                },
                                'AWSManagedRulesBotControlRuleSet': {
                                    'InspectionLevel': 'COMMON'|'TARGETED'
                                }
                            },
                        ],
                        'RuleActionOverrides': [
                            {
                                'Name': 'string',
                                'ActionToUse': {
                                    'Block': {
                                        'CustomResponse': {
                                            'ResponseCode': 123,
                                            'CustomResponseBodyKey': 'string',
                                            'ResponseHeaders': [
                                                {
                                                    'Name': 'string',
                                                    'Value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'Allow': {
                                        'CustomRequestHandling': {
                                            'InsertHeaders': [
                                                {
                                                    'Name': 'string',
                                                    'Value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'Count': {
                                        'CustomRequestHandling': {
                                            'InsertHeaders': [
                                                {
                                                    'Name': 'string',
                                                    'Value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'Captcha': {
                                        'CustomRequestHandling': {
                                            'InsertHeaders': [
                                                {
                                                    'Name': 'string',
                                                    'Value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'Challenge': {
                                        'CustomRequestHandling': {
                                            'InsertHeaders': [
                                                {
                                                    'Name': 'string',
                                                    'Value': 'string'
                                                },
                                            ]
                                        }
                                    }
                                }
                            },
                        ]
                    },
                    'LabelMatchStatement': {
                        'Scope': 'LABEL'|'NAMESPACE',
                        'Key': 'string'
                    },
                    'RegexMatchStatement': {
                        'RegexString': 'string',
                        'FieldToMatch': {
                            'SingleHeader': {
                                'Name': 'string'
                            },
                            'SingleQueryArgument': {
                                'Name': 'string'
                            },
                            'AllQueryArguments': {},
                            'UriPath': {},
                            'QueryString': {},
                            'Body': {
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Method': {},
                            'JsonBody': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedPaths': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Headers': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedHeaders': [
                                        'string',
                                    ],
                                    'ExcludedHeaders': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            },
                            'Cookies': {
                                'MatchPattern': {
                                    'All': {},
                                    'IncludedCookies': [
                                        'string',
                                    ],
                                    'ExcludedCookies': [
                                        'string',
                                    ]
                                },
                                'MatchScope': 'ALL'|'KEY'|'VALUE',
                                'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
                            }
                        },
                        'TextTransformations': [
                            {
                                'Priority': 123,
                                'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'
                            },
                        ]
                    }
                },
                'Action': {
                    'Block': {
                        'CustomResponse': {
                            'ResponseCode': 123,
                            'CustomResponseBodyKey': 'string',
                            'ResponseHeaders': [
                                {
                                    'Name': 'string',
                                    'Value': 'string'
                                },
                            ]
                        }
                    },
                    'Allow': {
                        'CustomRequestHandling': {
                            'InsertHeaders': [
                                {
                                    'Name': 'string',
                                    'Value': 'string'
                                },
                            ]
                        }
                    },
                    'Count': {
                        'CustomRequestHandling': {
                            'InsertHeaders': [
                                {
                                    'Name': 'string',
                                    'Value': 'string'
                                },
                            ]
                        }
                    },
                    'Captcha': {
                        'CustomRequestHandling': {
                            'InsertHeaders': [
                                {
                                    'Name': 'string',
                                    'Value': 'string'
                                },
                            ]
                        }
                    },
                    'Challenge': {
                        'CustomRequestHandling': {
                            'InsertHeaders': [
                                {
                                    'Name': 'string',
                                    'Value': 'string'
                                },
                            ]
                        }
                    }
                },
                'OverrideAction': {
                    'Count': {
                        'CustomRequestHandling': {
                            'InsertHeaders': [
                                {
                                    'Name': 'string',
                                    'Value': 'string'
                                },
                            ]
                        }
                    },
                    'None': {}
                },
                'RuleLabels': [
                    {
                        'Name': 'string'
                    },
                ],
                'VisibilityConfig': {
                    'SampledRequestsEnabled': True|False,
                    'CloudWatchMetricsEnabled': True|False,
                    'MetricName': 'string'
                },
                'CaptchaConfig': {
                    'ImmunityTimeProperty': {
                        'ImmunityTime': 123
                    }
                },
                'ChallengeConfig': {
                    'ImmunityTimeProperty': {
                        'ImmunityTime': 123
                    }
                }
            },
        ],
        'VisibilityConfig': {
            'SampledRequestsEnabled': True|False,
            'CloudWatchMetricsEnabled': True|False,
            'MetricName': 'string'
        },
        'LabelNamespace': 'string',
        'CustomResponseBodies': {
            'string': {
                'ContentType': 'TEXT_PLAIN'|'TEXT_HTML'|'APPLICATION_JSON',
                'Content': 'string'
            }
        },
        'AvailableLabels': [
            {
                'Name': 'string'
            },
        ],
        'ConsumedLabels': [
            {
                'Name': 'string'
            },
        ]
    },
    'LockToken': 'string'
}

Response Structure

  • (dict) --

    • RuleGroup (dict) --

      • Name (string) --

        The name of the rule group. You cannot change the name of a rule group after you create it.

      • Id (string) --

        A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

      • Capacity (integer) --

        The web ACL capacity units (WCUs) required for this rule group.

        When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity .

        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.

      • ARN (string) --

        The Amazon Resource Name (ARN) of the entity.

      • Description (string) --

        A description of the rule group that helps with identification.

      • Rules (list) --

        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.

        • (dict) --

          A single rule, which you can use in a WebACL or RuleGroup to identify 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.

          • Name (string) --

            The name of the rule. You can't change the name of a Rule after you create it.

          • Priority (integer) --

            If you define more than one Rule in a WebACL , WAF evaluates each request against the Rules in order based on the value of Priority . WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

          • Statement (dict) --

            The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .

            • ByteMatchStatement (dict) --

              A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

              • SearchString (bytes) --

                A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 50 bytes.

                Valid values depend on the component that you specify for inspection in FieldToMatch :

                • Method : The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request.

                • UriPath : The value that you want WAF to search for in the URI path, for example, /images/daily-ad.jpg .

                If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

                If you're using the WAF API

                Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

                For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90 , in the value of SearchString .

                If you're using the CLI or one of the Amazon Web Services SDKs

                The value that you want WAF to search for. The SDK automatically base64 encodes the value.

              • FieldToMatch (dict) --

                The part of the web request that you want WAF to inspect.

                • SingleHeader (dict) --

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

                  Example JSON: "SingleHeader": { "Name": "haystack" }

                  Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

                  • Name (string) --

                    The name of the query header to inspect.

                • SingleQueryArgument (dict) --

                  Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

                  Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

                  • Name (string) --

                    The name of the query argument to inspect.

                • AllQueryArguments (dict) --

                  Inspect all query arguments.

                • UriPath (dict) --

                  Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

                • QueryString (dict) --

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body (dict) --

                  Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

                  Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

                  • OversizeHandling (string) --

                    What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

                    Default: CONTINUE

                • Method (dict) --

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

                • JsonBody (dict) --

                  Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

                  Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

                  • MatchPattern (dict) --

                    The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

                    • All (dict) --

                      Match all of the elements. See also MatchScope in JsonBody .

                      You must specify either this setting or the IncludedPaths setting, but not both.

                    • IncludedPaths (list) --

                      Match only the specified include paths. See also MatchScope in JsonBody .

                      Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                      You must specify either this setting or the All setting, but not both.

                      Note

                      Don't use this option to include all paths. Instead, use the All setting.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

                  • InvalidFallbackBehavior (string) --

                    What WAF should do if it fails to completely parse the JSON body. The options are the following:

                    • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

                    WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

                    WAF parses the JSON in the following examples as two valid key, value pairs:

                    • Missing comma: {"key1":"value1""key2":"value2"}

                    • Missing colon: {"key1":"value1","key2""value2"}

                    • Extra colons: {"key1"::"value1","key2""value2"}

                  • OversizeHandling (string) --

                    What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

                    Default: CONTINUE

                • Headers (dict) --

                  Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

                  Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

                  • MatchPattern (dict) --

                    The filter to use to identify the subset of headers to inspect in a web request.

                    You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

                    Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

                    • All (dict) --

                      Inspect all headers.

                    • IncludedHeaders (list) --

                      Inspect only the headers that have a key that matches one of the strings specified here.

                      • (string) --

                    • ExcludedHeaders (list) --

                      Inspect only the headers whose keys don't match any of the strings specified here.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

                  • OversizeHandling (string) --

                    What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                • Cookies (dict) --

                  Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

                  Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

                  • MatchPattern (dict) --

                    The filter to use to identify the subset of cookies to inspect in a web request.

                    You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

                    Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

                    • All (dict) --

                      Inspect all cookies.

                    • IncludedCookies (list) --

                      Inspect only the cookies that have a key that matches one of the strings specified here.

                      • (string) --

                    • ExcludedCookies (list) --

                      Inspect only the cookies whose keys don't match any of the strings specified here.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

                  • OversizeHandling (string) --

                    What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

              • TextTransformations (list) --

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

                • (dict) --

                  Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

                  • Priority (integer) --

                    Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

                  • Type (string) --

                    You can specify the following transformation types:

                    BASE64_DECODE - Decode a Base64 -encoded string.

                    BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

                    CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

                    • Delete the following characters: \ " ' ^

                    • Delete spaces before the following characters: / (

                    • Replace the following characters with a space: , ;

                    • Replace multiple spaces with one space

                    • Convert uppercase letters (A-Z) to lowercase (a-z)

                    COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

                    • \f , formfeed, decimal 12

                    • \t , tab, decimal 9

                    • \n , newline, decimal 10

                    • \r , carriage return, decimal 13

                    • \v , vertical tab, decimal 11

                    • Non-breaking space, decimal 160

                    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                    CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

                    ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

                    HEX_DECODE - Decode a string of hexadecimal characters into a binary.

                    HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

                    • Replaces (ampersand)quot; with "

                    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                    • Replaces (ampersand)lt; with a "less than" symbol

                    • Replaces (ampersand)gt; with >

                    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

                    • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

                    JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

                    LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

                    MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

                    NONE - Specify NONE if you don't want any text transformations.

                    NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

                    NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

                    REMOVE_NULLS - Remove all NULL bytes from the input.

                    REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

                    REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

                    SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

                    URL_DECODE - Decode a URL-encoded value.

                    URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

                    UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

              • PositionalConstraint (string) --

                The area within the portion of the web request that you want WAF to search for SearchString . Valid values include the following:

                CONTAINS

                The specified part of the web request must include the value of SearchString , but the location doesn't matter.

                CONTAINS_WORD

                The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:

                • SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and ;BadBot .

                • SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot; .

                EXACTLY

                The value of the specified part of the web request must exactly match the value of SearchString .

                STARTS_WITH

                The value of SearchString must appear at the beginning of the specified part of the web request.

                ENDS_WITH

                The value of SearchString must appear at the end of the specified part of the web request.

            • SqliMatchStatement (dict) --

              A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

              • FieldToMatch (dict) --

                The part of the web request that you want WAF to inspect.

                • SingleHeader (dict) --

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

                  Example JSON: "SingleHeader": { "Name": "haystack" }

                  Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

                  • Name (string) --

                    The name of the query header to inspect.

                • SingleQueryArgument (dict) --

                  Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

                  Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

                  • Name (string) --

                    The name of the query argument to inspect.

                • AllQueryArguments (dict) --

                  Inspect all query arguments.

                • UriPath (dict) --

                  Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

                • QueryString (dict) --

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body (dict) --

                  Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

                  Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

                  • OversizeHandling (string) --

                    What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

                    Default: CONTINUE

                • Method (dict) --

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

                • JsonBody (dict) --

                  Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

                  Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

                  • MatchPattern (dict) --

                    The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

                    • All (dict) --

                      Match all of the elements. See also MatchScope in JsonBody .

                      You must specify either this setting or the IncludedPaths setting, but not both.

                    • IncludedPaths (list) --

                      Match only the specified include paths. See also MatchScope in JsonBody .

                      Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                      You must specify either this setting or the All setting, but not both.

                      Note

                      Don't use this option to include all paths. Instead, use the All setting.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

                  • InvalidFallbackBehavior (string) --

                    What WAF should do if it fails to completely parse the JSON body. The options are the following:

                    • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

                    WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

                    WAF parses the JSON in the following examples as two valid key, value pairs:

                    • Missing comma: {"key1":"value1""key2":"value2"}

                    • Missing colon: {"key1":"value1","key2""value2"}

                    • Extra colons: {"key1"::"value1","key2""value2"}

                  • OversizeHandling (string) --

                    What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

                    Default: CONTINUE

                • Headers (dict) --

                  Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

                  Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

                  • MatchPattern (dict) --

                    The filter to use to identify the subset of headers to inspect in a web request.

                    You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

                    Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

                    • All (dict) --

                      Inspect all headers.

                    • IncludedHeaders (list) --

                      Inspect only the headers that have a key that matches one of the strings specified here.

                      • (string) --

                    • ExcludedHeaders (list) --

                      Inspect only the headers whose keys don't match any of the strings specified here.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

                  • OversizeHandling (string) --

                    What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                • Cookies (dict) --

                  Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

                  Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

                  • MatchPattern (dict) --

                    The filter to use to identify the subset of cookies to inspect in a web request.

                    You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

                    Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

                    • All (dict) --

                      Inspect all cookies.

                    • IncludedCookies (list) --

                      Inspect only the cookies that have a key that matches one of the strings specified here.

                      • (string) --

                    • ExcludedCookies (list) --

                      Inspect only the cookies whose keys don't match any of the strings specified here.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

                  • OversizeHandling (string) --

                    What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

              • TextTransformations (list) --

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

                • (dict) --

                  Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

                  • Priority (integer) --

                    Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

                  • Type (string) --

                    You can specify the following transformation types:

                    BASE64_DECODE - Decode a Base64 -encoded string.

                    BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

                    CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

                    • Delete the following characters: \ " ' ^

                    • Delete spaces before the following characters: / (

                    • Replace the following characters with a space: , ;

                    • Replace multiple spaces with one space

                    • Convert uppercase letters (A-Z) to lowercase (a-z)

                    COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

                    • \f , formfeed, decimal 12

                    • \t , tab, decimal 9

                    • \n , newline, decimal 10

                    • \r , carriage return, decimal 13

                    • \v , vertical tab, decimal 11

                    • Non-breaking space, decimal 160

                    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                    CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

                    ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

                    HEX_DECODE - Decode a string of hexadecimal characters into a binary.

                    HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

                    • Replaces (ampersand)quot; with "

                    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                    • Replaces (ampersand)lt; with a "less than" symbol

                    • Replaces (ampersand)gt; with >

                    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

                    • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

                    JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

                    LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

                    MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

                    NONE - Specify NONE if you don't want any text transformations.

                    NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

                    NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

                    REMOVE_NULLS - Remove all NULL bytes from the input.

                    REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

                    REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

                    SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

                    URL_DECODE - Decode a URL-encoded value.

                    URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

                    UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

              • SensitivityLevel (string) --

                The sensitivity that you want WAF to use to inspect for SQL injection attacks.

                HIGH detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the WAF Developer Guide .

                LOW is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.

                Default: LOW

            • XssMatchStatement (dict) --

              A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

              • FieldToMatch (dict) --

                The part of the web request that you want WAF to inspect.

                • SingleHeader (dict) --

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

                  Example JSON: "SingleHeader": { "Name": "haystack" }

                  Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

                  • Name (string) --

                    The name of the query header to inspect.

                • SingleQueryArgument (dict) --

                  Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

                  Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

                  • Name (string) --

                    The name of the query argument to inspect.

                • AllQueryArguments (dict) --

                  Inspect all query arguments.

                • UriPath (dict) --

                  Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

                • QueryString (dict) --

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body (dict) --

                  Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

                  Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

                  • OversizeHandling (string) --

                    What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

                    Default: CONTINUE

                • Method (dict) --

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

                • JsonBody (dict) --

                  Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

                  Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

                  • MatchPattern (dict) --

                    The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

                    • All (dict) --

                      Match all of the elements. See also MatchScope in JsonBody .

                      You must specify either this setting or the IncludedPaths setting, but not both.

                    • IncludedPaths (list) --

                      Match only the specified include paths. See also MatchScope in JsonBody .

                      Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                      You must specify either this setting or the All setting, but not both.

                      Note

                      Don't use this option to include all paths. Instead, use the All setting.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

                  • InvalidFallbackBehavior (string) --

                    What WAF should do if it fails to completely parse the JSON body. The options are the following:

                    • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

                    WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

                    WAF parses the JSON in the following examples as two valid key, value pairs:

                    • Missing comma: {"key1":"value1""key2":"value2"}

                    • Missing colon: {"key1":"value1","key2""value2"}

                    • Extra colons: {"key1"::"value1","key2""value2"}

                  • OversizeHandling (string) --

                    What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

                    Default: CONTINUE

                • Headers (dict) --

                  Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

                  Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

                  • MatchPattern (dict) --

                    The filter to use to identify the subset of headers to inspect in a web request.

                    You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

                    Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

                    • All (dict) --

                      Inspect all headers.

                    • IncludedHeaders (list) --

                      Inspect only the headers that have a key that matches one of the strings specified here.

                      • (string) --

                    • ExcludedHeaders (list) --

                      Inspect only the headers whose keys don't match any of the strings specified here.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

                  • OversizeHandling (string) --

                    What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                • Cookies (dict) --

                  Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

                  Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

                  • MatchPattern (dict) --

                    The filter to use to identify the subset of cookies to inspect in a web request.

                    You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

                    Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

                    • All (dict) --

                      Inspect all cookies.

                    • IncludedCookies (list) --

                      Inspect only the cookies that have a key that matches one of the strings specified here.

                      • (string) --

                    • ExcludedCookies (list) --

                      Inspect only the cookies whose keys don't match any of the strings specified here.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

                  • OversizeHandling (string) --

                    What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

              • TextTransformations (list) --

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

                • (dict) --

                  Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

                  • Priority (integer) --

                    Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

                  • Type (string) --

                    You can specify the following transformation types:

                    BASE64_DECODE - Decode a Base64 -encoded string.

                    BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

                    CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

                    • Delete the following characters: \ " ' ^

                    • Delete spaces before the following characters: / (

                    • Replace the following characters with a space: , ;

                    • Replace multiple spaces with one space

                    • Convert uppercase letters (A-Z) to lowercase (a-z)

                    COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

                    • \f , formfeed, decimal 12

                    • \t , tab, decimal 9

                    • \n , newline, decimal 10

                    • \r , carriage return, decimal 13

                    • \v , vertical tab, decimal 11

                    • Non-breaking space, decimal 160

                    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                    CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

                    ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

                    HEX_DECODE - Decode a string of hexadecimal characters into a binary.

                    HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

                    • Replaces (ampersand)quot; with "

                    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                    • Replaces (ampersand)lt; with a "less than" symbol

                    • Replaces (ampersand)gt; with >

                    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

                    • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

                    JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

                    LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

                    MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

                    NONE - Specify NONE if you don't want any text transformations.

                    NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

                    NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

                    REMOVE_NULLS - Remove all NULL bytes from the input.

                    REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

                    REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

                    SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

                    URL_DECODE - Decode a URL-encoded value.

                    URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

                    UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            • SizeConstraintStatement (dict) --

              A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

              If you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.

              If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

              • FieldToMatch (dict) --

                The part of the web request that you want WAF to inspect.

                • SingleHeader (dict) --

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

                  Example JSON: "SingleHeader": { "Name": "haystack" }

                  Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

                  • Name (string) --

                    The name of the query header to inspect.

                • SingleQueryArgument (dict) --

                  Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

                  Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

                  • Name (string) --

                    The name of the query argument to inspect.

                • AllQueryArguments (dict) --

                  Inspect all query arguments.

                • UriPath (dict) --

                  Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

                • QueryString (dict) --

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body (dict) --

                  Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

                  Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

                  • OversizeHandling (string) --

                    What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

                    Default: CONTINUE

                • Method (dict) --

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

                • JsonBody (dict) --

                  Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

                  Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

                  • MatchPattern (dict) --

                    The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

                    • All (dict) --

                      Match all of the elements. See also MatchScope in JsonBody .

                      You must specify either this setting or the IncludedPaths setting, but not both.

                    • IncludedPaths (list) --

                      Match only the specified include paths. See also MatchScope in JsonBody .

                      Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                      You must specify either this setting or the All setting, but not both.

                      Note

                      Don't use this option to include all paths. Instead, use the All setting.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

                  • InvalidFallbackBehavior (string) --

                    What WAF should do if it fails to completely parse the JSON body. The options are the following:

                    • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

                    WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

                    WAF parses the JSON in the following examples as two valid key, value pairs:

                    • Missing comma: {"key1":"value1""key2":"value2"}

                    • Missing colon: {"key1":"value1","key2""value2"}

                    • Extra colons: {"key1"::"value1","key2""value2"}

                  • OversizeHandling (string) --

                    What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

                    Default: CONTINUE

                • Headers (dict) --

                  Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

                  Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

                  • MatchPattern (dict) --

                    The filter to use to identify the subset of headers to inspect in a web request.

                    You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

                    Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

                    • All (dict) --

                      Inspect all headers.

                    • IncludedHeaders (list) --

                      Inspect only the headers that have a key that matches one of the strings specified here.

                      • (string) --

                    • ExcludedHeaders (list) --

                      Inspect only the headers whose keys don't match any of the strings specified here.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

                  • OversizeHandling (string) --

                    What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                • Cookies (dict) --

                  Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

                  Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

                  • MatchPattern (dict) --

                    The filter to use to identify the subset of cookies to inspect in a web request.

                    You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

                    Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

                    • All (dict) --

                      Inspect all cookies.

                    • IncludedCookies (list) --

                      Inspect only the cookies that have a key that matches one of the strings specified here.

                      • (string) --

                    • ExcludedCookies (list) --

                      Inspect only the cookies whose keys don't match any of the strings specified here.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

                  • OversizeHandling (string) --

                    What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

              • ComparisonOperator (string) --

                The operator to use to compare the request part to the size setting.

              • Size (integer) --

                The size, in byte, to compare to the request part, after any transformations.

              • TextTransformations (list) --

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

                • (dict) --

                  Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

                  • Priority (integer) --

                    Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

                  • Type (string) --

                    You can specify the following transformation types:

                    BASE64_DECODE - Decode a Base64 -encoded string.

                    BASE64_DECODE_EXT - Decode a Base64 -encoded string, but use a forgiving implementation that ignores characters that aren't valid.

                    CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

                    • Delete the following characters: \ " ' ^

                    • Delete spaces before the following characters: / (

                    • Replace the following characters with a space: , ;

                    • Replace multiple spaces with one space

                    • Convert uppercase letters (A-Z) to lowercase (a-z)

                    COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

                    • \f , formfeed, decimal 12

                    • \t , tab, decimal 9

                    • \n , newline, decimal 10

                    • \r , carriage return, decimal 13

                    • \v , vertical tab, decimal 11

                    • Non-breaking space, decimal 160

                    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                    CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters . This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

                    ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

                    HEX_DECODE - Decode a string of hexadecimal characters into a binary.

                    HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

                    • Replaces (ampersand)quot; with "

                    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                    • Replaces (ampersand)lt; with a "less than" symbol

                    • Replaces (ampersand)gt; with >

                    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters

                    • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

                    JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

                    LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

                    MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

                    NONE - Specify NONE if you don't want any text transformations.

                    NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

                    NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but first converts backslash characters to forward slashes.

                    REMOVE_NULLS - Remove all NULL bytes from the input.

                    REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */ ) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/ ) is not acted upon.

                    REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20 ).

                    SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243 ) will be decoded to (ABC ).

                    URL_DECODE - Decode a URL-encoded value.

                    URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

                    UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            • GeoMatchStatement (dict) --

              A rule statement used to identify web requests based on country of origin.

              • CountryCodes (list) --

                An array of two-character country codes, for example, [ "US", "CN" ] , from the alpha-2 country ISO codes of the ISO 3166 international standard.

                • (string) --

              • ForwardedIPConfig (dict) --

                The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

                Note

                If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

                • HeaderName (string) --

                  The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For .

                  Note

                  If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

                • FallbackBehavior (string) --

                  The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

                  Note

                  If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

                  You can specify the following fallback behaviors:

                  • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                  • NO_MATCH - Treat the web request as not matching the rule statement.

            • RuleGroupReferenceStatement (dict) --

              A rule statement used to run the rules that are defined in a RuleGroup . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

              You cannot nest a RuleGroupReferenceStatement , for example for use inside a NotStatement or OrStatement . You can only use a rule group reference statement at the top level inside a web ACL.

              • ARN (string) --

                The Amazon Resource Name (ARN) of the entity.

              • ExcludedRules (list) --

                Rules in the referenced rule group whose actions are set to Count .

                Note

                Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

                • (dict) --

                  Specifies a single rule in a rule group whose action you want to override to Count .

                  Note

                  Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

                  • Name (string) --

                    The name of the rule whose action you want to override to Count .

              • RuleActionOverrides (list) --

                Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

                You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

                • (dict) --

                  Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

                  You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

                  • Name (string) --

                    The name of the rule to override.

                  • ActionToUse (dict) --

                    The override action to use, in place of the configured action of the rule in the rule group.

                    • Block (dict) --

                      Instructs WAF to block the web request.

                      • CustomResponse (dict) --

                        Defines a custom response for the web request.

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

                        • ResponseCode (integer) --

                          The HTTP status code to return to the client.

                          For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide .

                        • CustomResponseBodyKey (string) --

                          References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

                        • ResponseHeaders (list) --

                          The HTTP headers to use in the response. Duplicate header names are not allowed.

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

                          • (dict) --

                            A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                            • Name (string) --

                              The name of the custom header.

                              For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                            • Value (string) --

                              The value of the custom header.

                    • Allow (dict) --

                      Instructs WAF to allow the web request.

                      • CustomRequestHandling (dict) --

                        Defines custom handling for the web request.

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

                        • InsertHeaders (list) --

                          The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                          • (dict) --

                            A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                            • Name (string) --

                              The name of the custom header.

                              For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                            • Value (string) --

                              The value of the custom header.

                    • Count (dict) --

                      Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

                      • CustomRequestHandling (dict) --

                        Defines custom handling for the web request.

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

                        • InsertHeaders (list) --

                          The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                          • (dict) --

                            A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                            • Name (string) --

                              The name of the custom header.

                              For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                            • Value (string) --

                              The value of the custom header.

                    • Captcha (dict) --

                      Instructs WAF to run a CAPTCHA check against the web request.

                      • CustomRequestHandling (dict) --

                        Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

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

                        • InsertHeaders (list) --

                          The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                          • (dict) --

                            A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                            • Name (string) --

                              The name of the custom header.

                              For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                            • Value (string) --

                              The value of the custom header.

                    • Challenge (dict) --

                      Instructs WAF to run a Challenge check against the web request.

                      • CustomRequestHandling (dict) --

                        Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

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

                        • InsertHeaders (list) --

                          The HTTP headers to insert into the request. Duplicate header names are not allowed.

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

                          • (dict) --

                            A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling .

                            • Name (string) --

                              The name of the custom header.

                              For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , WAF inserts the header x-amzn-waf-sample .

                            • Value (string) --

                              The value of the custom header.

            • IPSetReferenceStatement (dict) --

              A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet .

              Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

              • ARN (string) --

                The Amazon Resource Name (ARN) of the IPSet that this statement references.

              • IPSetForwardedIPConfig (dict) --

                The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

                Note

                If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

                • HeaderName (string) --

                  The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For .

                  Note

                  If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

                • FallbackBehavior (string) --

                  The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

                  Note

                  If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

                  You can specify the following fallback behaviors:

                  • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                  • NO_MATCH - Treat the web request as not matching the rule statement.

                • Position (string) --

                  The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

                  The options for this setting are the following:

                  • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

                  • LAST - Inspect the last IP address in the list of IP addresses in the header.

                  • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.

            • RegexPatternSetReferenceStatement (dict) --

              A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet .

              Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

              • ARN (string) --

                The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

              • FieldToMatch (dict) --

                The part of the web request that you want WAF to inspect.

                • SingleHeader (dict) --

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

                  Example JSON: "SingleHeader": { "Name": "haystack" }

                  Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

                  • Name (string) --

                    The name of the query header to inspect.

                • SingleQueryArgument (dict) --

                  Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

                  Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

                  • Name (string) --

                    The name of the query argument to inspect.

                • AllQueryArguments (dict) --

                  Inspect all query arguments.

                • UriPath (dict) --

                  Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

                • QueryString (dict) --

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body (dict) --

                  Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

                  Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

                  • OversizeHandling (string) --

                    What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

                    Default: CONTINUE

                • Method (dict) --

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

                • JsonBody (dict) --

                  Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

                  Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

                  • MatchPattern (dict) --

                    The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

                    • All (dict) --

                      Match all of the elements. See also MatchScope in JsonBody .

                      You must specify either this setting or the IncludedPaths setting, but not both.

                    • IncludedPaths (list) --

                      Match only the specified include paths. See also MatchScope in JsonBody .

                      Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

                      You must specify either this setting or the All setting, but not both.

                      Note

                      Don't use this option to include all paths. Instead, use the All setting.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the JSON to match against using the MatchPattern . If you specify All , WAF matches against keys and values.

                  • InvalidFallbackBehavior (string) --

                    What WAF should do if it fails to completely parse the JSON body. The options are the following:

                    • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

                    WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

                    WAF parses the JSON in the following examples as two valid key, value pairs:

                    • Missing comma: {"key1":"value1""key2":"value2"}

                    • Missing colon: {"key1":"value1","key2""value2"}

                    • Extra colons: {"key1"::"value1","key2""value2"}

                  • OversizeHandling (string) --

                    What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                    You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

                    Default: CONTINUE

                • Headers (dict) --

                  Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

                  Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

                  • MatchPattern (dict) --

                    The filter to use to identify the subset of headers to inspect in a web request.

                    You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

                    Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

                    • All (dict) --

                      Inspect all headers.

                    • IncludedHeaders (list) --

                      Inspect only the headers that have a key that matches one of the strings specified here.

                      • (string) --

                    • ExcludedHeaders (list) --

                      Inspect only the headers whose keys don't match any of the strings specified here.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the headers to match with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

                  • OversizeHandling (string) --

                    What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

                • Cookies (dict) --

                  Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

                  Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

                  • MatchPattern (dict) --

                    The filter to use to identify the subset of cookies to inspect in a web request.

                    You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .

                    Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

                    • All (dict) --

                      Inspect all cookies.

                    • IncludedCookies (list) --

                      Inspect only the cookies that have a key that matches one of the strings specified here.

                      • (string) --

                    • ExcludedCookies (list) --

                      Inspect only the cookies whose keys don't match any of the strings specified here.

                      • (string) --

                  • MatchScope (string) --

                    The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

                  • OversizeHandling (string) --

                    What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

                    The options for oversize handling are the following:

                    • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

                    • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

                    • NO_MATCH - Treat the web request as not matching the rule statement.

              • TextTransformations (list) --

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

                • (dict) --

                  Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

                  • Priority (integer) --

                    Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

                  • Type (string) --

                    You can specify the following transformation types:

                    BASE64_DECODE - Decode a Base64 -encoded string.

                    BASE64_DECODE_EXT - Decode a Base64 -encoded string, but