IPSet (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.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 the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports any CIDR range. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

AWS WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

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<String>`	`getAddresses()` Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
`String`	`getARN()` The Amazon Resource Name (ARN) of the entity.
`String`	`getDescription()` A description of the IP set that helps with identification.
`String`	`getId()` A unique identifier for the set.
`String`	`getIPAddressVersion()` Specify IPV4 or IPV6.
`String`	`getName()` The name of the IP set.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAddresses(Collection<String> addresses)` Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
`void`	`setARN(String aRN)` The Amazon Resource Name (ARN) of the entity.
`void`	`setDescription(String description)` A description of the IP set that helps with identification.
`void`	`setId(String id)` A unique identifier for the set.
`void`	`setIPAddressVersion(String iPAddressVersion)` Specify IPV4 or IPV6.
`void`	`setName(String name)` The name of the IP set.
`String`	`toString()` Returns a string representation of this object.
`IPSet`	`withAddresses(Collection<String> addresses)` Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
`IPSet`	`withAddresses(String... addresses)` Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
`IPSet`	`withARN(String aRN)` The Amazon Resource Name (ARN) of the entity.
`IPSet`	`withDescription(String description)` A description of the IP set that helps with identification.
`IPSet`	`withId(String id)` A unique identifier for the set.
`IPSet`	`withIPAddressVersion(IPAddressVersion iPAddressVersion)` Specify IPV4 or IPV6.
`IPSet`	`withIPAddressVersion(String iPAddressVersion)` Specify IPV4 or IPV6.
`IPSet`	`withName(String name)` The name of the IP set.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IPSet
```
public IPSet()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the IP set. You cannot change the name of an IPSet after you create it.
    
    Parameters:
    
    name - The name of the IP set. You cannot change the name of an IPSet after you create it.
  - getName
```
public String getName()
```
    The name of the IP set. You cannot change the name of an IPSet after you create it.
    
    Returns:
    
    The name of the IP set. You cannot change the name of an IPSet after you create it.
  - withName
```
public IPSet withName(String name)
```
    The name of the IP set. You cannot change the name of an IPSet after you create it.
    
    Parameters:
    
    name - The name of the IP set. You cannot 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.
  - setId
```
public void setId(String id)
```
    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Parameters:
    
    id - A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
  - getId
```
public String getId()
```
    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Returns:
    
    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
  - withId
```
public IPSet withId(String id)
```
    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Parameters:
    
    id - A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setARN
```
public void setARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
  - getARN
```
public String getARN()
```
    The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the entity.
  - withARN
```
public IPSet withARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.
    
    Parameters:
    
    description - A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.
  - getDescription
```
public String getDescription()
```
    A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.
    
    Returns:
    
    A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.
  - withDescription
```
public IPSet withDescription(String description)
```
    A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.
    
    Parameters:
    
    description - A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIPAddressVersion
```
public void setIPAddressVersion(String iPAddressVersion)
```
    Specify IPV4 or IPV6.
    
    Parameters:
    
    iPAddressVersion - Specify IPV4 or IPV6.
    
    See Also:
    
    IPAddressVersion
  - getIPAddressVersion
```
public String getIPAddressVersion()
```
    Specify IPV4 or IPV6.
    
    Returns:
    
    Specify IPV4 or IPV6.
    
    See Also:
    
    IPAddressVersion
  - withIPAddressVersion
```
public IPSet withIPAddressVersion(String iPAddressVersion)
```
    Specify IPV4 or IPV6.
    
    Parameters:
    
    iPAddressVersion - Specify IPV4 or IPV6.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IPAddressVersion
  - withIPAddressVersion
```
public IPSet withIPAddressVersion(IPAddressVersion iPAddressVersion)
```
    Specify IPV4 or IPV6.
    
    Parameters:
    
    iPAddressVersion - Specify 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()
```
    Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
    
    Examples:
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    Returns:
    Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
    
    Examples:
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128 .
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
  - setAddresses
```
public void setAddresses(Collection<String> addresses)
```
    Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
    
    Examples:
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    Parameters:
    addresses - Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
    
    Examples:
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
  - withAddresses
```
public IPSet withAddresses(String... addresses)
```
    Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
    
    Examples:
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    
    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 - Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
    
    Examples:
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAddresses
```
public IPSet withAddresses(Collection<String> addresses)
```
    Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
    
    Examples:
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    Parameters:
    addresses - Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
    
    Examples:
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    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

setName

getName

withName

setId

getId

withId

setARN

getARN

withARN

setDescription

getDescription

withDescription

setIPAddressVersion

getIPAddressVersion

withIPAddressVersion

withIPAddressVersion

getAddresses

setAddresses

withAddresses

withAddresses

toString

equals

hashCode

clone

marshall