You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::NetworkFirewall::Types::StatefulRule

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StatefulRule as input to an Aws::Client method, you can use a vanilla Hash:

{
  action: "PASS", # required, accepts PASS, DROP, ALERT
  header: { # required
    protocol: "IP", # required, accepts IP, TCP, UDP, ICMP, HTTP, FTP, TLS, SMB, DNS, DCERPC, SSH, SMTP, IMAP, MSN, KRB5, IKEV2, TFTP, NTP, DHCP
    source: "Source", # required
    source_port: "Port", # required
    direction: "FORWARD", # required, accepts FORWARD, ANY
    destination: "Destination", # required
    destination_port: "Port", # required
  },
  rule_options: [ # required
    {
      keyword: "Keyword", # required
      settings: ["Setting"],
    },
  ],
}

A single 5-tuple stateful rule, for use in a stateful rule group.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

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.

    Possible values:

    • PASS
    • DROP
    • ALERT

Returns:

  • (String) —

    Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.

#header ⇒ Types::Header

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

Returns:

  • (Types::Header) —

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

#rule_options ⇒ Array<Types::RuleOption>

Returns: