software.amazon.awssdk.services.networkfirewall.model

Class StatefulRule

java.lang.Object

software.amazon.awssdk.services.networkfirewall.model.StatefulRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StatefulRule.Builder,StatefulRule>

@Generated(value="software.amazon.awssdk:codegen")
public final class StatefulRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StatefulRule.Builder,StatefulRule>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StatefulRule.Builder

Method Summary

Modifier and Type	Method and Description
StatefulAction	action() Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.
String	actionAsString() Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.
static StatefulRule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRuleOptions() Returns true if the RuleOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Header	header() The stateful 5-tuple inspection criteria for this rule, used to inspect traffic flows.
List<RuleOption>	ruleOptions()
List<SdkField<?>>	sdkFields()
static Class<? extends StatefulRule.Builder>	serializableBuilderClass()
StatefulRule.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

action

public final 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.

If the service returns an enum value that is not available in the current SDK version, action will return StatefulAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

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.

See Also:

StatefulAction

actionAsString

public final String actionAsString()

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.

If the service returns an enum value that is not available in the current SDK version, action will return StatefulAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

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.

See Also:

StatefulAction

header

public final Header header()

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

Returns:

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

hasRuleOptions

public final boolean hasRuleOptions()

Returns true if the RuleOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

ruleOptions

public final List<RuleOption> ruleOptions()

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasRuleOptions() to see if a value was sent in this field.

Returns:

toBuilder

public StatefulRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StatefulRule.Builder,StatefulRule>

builder

public static StatefulRule.Builder builder()

serializableBuilderClass

public static Class<? extends StatefulRule.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo