com.amazonaws.services.wafv2.model

Class ForwardedIPConfig

java.lang.Object

com.amazonaws.services.wafv2.model.ForwardedIPConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ForwardedIPConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

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, AWS 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.

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ForwardedIPConfig()

Method Summary

Modifier and Type	Method and Description
ForwardedIPConfig	clone()
boolean	equals(Object obj)
String	getFallbackBehavior() The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
String	getHeaderName() The name of the HTTP header to use for the IP address.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setFallbackBehavior(String fallbackBehavior) The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
void	setHeaderName(String headerName) The name of the HTTP header to use for the IP address.
String	toString() Returns a string representation of this object.
ForwardedIPConfig	withFallbackBehavior(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.
ForwardedIPConfig	withFallbackBehavior(String fallbackBehavior) The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
ForwardedIPConfig	withHeaderName(String headerName) The name of the HTTP header to use for the IP address.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardedIPConfig

public ForwardedIPConfig()

Method Detail

setHeaderName

public void setHeaderName(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, AWS WAF doesn't apply the rule to the web request at all.

Parameters:

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, AWS WAF doesn't apply the rule to the web request at all.

getHeaderName

public String getHeaderName()

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, AWS 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, AWS WAF doesn't apply the rule to the web request at all.

withHeaderName

public ForwardedIPConfig withHeaderName(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, AWS WAF doesn't apply the rule to the web request at all.

Parameters:

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, AWS WAF doesn't apply the rule to the web request at all.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFallbackBehavior

public void setFallbackBehavior(String 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, AWS 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. AWS WAF applies the rule action to the request.

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

Parameters:

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, AWS 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. AWS WAF applies the rule action to the request.

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

See Also:

FallbackBehavior

getFallbackBehavior

public String getFallbackBehavior()

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, AWS 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. AWS WAF applies the rule action to the request.

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

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, AWS 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. AWS WAF applies the rule action to the request.

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

See Also:

FallbackBehavior

withFallbackBehavior

public ForwardedIPConfig withFallbackBehavior(String 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, AWS 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. AWS WAF applies the rule action to the request.

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

Parameters:

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, AWS 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. AWS WAF applies the rule action to the request.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FallbackBehavior

withFallbackBehavior

public ForwardedIPConfig withFallbackBehavior(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, AWS 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. AWS WAF applies the rule action to the request.

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

Parameters:

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, AWS 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. AWS WAF applies the rule action to the request.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FallbackBehavior

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ForwardedIPConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo