Class FirewallPolicyDetails

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

Defines the behavior of the firewall.

See Also:

  • Method Details

    • hasStatefulRuleGroupReferences

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

    • statefulRuleGroupReferences

      public final List<FirewallPolicyStatefulRuleGroupReferencesDetails> statefulRuleGroupReferences()

      The stateful rule groups that are used in the firewall policy.

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

      Returns:
      The stateful rule groups that are used in the firewall policy.

    • hasStatelessCustomActions

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

    • statelessCustomActions

      public final List<FirewallPolicyStatelessCustomActionsDetails> statelessCustomActions()

      The custom action definitions that are available to use in the firewall policy's StatelessDefaultActions setting.

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

      Returns:
      The custom action definitions that are available to use in the firewall policy's StatelessDefaultActions setting.

    • hasStatelessDefaultActions

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

    • statelessDefaultActions

      public final List<String> statelessDefaultActions()

      The actions to take on a packet if it doesn't match any of the stateless rules in the policy.

      You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe ), and can optionally include a custom action from StatelessCustomActions.

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

      Returns:
      The actions to take on a packet if it doesn't match any of the stateless rules in the policy.

      You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe), and can optionally include a custom action from StatelessCustomActions.

    • hasStatelessFragmentDefaultActions

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

    • statelessFragmentDefaultActions

      public final List<String> statelessFragmentDefaultActions()

      The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy.

      You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe ), and can optionally include a custom action from StatelessCustomActions.

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

      Returns:
      The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy.

      You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe), and can optionally include a custom action from StatelessCustomActions.

    • hasStatelessRuleGroupReferences

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

    • statelessRuleGroupReferences

      public final List<FirewallPolicyStatelessRuleGroupReferencesDetails> statelessRuleGroupReferences()

      The stateless rule groups that are used in the firewall policy.

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

      Returns:
      The stateless rule groups that are used in the firewall policy.

    • toBuilder

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

    • builder

      public static FirewallPolicyDetails.Builder builder()

    • serializableBuilderClass

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