Class: Aws::WAFV2::Types::DataProtection

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-wafv2/types.rb

Overview

Specifies the protection behavior for a field type. This is part of the data protection configuration for a web ACL.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

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`

Returns:

  • (String) 


1750
1751
1752
1753
1754
1755
1756
1757
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1750

class DataProtection < Struct.new(
  :field,
  :action,
  :exclude_rule_match_details,
  :exclude_rate_based_details)
  SENSITIVE = []
  include Aws::Structure
end

#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`

[1]: docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html

Returns:

  • (Boolean) 


1750
1751
1752
1753
1754
1755
1756
1757
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1750

class DataProtection < Struct.new(
  :field,
  :action,
  :exclude_rule_match_details,
  :exclude_rate_based_details)
  SENSITIVE = []
  include Aws::Structure
end

#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`

[1]: docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html

Returns:

  • (Boolean) 


1750
1751
1752
1753
1754
1755
1756
1757
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1750

class DataProtection < Struct.new(
  :field,
  :action,
  :exclude_rule_match_details,
  :exclude_rate_based_details)
  SENSITIVE = []
  include Aws::Structure
end

#field ⇒ Types::FieldToProtect

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

Returns:



1750
1751
1752
1753
1754
1755
1756
1757
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1750

class DataProtection < Struct.new(
  :field,
  :action,
  :exclude_rule_match_details,
  :exclude_rate_based_details)
  SENSITIVE = []
  include Aws::Structure
end