Class RulesSourceList

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

Stateful inspection criteria for a domain list rule group.

For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.

By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.

See Also:

  • Method Details

    • hasTargets

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

    • targets

      public final List<String> targets()

      The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:

      • Explicit names. For example, abc.example.com matches only the domain abc.example.com.

      • Names that use a domain wildcard, which you indicate with an initial '.'. For example, .example.com matches example.com and matches all subdomains of example.com , such as abc.example.com and www.example.com.

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

      Returns:
      The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:

      • Explicit names. For example, abc.example.com matches only the domain abc.example.com.

      • Names that use a domain wildcard, which you indicate with an initial '.'. For example, .example.com matches example.com and matches all subdomains of example.com, such as abc.example.com and www.example.com.

    • targetTypes

      public final List<TargetType> targetTypes()

      The protocols you want to inspect. Specify TLS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.

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

      Returns:
      The protocols you want to inspect. Specify TLS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.

    • hasTargetTypes

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

    • targetTypesAsStrings

      public final List<String> targetTypesAsStrings()

      The protocols you want to inspect. Specify TLS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.

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

      Returns:
      The protocols you want to inspect. Specify TLS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.

    • generatedRulesType

      public final GeneratedRulesType generatedRulesType()

      Whether you want to allow or deny access to the domains in your target list.

      If the service returns an enum value that is not available in the current SDK version, generatedRulesType will return GeneratedRulesType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from generatedRulesTypeAsString().

      Returns:
      Whether you want to allow or deny access to the domains in your target list.
      See Also:

    • generatedRulesTypeAsString

      public final String generatedRulesTypeAsString()

      Whether you want to allow or deny access to the domains in your target list.

      If the service returns an enum value that is not available in the current SDK version, generatedRulesType will return GeneratedRulesType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from generatedRulesTypeAsString().

      Returns:
      Whether you want to allow or deny access to the domains in your target list.
      See Also:

    • toBuilder

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

    • builder

      public static RulesSourceList.Builder builder()

    • serializableBuilderClass

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