IPSetForwardedIPConfig (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.wafv2.model.IPSetForwardedIPConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IPSetForwardedIPConfig.Builder,IPSetForwardedIPConfig>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class IPSetForwardedIPConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IPSetForwardedIPConfig.Builder,IPSetForwardedIPConfig>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface IPSetForwardedIPConfig.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`IPSetForwardedIPConfig.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static IPSetForwardedIPConfig.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.
`ForwardedIPPosition`	`position()` The position in the header to search for the IP address.
`String`	`positionAsString()` The position in the header to search for the IP address.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends IPSetForwardedIPConfig.Builder>`	`serializableBuilderClass()`
`IPSetForwardedIPConfig.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
  - position
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, position will return ForwardedIPPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from positionAsString().
    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
  - positionAsString
```
public final String positionAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, position will return ForwardedIPPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from positionAsString().
    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
  - toBuilder
```
public IPSetForwardedIPConfig.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<IPSetForwardedIPConfig.Builder,IPSetForwardedIPConfig>
  - builder
```
public static IPSetForwardedIPConfig.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends IPSetForwardedIPConfig.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

Class IPSetForwardedIPConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

headerName

fallbackBehavior

fallbackBehaviorAsString

position

positionAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields