com.amazonaws.services.wafv2.model

Class RateBasedStatementManagedKeysIPSet

java.lang.Object

com.amazonaws.services.wafv2.model.RateBasedStatementManagedKeysIPSet

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The set of IP addresses that are currently blocked for a RateBasedStatement. This is only available for rate-based rules that aggregate on just the IP address, with the AggregateKeyType set to IP or FORWARDED_IP.

A rate-based rule applies its rule action to requests from IP addresses that are in the rule's managed keys list and that match the rule's scope-down statement. When a rule has no scope-down statement, it applies the action to all requests from the IP addresses that are in the list. The rule applies its rule action to rate limit the matching requests. The action is usually Block but it can be any valid rule action except for Allow.

The maximum number of IP addresses that can be rate limited by a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, WAF limits those with the highest rates.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RateBasedStatementManagedKeysIPSet()

Method Summary

Modifier and Type	Method and Description
RateBasedStatementManagedKeysIPSet	clone()
boolean	equals(Object obj)
List<String>	getAddresses() The IP addresses that are currently blocked.
String	getIPAddressVersion() The version of the IP addresses, either IPV4 or IPV6.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAddresses(Collection<String> addresses) The IP addresses that are currently blocked.
void	setIPAddressVersion(String iPAddressVersion) The version of the IP addresses, either IPV4 or IPV6.
String	toString() Returns a string representation of this object.
RateBasedStatementManagedKeysIPSet	withAddresses(Collection<String> addresses) The IP addresses that are currently blocked.
RateBasedStatementManagedKeysIPSet	withAddresses(String... addresses) The IP addresses that are currently blocked.
RateBasedStatementManagedKeysIPSet	withIPAddressVersion(IPAddressVersion iPAddressVersion) The version of the IP addresses, either IPV4 or IPV6.
RateBasedStatementManagedKeysIPSet	withIPAddressVersion(String iPAddressVersion) The version of the IP addresses, either IPV4 or IPV6.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RateBasedStatementManagedKeysIPSet

public RateBasedStatementManagedKeysIPSet()

Method Detail

setIPAddressVersion

public void setIPAddressVersion(String iPAddressVersion)

The version of the IP addresses, either IPV4 or IPV6.

Parameters:

iPAddressVersion - The version of the IP addresses, either IPV4 or IPV6.

See Also:

IPAddressVersion

getIPAddressVersion

public String getIPAddressVersion()

The version of the IP addresses, either IPV4 or IPV6.

Returns:

The version of the IP addresses, either IPV4 or IPV6.

See Also:

IPAddressVersion

withIPAddressVersion

public RateBasedStatementManagedKeysIPSet withIPAddressVersion(String iPAddressVersion)

The version of the IP addresses, either IPV4 or IPV6.

Parameters:

iPAddressVersion - The version of the IP addresses, either IPV4 or IPV6.

Returns:

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

See Also:

IPAddressVersion

withIPAddressVersion

public RateBasedStatementManagedKeysIPSet withIPAddressVersion(IPAddressVersion iPAddressVersion)

The version of the IP addresses, either IPV4 or IPV6.

Parameters:

iPAddressVersion - The version of the IP addresses, either IPV4 or IPV6.

Returns:

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

See Also:

IPAddressVersion

getAddresses

public List<String> getAddresses()

The IP addresses that are currently blocked.

Returns:

The IP addresses that are currently blocked.

setAddresses

public void setAddresses(Collection<String> addresses)

The IP addresses that are currently blocked.

Parameters:

addresses - The IP addresses that are currently blocked.

withAddresses

public RateBasedStatementManagedKeysIPSet withAddresses(String... addresses)

The IP addresses that are currently blocked.

NOTE: This method appends the values to the existing list (if any). Use setAddresses(java.util.Collection) or withAddresses(java.util.Collection) if you want to override the existing values.

Parameters:

addresses - The IP addresses that are currently blocked.

Returns:

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

withAddresses

public RateBasedStatementManagedKeysIPSet withAddresses(Collection<String> addresses)

The IP addresses that are currently blocked.

Parameters:

addresses - The IP addresses that are currently blocked.

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