Package software.amazon.awssdk.services.wafv2.model

Class ForwardedIPConfig

java.lang.Object

software.amazon.awssdk.services.wafv2.model.ForwardedIPConfig

All Implemented Interfaces:

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

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

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

WAF only evaluates the first IP address found in the specified HTTP header.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ForwardedIPConfig.Builder

Method Summary

Modifier and Type	Method	Description
static ForwardedIPConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FallbackBehavior	fallbackBehavior()	The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
String	fallbackBehaviorAsString()	The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	headerName()	The name of the HTTP header to use for the IP address.
List<SdkField<?>>	sdkFields()
static Class<? extends ForwardedIPConfig.Builder>	serializableBuilderClass()
ForwardedIPConfig.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

headerName

public final String headerName()

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

Returns:

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

fallbackBehavior

public final FallbackBehavior fallbackBehavior()

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

You can specify the following fallback behaviors:

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

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

Returns:

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

You can specify the following fallback behaviors:

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

See Also:

FallbackBehavior

fallbackBehaviorAsString

public final String fallbackBehaviorAsString()

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

You can specify the following fallback behaviors:

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

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

Returns:

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

You can specify the following fallback behaviors:

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

See Also:

FallbackBehavior

toBuilder

public ForwardedIPConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ForwardedIPConfig.Builder,ForwardedIPConfig>

builder

public static ForwardedIPConfig.Builder builder()

serializableBuilderClass

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