software.amazon.awssdk.services.fms.model

Class NetworkFirewallPolicyDescription

java.lang.Object

software.amazon.awssdk.services.fms.model.NetworkFirewallPolicyDescription

All Implemented Interfaces:

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

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

The definition of the Network Firewall firewall policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NetworkFirewallPolicyDescription.Builder

Method Summary

Modifier and Type	Method and Description
static NetworkFirewallPolicyDescription.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStatefulDefaultActions() For responses, this returns true if the service returned a value for the StatefulDefaultActions property.
boolean	hasStatefulRuleGroups() For responses, this returns true if the service returned a value for the StatefulRuleGroups property.
boolean	hasStatelessCustomActions() For responses, this returns true if the service returned a value for the StatelessCustomActions property.
boolean	hasStatelessDefaultActions() For responses, this returns true if the service returned a value for the StatelessDefaultActions property.
boolean	hasStatelessFragmentDefaultActions() For responses, this returns true if the service returned a value for the StatelessFragmentDefaultActions property.
boolean	hasStatelessRuleGroups() For responses, this returns true if the service returned a value for the StatelessRuleGroups property.
List<SdkField<?>>	sdkFields()
static Class<? extends NetworkFirewallPolicyDescription.Builder>	serializableBuilderClass()
List<String>	statefulDefaultActions() The default actions to take on a packet that doesn't match any stateful rules.
StatefulEngineOptions	statefulEngineOptions() Additional options governing how Network Firewall handles stateful rules.
List<StatefulRuleGroup>	statefulRuleGroups() The stateful rule groups that are used in the Network Firewall firewall policy.
List<String>	statelessCustomActions() Names of custom actions that are available for use in the stateless default actions settings.
List<String>	statelessDefaultActions() The actions to take on packets that don't match any of the stateless rule groups.
List<String>	statelessFragmentDefaultActions() The actions to take on packet fragments that don't match any of the stateless rule groups.
List<StatelessRuleGroup>	statelessRuleGroups() The stateless rule groups that are used in the Network Firewall firewall policy.
NetworkFirewallPolicyDescription.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

hasStatelessRuleGroups

public final boolean hasStatelessRuleGroups()

For responses, this returns true if the service returned a value for the StatelessRuleGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

statelessRuleGroups

public final List<StatelessRuleGroup> statelessRuleGroups()

The stateless rule groups that are used in the Network Firewall firewall policy.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatelessRuleGroups() method.

Returns:

The stateless rule groups that are used in the Network Firewall firewall policy.

hasStatelessDefaultActions

public final boolean hasStatelessDefaultActions()

For responses, this returns true if the service returned a value for the StatelessDefaultActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

statelessDefaultActions

public final List<String> statelessDefaultActions()

The actions to take on packets that don't match any of the stateless rule groups.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatelessDefaultActions() method.

Returns:

The actions to take on packets that don't match any of the stateless rule groups.

hasStatelessFragmentDefaultActions

public final boolean hasStatelessFragmentDefaultActions()

For responses, this returns true if the service returned a value for the StatelessFragmentDefaultActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

statelessFragmentDefaultActions

public final List<String> statelessFragmentDefaultActions()

The actions to take on packet fragments that don't match any of the stateless rule groups.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatelessFragmentDefaultActions() method.

Returns:

The actions to take on packet fragments that don't match any of the stateless rule groups.

hasStatelessCustomActions

public final boolean hasStatelessCustomActions()

For responses, this returns true if the service returned a value for the StatelessCustomActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

statelessCustomActions

public final List<String> statelessCustomActions()

Names of custom actions that are available for use in the stateless default actions settings.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatelessCustomActions() method.

Returns:

Names of custom actions that are available for use in the stateless default actions settings.

hasStatefulRuleGroups

public final boolean hasStatefulRuleGroups()

For responses, this returns true if the service returned a value for the StatefulRuleGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

statefulRuleGroups

public final List<StatefulRuleGroup> statefulRuleGroups()

The stateful rule groups that are used in the Network Firewall firewall policy.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatefulRuleGroups() method.

Returns:

The stateful rule groups that are used in the Network Firewall firewall policy.

hasStatefulDefaultActions

public final boolean hasStatefulDefaultActions()

For responses, this returns true if the service returned a value for the StatefulDefaultActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

statefulDefaultActions

public final List<String> statefulDefaultActions()

The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.

Valid values of the stateful default action:

• aws:drop_strict

• aws:drop_established

• aws:alert_strict

• aws:alert_established

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatefulDefaultActions() method.

Returns:

The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.

Valid values of the stateful default action:

• aws:drop_strict

• aws:drop_established

• aws:alert_strict

• aws:alert_established

statefulEngineOptions

public final StatefulEngineOptions statefulEngineOptions()

Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.

Returns:

Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.

toBuilder

public NetworkFirewallPolicyDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NetworkFirewallPolicyDescription.Builder,NetworkFirewallPolicyDescription>

builder

public static NetworkFirewallPolicyDescription.Builder builder()

serializableBuilderClass

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