Class 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:
    Serialized Form
    • Method Detail

      • 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.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)