Class VisibilityConfig

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

Defines and enables Amazon CloudWatch metrics and web request sample collection.

See Also:

  • Method Details

    • sampledRequestsEnabled

      public final Boolean sampledRequestsEnabled()

      Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

      If you configure data protection for the web ACL, the protection applies to the web ACL's sampled web request data.

      Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.

      Returns:
      Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

      If you configure data protection for the web ACL, the protection applies to the web ACL's sampled web request data.

      Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.

    • cloudWatchMetricsEnabled

      public final Boolean cloudWatchMetricsEnabled()

      Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.

      For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.

      Returns:
      Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.

      For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.

    • metricName

      public final String metricName()

      A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for WAF, for example All and Default_Action.

      Returns:
      A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for WAF, for example All and Default_Action.

    • toBuilder

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

    • builder

      public static VisibilityConfig.Builder builder()

    • serializableBuilderClass

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