Class FirewallManagerRuleGroup

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

A rule group that's defined for an Firewall Manager WAF policy.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the rule group. You cannot change the name of a rule group after you create it.

      Returns:
      The name of the rule group. You cannot change the name of a rule group after you create it.

    • priority

      public final Integer priority()

      If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to be consecutive, but they must all be different.

      Returns:
      If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to be consecutive, but they must all be different.

    • firewallManagerStatement

      public final FirewallManagerStatement firewallManagerStatement()

      The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

      Returns:
      The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

    • overrideAction

      public final OverrideAction overrideAction()

      The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

      You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

      This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

      Returns:
      The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

      You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

      This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

    • visibilityConfig

      public final VisibilityConfig visibilityConfig()

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

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

    • toBuilder

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

    • builder

      public static FirewallManagerRuleGroup.Builder builder()

    • serializableBuilderClass

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