IPSet (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.waf.model.IPSet

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IPSet
extends Object
implements Serializable, Cloneable, StructuredPojo
```
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.

To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IPSet()

Constructors
Constructor and Description
`IPSet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IPSet`	`clone()`
`boolean`	`equals(Object obj)`
`List<IPSetDescriptor>`	`getIPSetDescriptors()` The IP address type (`IPV4` or `IPV6`) 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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setIPSetDescriptors(Collection<IPSetDescriptor> iPSetDescriptors)` The IP address type (`IPV4` or `IPV6`) 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.
`IPSet`	`withIPSetDescriptors(Collection<IPSetDescriptor> iPSetDescriptors)` The IP address type (`IPV4` or `IPV6`) and the IP address range (in CIDR notation) that web requests originate from.
`IPSet`	`withIPSetDescriptors(IPSetDescriptor... iPSetDescriptors)` The IP address type (`IPV4` or `IPV6`) 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
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 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.
    
    Returns:
    
    The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.
  - setIPSetDescriptors
```
public void setIPSetDescriptors(Collection<IPSetDescriptor> iPSetDescriptors)
```
    The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.
    
    Parameters:
    
    iPSetDescriptors - The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.
  - withIPSetDescriptors
```
public IPSet withIPSetDescriptors(IPSetDescriptor... iPSetDescriptors)
```
    The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.
    
    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 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.
    
    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 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.
    
    Parameters:
    
    iPSetDescriptors - The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.
    
    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 IPSet 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.

Did this page help you?

Class IPSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IPSet

Method Detail

setIPSetId

getIPSetId

withIPSetId

setName

getName

withName

getIPSetDescriptors

setIPSetDescriptors

withIPSetDescriptors

withIPSetDescriptors

toString

equals

hashCode

clone

marshall