Class RuleGroupReferenceStatement

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

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the entity.

      Returns:
      The Amazon Resource Name (ARN) of the entity.

    • 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<ExcludedRule> excludedRules()

      Rules in the referenced rule group whose actions are set to Count.

      Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

      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 in the referenced rule group whose actions are set to Count.

      Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

    • hasRuleActionOverrides

      public final boolean hasRuleActionOverrides()
      For responses, this returns true if the service returned a value for the RuleActionOverrides 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.

    • ruleActionOverrides

      public final List<RuleActionOverride> ruleActionOverrides()

      Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

      Verify the rule names in your overrides carefully. With managed rule groups, WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.

      You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

      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 hasRuleActionOverrides() method.

      Returns:
      Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

      Verify the rule names in your overrides carefully. With managed rule groups, WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.

      You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

    • toBuilder

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

    • builder

      public static RuleGroupReferenceStatement.Builder builder()

    • serializableBuilderClass

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