Class AnalyticsConfig

java.lang.Object
software.amazon.awssdk.services.wafv2.model.AnalyticsConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AnalyticsConfig.Builder,AnalyticsConfig>

@Generated("software.amazon.awssdk:codegen") public final class AnalyticsConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AnalyticsConfig.Builder,AnalyticsConfig>

Specifies the security analytics configuration for the web ACL. Security analytics shows the web ACL's request log data from multiple Amazon Web Services Regions in a single dashboard in the WAF console.

When you enable security analytics, you authorize Amazon Web Services to transfer and store full request logs outside the Amazon Web Services Region where the web ACL is hosted. For regional web ACLs, security analytics is disabled by default when you omit this configuration. For web ACLs that protect CloudFront distributions (global web ACLs), security analytics is enabled by default. For more information, see Enabling security analytics for a protection pack (web ACL) in the WAF Developer Guide.

See Also:
  • Method Details

    • mode

      public final AnalyticsMode mode()

      The security analytics mode for the web ACL. Valid values:

      • CROSS_REGION - Enables security analytics. WAF transfers and stores the web ACL's request logs outside the Amazon Web Services Region where the web ACL is hosted, for aggregation and processing.

      • DISABLED - Disables security analytics. WAF stops transferring the web ACL's request logs.

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

      Returns:
      The security analytics mode for the web ACL. Valid values:

      • CROSS_REGION - Enables security analytics. WAF transfers and stores the web ACL's request logs outside the Amazon Web Services Region where the web ACL is hosted, for aggregation and processing.

      • DISABLED - Disables security analytics. WAF stops transferring the web ACL's request logs.

      See Also:
    • modeAsString

      public final String modeAsString()

      The security analytics mode for the web ACL. Valid values:

      • CROSS_REGION - Enables security analytics. WAF transfers and stores the web ACL's request logs outside the Amazon Web Services Region where the web ACL is hosted, for aggregation and processing.

      • DISABLED - Disables security analytics. WAF stops transferring the web ACL's request logs.

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

      Returns:
      The security analytics mode for the web ACL. Valid values:

      • CROSS_REGION - Enables security analytics. WAF transfers and stores the web ACL's request logs outside the Amazon Web Services Region where the web ACL is hosted, for aggregation and processing.

      • DISABLED - Disables security analytics. WAF stops transferring the web ACL's request logs.

      See Also:
    • toBuilder

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

      public static AnalyticsConfig.Builder builder()
    • serializableBuilderClass

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