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

Class ManagedRuleGroupConfig

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

Additional information that's used by a managed rule group. Many managed rule groups don't require this.

The rule groups used for intelligent threat mitigation require additional configuration:

  • Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields.

  • Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password.

  • Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

For example specifications, see the examples section of CreateWebACL.

See Also:

  • Method Details

    • loginPath

      @Deprecated public final String loginPath()
      Deprecated.
      Deprecated. Use AWSManagedRulesATPRuleSet LoginPath

      Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

      Returns:

      Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

    • payloadType

      @Deprecated public final PayloadType payloadType()
      Deprecated.
      Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PayloadType

      Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

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

      Returns:

      Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

      See Also:

    • payloadTypeAsString

      @Deprecated public final String payloadTypeAsString()
      Deprecated.
      Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PayloadType

      Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

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

      Returns:

      Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

      See Also:

    • usernameField

      @Deprecated public final UsernameField usernameField()
      Deprecated.
      Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection UsernameField

      Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

      Returns:

      Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

    • passwordField

      @Deprecated public final PasswordField passwordField()
      Deprecated.
      Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PasswordField

      Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

      Returns:

      Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

    • awsManagedRulesBotControlRuleSet

      public final AWSManagedRulesBotControlRuleSet awsManagedRulesBotControlRuleSet()

      Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

      Returns:
      Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

    • awsManagedRulesATPRuleSet

      public final AWSManagedRulesATPRuleSet awsManagedRulesATPRuleSet()

      Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.

      This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

      For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.

      Returns:
      Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.

      This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

      For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.

    • awsManagedRulesACFPRuleSet

      public final AWSManagedRulesACFPRuleSet awsManagedRulesACFPRuleSet()

      Additional configuration for using the account creation fraud prevention (ACFP) managed rule group, AWSManagedRulesACFPRuleSet. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.

      For information about using the ACFP managed rule group, see WAF Fraud Control account creation fraud prevention (ACFP) rule group and WAF Fraud Control account creation fraud prevention (ACFP) in the WAF Developer Guide.

      Returns:
      Additional configuration for using the account creation fraud prevention (ACFP) managed rule group, AWSManagedRulesACFPRuleSet. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.

      For information about using the ACFP managed rule group, see WAF Fraud Control account creation fraud prevention (ACFP) rule group and WAF Fraud Control account creation fraud prevention (ACFP) in the WAF Developer Guide.

    • toBuilder

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

    • builder

      public static ManagedRuleGroupConfig.Builder builder()

    • serializableBuilderClass

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