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

Class IPSetReferenceStatement

java.lang.Object

software.amazon.awssdk.services.wafv2.model.IPSetReferenceStatement

All Implemented Interfaces:

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

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

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IPSetReferenceStatement.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the IPSet that this statement references.
static IPSetReferenceStatement.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IPSetForwardedIPConfig	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.
List<SdkField<?>>	sdkFields()
static Class<? extends IPSetReferenceStatement.Builder>	serializableBuilderClass()
IPSetReferenceStatement.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

arn

public final String arn()

The Amazon Resource Name (ARN) of the IPSet that this statement references.

Returns:

The Amazon Resource Name (ARN) of the IPSet that this statement references.

ipSetForwardedIPConfig

public final IPSetForwardedIPConfig 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.

Returns:

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.

toBuilder

public IPSetReferenceStatement.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IPSetReferenceStatement.Builder,IPSetReferenceStatement>

builder

public static IPSetReferenceStatement.Builder builder()

serializableBuilderClass

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