Class CustomAction

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

An optional, non-standard action to use for stateless packet handling. You can define this in addition to the standard action that you must specify.

You define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings.

You can use custom actions in the following places:

  • In a rule group's StatelessRulesAndCustomActions specification. The custom actions are available for use by name inside the StatelessRulesAndCustomActions where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule's match attributes.

  • In a FirewallPolicy specification, in StatelessCustomActions. The custom actions are available for use inside the policy where you define them. You can use them for the policy's default stateless actions settings to specify what to do with packets that don't match any of the policy's stateless rules.

See Also:

  • Method Details

    • actionName

      public final String actionName()

      The descriptive name of the custom action. You can't change the name of a custom action after you create it.

      Returns:
      The descriptive name of the custom action. You can't change the name of a custom action after you create it.

    • actionDefinition

      public final ActionDefinition actionDefinition()

      The custom action associated with the action name.

      Returns:
      The custom action associated with the action name.

    • toBuilder

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

    • builder

      public static CustomAction.Builder builder()

    • serializableBuilderClass

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