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.StatefulRule

Description

 
Synopsis

Documentation

data StatefulRule Source #

A single Suricata rules specification, for use in a stateful rule group. Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.

See: newStatefulRule smart constructor.

Constructors

StatefulRule' 

Fields

  • action :: StatefulAction

    Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.

    The actions for a stateful rule are defined as follows:

    • PASS - Permits the packets to go to the intended destination.
    • DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

    • ALERT - Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

      You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.

  • header :: Header

    The stateful inspection criteria for this rule, used to inspect traffic flows.

  • ruleOptions :: [RuleOption]

    Additional options for the rule. These are the Suricata RuleOptions settings.

Instances

Instances details
Eq StatefulRule Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.StatefulRule

Methods

(==) :: StatefulRule -> StatefulRule -> Bool #

(/=) :: StatefulRule -> StatefulRule -> Bool #

Read StatefulRule Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.StatefulRule

Methods

readsPrec :: Int -> ReadS StatefulRule #

readList :: ReadS [StatefulRule] #

readPrec :: ReadPrec StatefulRule #

readListPrec :: ReadPrec [StatefulRule] #

Show StatefulRule Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.StatefulRule

Methods

showsPrec :: Int -> StatefulRule -> ShowS #

show :: StatefulRule -> String #

showList :: [StatefulRule] -> ShowS #

Generic StatefulRule Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.StatefulRule

Associated Types

type Rep StatefulRule :: Type -> Type #

Methods

from :: StatefulRule -> Rep StatefulRule x #

to :: Rep StatefulRule x -> StatefulRule #

NFData StatefulRule Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.StatefulRule

Methods

rnf :: StatefulRule -> () #

Hashable StatefulRule Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.StatefulRule

Methods

hashWithSalt :: Int -> StatefulRule -> Int #

hash :: StatefulRule -> Int #

ToJSON StatefulRule Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.StatefulRule

Methods

toJSON :: StatefulRule -> Value #

toEncoding :: StatefulRule -> Encoding #

toJSONList :: [StatefulRule] -> Value #

toEncodingList :: [StatefulRule] -> Encoding #

FromJSON StatefulRule Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.StatefulRule

Methods

parseJSON :: Value -> Parser StatefulRule #

parseJSONList :: Value -> Parser [StatefulRule] #

type Rep StatefulRule Source # 
Instance details

Defined in Amazonka.NetworkFirewall.Types.StatefulRule

type Rep StatefulRule = D1 ('MetaData "StatefulRule" "Amazonka.NetworkFirewall.Types.StatefulRule" "libZSservicesZSamazonka-network-firewallZSamazonka-network-firewall" 'False) (C1 ('MetaCons "StatefulRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StatefulAction) :*: (S1 ('MetaSel ('Just "header") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Header) :*: S1 ('MetaSel ('Just "ruleOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RuleOption]))))

newStatefulRule Source #

Arguments

:: StatefulAction

$sel:action:StatefulRule'

-> Header

$sel:header:StatefulRule'

-> StatefulRule 

Create a value of StatefulRule 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:action:StatefulRule', statefulRule_action - Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.

The actions for a stateful rule are defined as follows:

  • PASS - Permits the packets to go to the intended destination.
  • DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

  • ALERT - Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

    You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.

$sel:header:StatefulRule', statefulRule_header - The stateful inspection criteria for this rule, used to inspect traffic flows.

$sel:ruleOptions:StatefulRule', statefulRule_ruleOptions - Additional options for the rule. These are the Suricata RuleOptions settings.

statefulRule_action :: Lens' StatefulRule StatefulAction Source #

Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.

The actions for a stateful rule are defined as follows:

  • PASS - Permits the packets to go to the intended destination.
  • DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

  • ALERT - Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

    You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.

statefulRule_header :: Lens' StatefulRule Header Source #

The stateful inspection criteria for this rule, used to inspect traffic flows.

statefulRule_ruleOptions :: Lens' StatefulRule [RuleOption] Source #

Additional options for the rule. These are the Suricata RuleOptions settings.