Class: Aws::NetworkFirewall::Types::CustomAction

Inherits:

Struct

Object
Struct
Aws::NetworkFirewall::Types::CustomAction

show all

Defined in:: gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb

Overview

Note:

When making an API call, you may pass CustomAction data as a hash:

{
  action_name: "ActionName", # required
  action_definition: { # required
    publish_metric_action: {
      dimensions: [ # required
        {
          value: "DimensionValue", # required
        },
      ],
    },
  },
}

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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#action_definition ⇒ Types::ActionDefinition
The custom action associated with the action name.
#action_name ⇒ String
The descriptive name of the custom action.

Instance Attribute Details

#action_definition ⇒ `Types::ActionDefinition`

The custom action associated with the action name.

Returns:

(Types::ActionDefinition)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 986

class CustomAction < Struct.new(
  :action_name,
  :action_definition)
  SENSITIVE = []
  include Aws::Structure
end

#action_name ⇒ `String`

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