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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb

Overview

Note:

When making an API call, you may pass StatefulRule data as a 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 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

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.

Returns:

  • (String)


3930
3931
3932
3933
3934
3935
3936
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3930

class StatefulRule < Struct.new(
  :action,
  :header,
  :rule_options)
  SENSITIVE = []
  include Aws::Structure
end

#headerTypes::Header

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

Returns:



3930
3931
3932
3933
3934
3935
3936
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3930

class StatefulRule < Struct.new(
  :action,
  :header,
  :rule_options)
  SENSITIVE = []
  include Aws::Structure
end

#rule_optionsArray<Types::RuleOption>

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

Returns:



3930
3931
3932
3933
3934
3935
3936
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3930

class StatefulRule < Struct.new(
  :action,
  :header,
  :rule_options)
  SENSITIVE = []
  include Aws::Structure
end