com.amazonaws.services.wafv2.model

Class IPSetReferenceStatement

java.lang.Object

com.amazonaws.services.wafv2.model.IPSetReferenceStatement

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IPSetReferenceStatement()

Method Summary

Modifier and Type	Method and Description
IPSetReferenceStatement	clone()
boolean	equals(Object obj)
String	getARN() The Amazon Resource Name (ARN) of the IPSet that this statement references.
IPSetForwardedIPConfig	getIPSetForwardedIPConfig() 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.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setARN(String aRN) The Amazon Resource Name (ARN) of the IPSet that this statement references.
void	setIPSetForwardedIPConfig(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.
String	toString() Returns a string representation of this object.
IPSetReferenceStatement	withARN(String aRN) The Amazon Resource Name (ARN) of the IPSet that this statement references.
IPSetReferenceStatement	withIPSetForwardedIPConfig(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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IPSetReferenceStatement

public IPSetReferenceStatement()

Method Detail

setARN

public void setARN(String aRN)

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

Parameters:

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

getARN

public String getARN()

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.

withARN

public IPSetReferenceStatement withARN(String aRN)

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

Parameters:

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

Returns:

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

setIPSetForwardedIPConfig

public void setIPSetForwardedIPConfig(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.

Parameters:

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.

getIPSetForwardedIPConfig

public IPSetForwardedIPConfig getIPSetForwardedIPConfig()

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.

withIPSetForwardedIPConfig

public IPSetReferenceStatement withIPSetForwardedIPConfig(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.

Parameters:

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:

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

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 IPSetReferenceStatement 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.