Package software.amazon.awssdk.services.networkfirewall.model

Class PolicyVariables

java.lang.Object

software.amazon.awssdk.services.networkfirewall.model.PolicyVariables

All Implemented Interfaces:

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

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

Contains variables that you can use to override default Suricata settings in your firewall policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PolicyVariables.Builder

Method Summary

Modifier and Type	Method	Description
static PolicyVariables.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRuleVariables()	For responses, this returns true if the service returned a value for the RuleVariables property.
Map<String,IPSet>	ruleVariables()	The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata HOME_NET variable.
List<SdkField<?>>	sdkFields()
static Class<? extends PolicyVariables.Builder>	serializableBuilderClass()
PolicyVariables.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

hasRuleVariables

public final boolean hasRuleVariables()

For responses, this returns true if the service returned a value for the RuleVariables 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.

ruleVariables

public final Map<String,IPSet> ruleVariables()

The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata HOME_NET variable. If your firewall uses an inspection VPC, you might want to override the HOME_NET variable with the CIDRs of your home networks. If you don't override HOME_NET with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.

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 hasRuleVariables() method.

Returns:

The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata HOME_NET variable. If your firewall uses an inspection VPC, you might want to override the HOME_NET variable with the CIDRs of your home networks. If you don't override HOME_NET with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.

toBuilder

public PolicyVariables.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PolicyVariables.Builder,PolicyVariables>

builder

public static PolicyVariables.Builder builder()

serializableBuilderClass

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