Skip to content

DataProtection

Source code in docs_src/capo_wafv2/types/data_protection.py 
15
16
17
18
19
20
21
22
23
class DataProtection(TypedDict, closed=True):
    field: "capo_wafv2.types.field_to_protect.FieldToProtect"
    """<p>Specifies the field type and optional keys to apply the protection behavior to. </p>"""
    action: "capo_wafv2.types.data_protection_action.DataProtectionAction"
    """<p>Specifies how to protect the field. WAF can apply a one-way hash to the field or hard code a string substitution. </p> <ul> <li> <p>One-way hash example: <code>ade099751dEXAMPLEHASH2ea9f3393f80dd5d3bEXAMPLEHASH966ae0d3cd5a1e</code> </p> </li> <li> <p>Substitution example: <code>REDACTED</code> </p> </li> </ul>"""
    exclude_rule_match_details: "capo_wafv2.types.boolean.Boolean"
    """<p>Specifies whether to also exclude any rule match details from the data protection you have enabled for a given field. WAF logs these details for non-terminating matching rules and for the terminating matching rule. For additional information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html">Log fields for web ACL traffic</a> in the <i>WAF Developer Guide</i>.</p> <p>Default: <code>FALSE</code> </p>"""
    exclude_rate_based_details: "capo_wafv2.types.boolean.Boolean"
    """<p>Specifies whether to also exclude any rate-based rule details from the data protection you have enabled for a given field. If you specify this exception, RateBasedDetails will show the value of the field. For additional information, see the log field <code>rateBasedRuleList</code> at <a href="https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html">Log fields for web ACL traffic</a> in the <i>WAF Developer Guide</i>.</p> <p>Default: <code>FALSE</code> </p>"""

action instance-attribute 

action: DataProtectionAction

Specifies how to protect the field. WAF can apply a one-way hash to the field or hard code a string substitution.

  • One-way hash example: ade099751dEXAMPLEHASH2ea9f3393f80dd5d3bEXAMPLEHASH966ae0d3cd5a1e

  • Substitution example: REDACTED

exclude_rate_based_details instance-attribute 

exclude_rate_based_details: Boolean

Specifies whether to also exclude any rate-based rule details from the data protection you have enabled for a given field. If you specify this exception, RateBasedDetails will show the value of the field. For additional information, see the log field rateBasedRuleList at Log fields for web ACL traffic in the WAF Developer Guide.

Default: FALSE

exclude_rule_match_details instance-attribute 

exclude_rule_match_details: Boolean

Specifies whether to also exclude any rule match details from the data protection you have enabled for a given field. WAF logs these details for non-terminating matching rules and for the terminating matching rule. For additional information, see Log fields for web ACL traffic in the WAF Developer Guide.

Default: FALSE

field instance-attribute 

field: FieldToProtect

Specifies the field type and optional keys to apply the protection behavior to.