Class AwsWafWebAclRule

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

Details for a rule in an WAF web ACL.

See Also:

  • Method Details

    • action

      public final WafAction action()

      Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.

      Returns:
      Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.

    • hasExcludedRules

      public final boolean hasExcludedRules()
      For responses, this returns true if the service returned a value for the ExcludedRules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • excludedRules

      public final List<WafExcludedRule> excludedRules()

      Rules to exclude from a rule group.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExcludedRules() method.

      Returns:
      Rules to exclude from a rule group.

    • overrideAction

      public final WafOverrideAction overrideAction()

      Use the OverrideAction to test your RuleGroup.

      Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request.

      However, if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.

      ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a web ACL. In this case you don't use ActivatedRule Action. For all other update requests, ActivatedRule Action is used instead of ActivatedRule OverrideAction.

      Returns:
      Use the OverrideAction to test your RuleGroup.

      Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request.

      However, if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.

      ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a web ACL. In this case you don't use ActivatedRule Action. For all other update requests, ActivatedRule Action is used instead of ActivatedRule OverrideAction.

    • priority

      public final Integer priority()

      Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for Priority are evaluated before rules with a higher value. The value must be a unique integer. If you add multiple rules to a web ACL, the values don't need to be consecutive.

      Returns:
      Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for Priority are evaluated before rules with a higher value. The value must be a unique integer. If you add multiple rules to a web ACL, the values don't need to be consecutive.

    • ruleId

      public final String ruleId()

      The identifier for a rule.

      Returns:
      The identifier for a rule.

    • type

      public final String type()

      The rule type.

      Valid values: REGULAR | RATE_BASED | GROUP

      The default is REGULAR.

      Returns:
      The rule type.

      Valid values: REGULAR | RATE_BASED | GROUP

      The default is REGULAR.

    • toBuilder

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

    • builder

      public static AwsWafWebAclRule.Builder builder()

    • serializableBuilderClass

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