Class DataProtection

java.lang.Object
software.amazon.awssdk.services.wafv2.model.DataProtection
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DataProtection.Builder,DataProtection>
@Generated("software.amazon.awssdk:codegen") public final class DataProtection extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DataProtection.Builder,DataProtection>

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

See Also:

  • Method Details

    • field

      public final FieldToProtect field()

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

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

    • action

      public final DataProtectionAction action()

      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

      If the service returns an enum value that is not available in the current SDK version, action will return DataProtectionAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

      Returns:
      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

      See Also:

    • actionAsString

      public final String actionAsString()

      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

      If the service returns an enum value that is not available in the current SDK version, action will return DataProtectionAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

      Returns:
      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

      See Also:

    • excludeRuleMatchDetails

      public final Boolean excludeRuleMatchDetails()

      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

      Returns:
      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

    • excludeRateBasedDetails

      public final Boolean excludeRateBasedDetails()

      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

      Returns:
      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

    • toBuilder

      public DataProtection.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DataProtection.Builder,DataProtection>
      Returns:
      a builder for type T

    • builder

      public static DataProtection.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DataProtection.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.