software.amazon.awssdk.services.networkfirewall.model

Class FirewallPolicy

java.lang.Object

software.amazon.awssdk.services.networkfirewall.model.FirewallPolicy

All Implemented Interfaces:

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

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

The firewall policy defines the behavior of a firewall using a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.

This, along with FirewallPolicyResponse, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FirewallPolicy.Builder

Method Summary

Modifier and Type	Method and Description
static FirewallPolicy.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStatefulRuleGroupReferences() Returns true if the StatefulRuleGroupReferences property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasStatelessCustomActions() Returns true if the StatelessCustomActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasStatelessDefaultActions() Returns true if the StatelessDefaultActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasStatelessFragmentDefaultActions() Returns true if the StatelessFragmentDefaultActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasStatelessRuleGroupReferences() Returns true if the StatelessRuleGroupReferences property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
static Class<? extends FirewallPolicy.Builder>	serializableBuilderClass()
List<StatefulRuleGroupReference>	statefulRuleGroupReferences() References to the stateless rule groups that are used in the policy.
List<CustomAction>	statelessCustomActions() The custom action definitions that are available for use in the firewall policy's StatelessDefaultActions setting.
List<String>	statelessDefaultActions() The actions to take on a packet if it doesn't match any of the stateless rules in the policy.
List<String>	statelessFragmentDefaultActions() The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy.
List<StatelessRuleGroupReference>	statelessRuleGroupReferences() References to the stateless rule groups that are used in the policy.
FirewallPolicy.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

hasStatelessRuleGroupReferences

public final boolean hasStatelessRuleGroupReferences()

Returns true if the StatelessRuleGroupReferences 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.

statelessRuleGroupReferences

public final List<StatelessRuleGroupReference> statelessRuleGroupReferences()

References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.

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

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

Returns:

References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.

hasStatelessDefaultActions

public final boolean hasStatelessDefaultActions()

Returns true if the StatelessDefaultActions 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.

statelessDefaultActions

public final List<String> statelessDefaultActions()

The actions to take on a packet if it doesn't match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.

You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.

For example, you could specify ["aws:pass"] or you could specify ["aws:pass", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.

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

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

Returns:

The actions to take on a packet if it doesn't match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.

You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.

For example, you could specify ["aws:pass"] or you could specify ["aws:pass", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.

hasStatelessFragmentDefaultActions

public final boolean hasStatelessFragmentDefaultActions()

Returns true if the StatelessFragmentDefaultActions 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.

statelessFragmentDefaultActions

public final List<String> statelessFragmentDefaultActions()

The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.

You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.

For example, you could specify ["aws:pass"] or you could specify ["aws:pass", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.

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

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

Returns:

The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.

You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.

For example, you could specify ["aws:pass"] or you could specify ["aws:pass", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.

hasStatelessCustomActions

public final boolean hasStatelessCustomActions()

Returns true if the StatelessCustomActions 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.

statelessCustomActions

public final List<CustomAction> statelessCustomActions()

The custom action definitions that are available for use in the firewall policy's StatelessDefaultActions setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.

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

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

Returns:

The custom action definitions that are available for use in the firewall policy's StatelessDefaultActions setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.

hasStatefulRuleGroupReferences

public final boolean hasStatefulRuleGroupReferences()

Returns true if the StatefulRuleGroupReferences 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.

statefulRuleGroupReferences

public final List<StatefulRuleGroupReference> statefulRuleGroupReferences()

References to the stateless rule groups that are used in the policy. These define the inspection criteria in stateful rules.

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

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

Returns:

References to the stateless rule groups that are used in the policy. These define the inspection criteria in stateful rules.

toBuilder

public FirewallPolicy.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FirewallPolicy.Builder,FirewallPolicy>

builder

public static FirewallPolicy.Builder builder()

serializableBuilderClass

public static Class<? extends FirewallPolicy.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