com.amazonaws.services.waf.model

Class IPSet

java.lang.Object

com.amazonaws.services.waf.model.IPSet

All Implemented Interfaces:

Serializable, Cloneable

public class IPSet
extends Object
implements Serializable, Cloneable

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify a /24, a /16, or a /8 CIDR. For more information about CIDR notation, perform an Internet search on cidr notation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IPSet()

Method Summary

Methods

Modifier and Type	Method and Description
IPSet	clone()
boolean	equals(Object obj)
List<IPSetDescriptor>	getIPSetDescriptors() The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from.
String	getIPSetId() The IPSetId for an IPSet.
String	getName() A friendly name or description of the IPSet.
int	hashCode()
void	setIPSetDescriptors(Collection<IPSetDescriptor> iPSetDescriptors) The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from.
void	setIPSetId(String iPSetId) The IPSetId for an IPSet.
void	setName(String name) A friendly name or description of the IPSet.
String	toString() Returns a string representation of this object; useful for testing and debugging.
IPSet	withIPSetDescriptors(Collection<IPSetDescriptor> iPSetDescriptors) The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from.
IPSet	withIPSetDescriptors(IPSetDescriptor... iPSetDescriptors) The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from.
IPSet	withIPSetId(String iPSetId) The IPSetId for an IPSet.
IPSet	withName(String name) A friendly name or description of the IPSet.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IPSet

public IPSet()

Method Detail

setIPSetId

public void setIPSetId(String iPSetId)

The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

IPSetId is returned by CreateIPSet and by ListIPSets.

Parameters:

iPSetId - The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

IPSetId is returned by CreateIPSet and by ListIPSets.

getIPSetId

public String getIPSetId()

The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

IPSetId is returned by CreateIPSet and by ListIPSets.

Returns:

The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

IPSetId is returned by CreateIPSet and by ListIPSets.

withIPSetId

public IPSet withIPSetId(String iPSetId)

The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

IPSetId is returned by CreateIPSet and by ListIPSets.

Parameters:

iPSetId - The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

IPSetId is returned by CreateIPSet and by ListIPSets.

Returns:

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

setName

public void setName(String name)

A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

Parameters:

name - A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

getName

public String getName()

A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

Returns:

A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

withName

public IPSet withName(String name)

A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

Parameters:

name - A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

Returns:

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

getIPSetDescriptors

public List<IPSetDescriptor> getIPSetDescriptors()

The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

• c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request
• x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

Returns:

The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

• c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request
• x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

setIPSetDescriptors

public void setIPSetDescriptors(Collection<IPSetDescriptor> iPSetDescriptors)

The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

• c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request
• x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

Parameters:

iPSetDescriptors - The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

• c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request
• x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

withIPSetDescriptors

public IPSet withIPSetDescriptors(IPSetDescriptor... iPSetDescriptors)

The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

• c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request
• x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

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

Parameters:

iPSetDescriptors - The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

• c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request
• x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

Returns:

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

withIPSetDescriptors

public IPSet withIPSetDescriptors(Collection<IPSetDescriptor> iPSetDescriptors)

The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

• c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request
• x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

Parameters:

iPSetDescriptors - The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

• c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request
• x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

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; useful for testing and debugging.

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 IPSet clone()

Overrides:

clone in class Object