IPSetForwardedIPConfig (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.IPSetForwardedIPConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IPSetForwardedIPConfig
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, WAF doesn't apply the rule to the web request at all.

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IPSetForwardedIPConfig()

Constructors
Constructor and Description
`IPSetForwardedIPConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IPSetForwardedIPConfig`	`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.
`String`	`getPosition()` The position in the header to search for the IP address.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `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.
`void`	`setPosition(String position)` The position in the header to search for the IP address.
`String`	`toString()` Returns a string representation of this object.
`IPSetForwardedIPConfig`	`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.
`IPSetForwardedIPConfig`	`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.
`IPSetForwardedIPConfig`	`withHeaderName(String headerName)` The name of the HTTP header to use for the IP address.
`IPSetForwardedIPConfig`	`withPosition(ForwardedIPPosition position)` The position in the header to search for the IP address.
`IPSetForwardedIPConfig`	`withPosition(String position)` The position in the header to search for the IP address.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IPSetForwardedIPConfig
```
public IPSetForwardedIPConfig()
```
- 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, 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, 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, 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.
  - withHeaderName
```
public IPSetForwardedIPConfig 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, 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, 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, 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.
    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, 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
  - 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, 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.
    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
  - withFallbackBehavior
```
public IPSetForwardedIPConfig 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, 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.
    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, 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FallbackBehavior
  - withFallbackBehavior
```
public IPSetForwardedIPConfig 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, 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.
    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, 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FallbackBehavior
  - setPosition
```
public void setPosition(String position)
```
    The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.
    
    The options for this setting are the following:
    - FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
    - LAST - Inspect the last IP address in the list of IP addresses in the header.
    - ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.
    Parameters:
    position - The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.
    
    The options for this setting are the following:
    
    FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
    
    LAST - Inspect the last IP address in the list of IP addresses in the header.
    
    ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.
    See Also:
    
    ForwardedIPPosition
  - getPosition
```
public String getPosition()
```
    The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.
    
    The options for this setting are the following:
    - FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
    - LAST - Inspect the last IP address in the list of IP addresses in the header.
    - ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.
    Returns:
    The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.
    
    The options for this setting are the following:
    
    FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
    
    LAST - Inspect the last IP address in the list of IP addresses in the header.
    
    ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.
    See Also:
    
    ForwardedIPPosition
  - withPosition
```
public IPSetForwardedIPConfig withPosition(String position)
```
    The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.
    
    The options for this setting are the following:
    - FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
    - LAST - Inspect the last IP address in the list of IP addresses in the header.
    - ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.
    Parameters:
    position - The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.
    
    The options for this setting are the following:
    
    FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
    
    LAST - Inspect the last IP address in the list of IP addresses in the header.
    
    ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ForwardedIPPosition
  - withPosition
```
public IPSetForwardedIPConfig withPosition(ForwardedIPPosition position)
```
    The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.
    
    The options for this setting are the following:
    - FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
    - LAST - Inspect the last IP address in the list of IP addresses in the header.
    - ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.
    Parameters:
    position - The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.
    
    The options for this setting are the following:
    
    FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
    
    LAST - Inspect the last IP address in the list of IP addresses in the header.
    
    ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ForwardedIPPosition
  - 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 IPSetForwardedIPConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class IPSetForwardedIPConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IPSetForwardedIPConfig

Method Detail

setHeaderName

getHeaderName

withHeaderName

setFallbackBehavior

getFallbackBehavior

withFallbackBehavior

withFallbackBehavior

setPosition

getPosition

withPosition

withPosition

toString

equals

hashCode

clone

marshall