Class FirewallRuleGroup

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

The object that defines a firewall engine rule group, for use in a Next Generation policy. A firewall engine rule group provides access-control rules that the firewall engine evaluates at connection-state hooks. You provide the rules as a Suricata-compatible rule string, as structured firewall rules, or generated from a list of domain names. For more information, see Rule groups for a firewall using a Next Generation policy in the Network Firewall Developer Guide.

See Also:

  • Method Details

    • rulesSource

      public final FirewallRulesSource rulesSource()

      The stateful inspection criteria for the firewall engine rule group.

      Returns:
      The stateful inspection criteria for the firewall engine rule group.

    • ruleVariables

      public final RuleVariables ruleVariables()

      Settings that are available for use in the rules in the firewall engine rule group, such as IP set and port variables that the rules reference.

      Returns:
      Settings that are available for use in the rules in the firewall engine rule group, such as IP set and port variables that the rules reference.

    • referenceSets

      public final ReferenceSets referenceSets()

      The list of a rule group's reference sets. Firewall engine rule groups don't support IP set references (reference sets); this setting applies to IPS engine rule groups. To use CIDR ranges in firewall engine rules, use rule variables instead.

      Returns:
      The list of a rule group's reference sets. Firewall engine rule groups don't support IP set references (reference sets); this setting applies to IPS engine rule groups. To use CIDR ranges in firewall engine rules, use rule variables instead.

    • toBuilder

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

    • builder

      public static FirewallRuleGroup.Builder builder()

    • serializableBuilderClass

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