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:

FirewallIntrusion DetectionNetwork SecurityVPC

Properties

Name Type Description
ActionName object
ActionDefinition object
View JSON Schema on GitHub

JSON Schema

openapi-custom-action-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-network-firewall/refs/heads/main/json-schema/openapi-custom-action-schema.json",
  "title": "CustomAction",
  "description": "<p>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. </p> <p>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. </p> <p>You can use custom actions in the following places: </p> <ul> <li> <p>In a rule group's <a>StatelessRulesAndCustomActions</a> specification. The custom actions are available for use by name inside the <code>StatelessRulesAndCustomActions</code> 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. </p> </li> <li> <p>In a <a>FirewallPolicy</a> specification, in <code>StatelessCustomActions</code>. 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. </p> </li> </ul>",
  "type": "object",
  "properties": {
    "ActionName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ActionName"
        },
        {
          "description": "The descriptive name of the custom action. You can't change the name of a custom action after you create it."
        }
      ]
    },
    "ActionDefinition": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ActionDefinition"
        },
        {
          "description": "The custom action associated with the action name."
        }
      ]
    }
  },
  "required": [
    "ActionName",
    "ActionDefinition"
  ]
}