Package software.amazon.awssdk.services.networkfirewall.model

Class RulesSource

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

The stateless or stateful rules definitions for use in a single rule group. Each rule group requires a single RulesSource. You can use an instance of this for either stateless rules or stateful rules.

See Also:

  • Method Details

    • rulesString

      public final String rulesString()

      Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection.

      These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.

      You can't use the priority keyword if the RuleOrder option in StatefulRuleOptions is set to STRICT_ORDER.

      Returns:
      Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection.

      These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.

      You can't use the priority keyword if the RuleOrder option in StatefulRuleOptions is set to STRICT_ORDER.

    • rulesSourceList

      public final RulesSourceList rulesSourceList()

      Stateful inspection criteria for a domain list rule group.

      Returns:
      Stateful inspection criteria for a domain list rule group.

    • hasStatefulRules

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

    • statefulRules

      public final List<StatefulRule> statefulRules()

      An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.

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

      Returns:
      An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.

    • statelessRulesAndCustomActions

      public final StatelessRulesAndCustomActions statelessRulesAndCustomActions()

      Stateless inspection criteria to be used in a stateless rule group.

      Returns:
      Stateless inspection criteria to be used in a stateless rule group.

    • toBuilder

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

    • builder

      public static RulesSource.Builder builder()

    • serializableBuilderClass

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