software.amazon.awssdk.services.networkfirewall.model

Interface StatefulRule.Builder

All Superinterfaces:

Buildable, CopyableBuilder<StatefulRule.Builder,StatefulRule>, SdkBuilder<StatefulRule.Builder,StatefulRule>, SdkPojo

Enclosing class:

StatefulRule

public static interface StatefulRule.Builder
extends SdkPojo, CopyableBuilder<StatefulRule.Builder,StatefulRule>

Method Summary

Modifier and Type	Method and Description
StatefulRule.Builder	action(StatefulAction action) Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.
StatefulRule.Builder	action(String action) Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.
default StatefulRule.Builder	header(Consumer<Header.Builder> header) The stateful inspection criteria for this rule, used to inspect traffic flows.
StatefulRule.Builder	header(Header header) The stateful inspection criteria for this rule, used to inspect traffic flows.
StatefulRule.Builder	ruleOptions(Collection<RuleOption> ruleOptions) Additional options for the rule.
StatefulRule.Builder	ruleOptions(Consumer<RuleOption.Builder>... ruleOptions) Additional options for the rule.
StatefulRule.Builder	ruleOptions(RuleOption... ruleOptions) Additional options for the rule.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

action

StatefulRule.Builder action(String 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.

• REJECT - Drops TCP traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a RST bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the Firewall LoggingConfiguration.

  REJECT isn't currently available for use with IMAP and FTP protocols.

Parameters:

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.

• REJECT - Drops TCP traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a RST bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the Firewall LoggingConfiguration.

  REJECT isn't currently available for use with IMAP and FTP protocols.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StatefulAction, StatefulAction

action

StatefulRule.Builder action(StatefulAction 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.

• REJECT - Drops TCP traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a RST bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the Firewall LoggingConfiguration.

  REJECT isn't currently available for use with IMAP and FTP protocols.

Parameters:

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.

• REJECT - Drops TCP traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a RST bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the Firewall LoggingConfiguration.

  REJECT isn't currently available for use with IMAP and FTP protocols.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StatefulAction, StatefulAction

header

StatefulRule.Builder header(Header header)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

header

default StatefulRule.Builder header(Consumer<Header.Builder> header)

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

This is a convenience method that creates an instance of the Header.Builder avoiding the need to create one manually via Header.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to header(Header).

Parameters:

header - a consumer that will call methods on Header.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

header(Header)

ruleOptions

StatefulRule.Builder ruleOptions(Collection<RuleOption> ruleOptions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

ruleOptions

StatefulRule.Builder ruleOptions(RuleOption... ruleOptions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

ruleOptions

StatefulRule.Builder ruleOptions(Consumer<RuleOption.Builder>... ruleOptions)

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

This is a convenience method that creates an instance of the RuleOption.Builder avoiding the need to create one manually via RuleOption.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #ruleOptions(List).

Parameters:

ruleOptions - a consumer that will call methods on RuleOption.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#ruleOptions(java.util.Collection)