Package software.amazon.awssdk.services.wafv2.model

Class AWSManagedRulesBotControlRuleSet

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

Details for your use of the Bot Control managed rule group, AWSManagedRulesBotControlRuleSet. This configuration is used in ManagedRuleGroupConfig.

See Also:

  • Method Details

    • inspectionLevel

      public final InspectionLevel inspectionLevel()

      The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group in the WAF Developer Guide.

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

      Returns:
      The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group in the WAF Developer Guide.
      See Also:

    • inspectionLevelAsString

      public final String inspectionLevelAsString()

      The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group in the WAF Developer Guide.

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

      Returns:
      The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group in the WAF Developer Guide.
      See Also:

    • enableMachineLearning

      public final Boolean enableMachineLearning()

      Applies only to the targeted inspection level.

      Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate distributed, coordinated bot activity.

      For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.

      Default: TRUE

      Returns:
      Applies only to the targeted inspection level.

      Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate distributed, coordinated bot activity.

      For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.

      Default: TRUE

    • toBuilder

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

    • builder

      public static AWSManagedRulesBotControlRuleSet.Builder builder()

    • serializableBuilderClass

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