Skip to content

FieldToProtect

Source code in docs_src/capo_wafv2/types/field_to_protect.py 
14
15
16
17
18
class FieldToProtect(TypedDict, closed=True):
    field_type: "capo_wafv2.types.field_to_protect_type.FieldToProtectType"
    """<p>Specifies the web request component type to protect. </p>"""
    field_keys: NotRequired["capo_wafv2.types.field_to_protect_keys.FieldToProtectKeys"]
    """<p>Specifies the keys to protect for the specified field type.</p> <p>Required for <code>SINGLE_HEADER</code>, <code>SINGLE_COOKIE</code>, and <code>SINGLE_QUERY_ARGUMENT</code>: provide a non-empty array naming the specific headers, cookies, or query arguments to protect. There is no option to protect all keys of these field types, so enumerate each key you intend to protect.</p> <p>Must be omitted for <code>QUERY_STRING</code> and <code>BODY</code>: the entire component is protected and these field types take no keys. Supplying <code>FieldKeys</code> for them is rejected.</p>"""

field_keys instance-attribute 

field_keys: NotRequired[FieldToProtectKeys]

Specifies the keys to protect for the specified field type.

Required for SINGLE_HEADER, SINGLE_COOKIE, and SINGLE_QUERY_ARGUMENT: provide a non-empty array naming the specific headers, cookies, or query arguments to protect. There is no option to protect all keys of these field types, so enumerate each key you intend to protect.

Must be omitted for QUERY_STRING and BODY: the entire component is protected and these field types take no keys. Supplying FieldKeys for them is rejected.

field_type instance-attribute 

field_type: FieldToProtectType

Specifies the web request component type to protect.