libZSservicesZSamazonka-network-firewallZSamazonka-network-firewall
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.NetworkFirewall.Types.RuleDefinition

Description

 
Synopsis

Documentation

data RuleDefinition Source #

The inspection criteria and action for a single stateless rule. AWS Network Firewall inspects each packet for the specified matching criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on the packet.

See: newRuleDefinition smart constructor.

Constructors

RuleDefinition' 

Fields

  • matchAttributes :: MatchAttributes

    Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.

  • actions :: [Text]

    The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.

    Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.

    For every rule, you must specify exactly one of the following standard actions.

    • aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
    • aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
    • aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.

    Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.

    To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”].

Instances

Instances details
Eq RuleDefinition Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.RuleDefinition

Read RuleDefinition Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.RuleDefinition

Show RuleDefinition Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.RuleDefinition

Generic RuleDefinition Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.RuleDefinition

Associated Types

type Rep RuleDefinition :: Type -> Type #

NFData RuleDefinition Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.RuleDefinition

Methods

rnf :: RuleDefinition -> () #

Hashable RuleDefinition Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.RuleDefinition

ToJSON RuleDefinition Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.RuleDefinition

FromJSON RuleDefinition Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.RuleDefinition

type Rep RuleDefinition Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.RuleDefinition

type Rep RuleDefinition = D1 ('MetaData "RuleDefinition" "Amazonka.NetworkFirewall.Types.RuleDefinition" "libZSservicesZSamazonka-network-firewallZSamazonka-network-firewall" 'False) (C1 ('MetaCons "RuleDefinition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "matchAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MatchAttributes) :*: S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newRuleDefinition Source #

Create a value of RuleDefinition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:matchAttributes:RuleDefinition', ruleDefinition_matchAttributes - Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.

$sel:actions:RuleDefinition', ruleDefinition_actions - The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.

Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.

For every rule, you must specify exactly one of the following standard actions.

  • aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
  • aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
  • aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.

Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.

To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”].

ruleDefinition_matchAttributes :: Lens' RuleDefinition MatchAttributes Source #

Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.

ruleDefinition_actions :: Lens' RuleDefinition [Text] Source #

The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.

Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.

For every rule, you must specify exactly one of the following standard actions.

  • aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
  • aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
  • aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.

Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.

To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”].