Interface DataProtection.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DataProtection.Builder,DataProtection>, SdkBuilder<DataProtection.Builder,DataProtection>, SdkPojo
Enclosing class:
DataProtection
@Mutable @NotThreadSafe public static interface DataProtection.Builder extends SdkPojo, CopyableBuilder<DataProtection.Builder,DataProtection>

  • Method Details

    • field

      DataProtection.Builder field(FieldToProtect field)

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

      Parameters:
      field - Specifies the field type and optional keys to apply the protection behavior to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • field

      default DataProtection.Builder field(Consumer<FieldToProtect.Builder> field)

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

      This is a convenience method that creates an instance of the FieldToProtect.Builder avoiding the need to create one manually via FieldToProtect.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to field(FieldToProtect).

      Parameters:
      field - a consumer that will call methods on FieldToProtect.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • action

      DataProtection.Builder action(String 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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • action

      DataProtection.Builder action(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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • excludeRuleMatchDetails

      DataProtection.Builder excludeRuleMatchDetails(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • excludeRateBasedDetails

      DataProtection.Builder excludeRateBasedDetails(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.