Class ParseWAF

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

Use this processor to parse WAF vended logs, extract fields, and and convert them into a JSON format. This processor always processes the entire log event message. For more information about this processor including examples, see parseWAF.

For more information about WAF log format, see Log examples for web ACL traffic.

If you use this processor, it must be the first processor in your transformer.

See Also:

  • Method Details

    • source

      public final String source()

      Omit this parameter and the whole log message will be processed by this processor. No other value than @message is allowed for source.

      Returns:
      Omit this parameter and the whole log message will be processed by this processor. No other value than @message is allowed for source.

    • toBuilder

      public ParseWAF.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<ParseWAF.Builder,ParseWAF>
      Returns:
      a builder for type T

    • builder

      public static ParseWAF.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ParseWAF.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.