IPSet (AWS Java SDK :: Services :: WAFV2 2.21.7 API)

java.lang.Object
- software.amazon.awssdk.services.wafv2.model.IPSet

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IPSet.Builder,IPSet>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class IPSet
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IPSet.Builder,IPSet>
```
Contains zero or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface IPSet.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`IPSet.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`addresses()` Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests.
`String`	`arn()` The Amazon Resource Name (ARN) of the entity.
`static IPSet.Builder`	`builder()`
`String`	`description()` A description of the IP set that helps with identification.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAddresses()` For responses, this returns true if the service returned a value for the Addresses property.
`int`	`hashCode()`
`String`	`id()` A unique identifier for the set.
`IPAddressVersion`	`ipAddressVersion()` The version of the IP addresses, either `IPV4` or `IPV6`.
`String`	`ipAddressVersionAsString()` The version of the IP addresses, either `IPV4` or `IPV6`.
`String`	`name()` The name of the IP set.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends IPSet.Builder>`	`serializableBuilderClass()`
`IPSet.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String name()
```
    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.
  - id
```
public final 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.
    
    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.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the entity.
  - description
```
public final String description()
```
    A description of the IP set that helps with identification.
    
    Returns:
    
    A description of the IP set that helps with identification.
  - ipAddressVersion
```
public final IPAddressVersion ipAddressVersion()
```
    The version of the IP addresses, either IPV4 or IPV6.
    
    If the service returns an enum value that is not available in the current SDK version, ipAddressVersion will return IPAddressVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressVersionAsString().
    
    Returns:
    
    The version of the IP addresses, either IPV4 or IPV6.
    
    See Also:
    
    IPAddressVersion
  - ipAddressVersionAsString
```
public final String ipAddressVersionAsString()
```
    The version of the IP addresses, either IPV4 or IPV6.
    
    If the service returns an enum value that is not available in the current SDK version, ipAddressVersion will return IPAddressVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressVersionAsString().
    
    Returns:
    
    The version of the IP addresses, either IPV4 or IPV6.
    
    See Also:
    
    IPAddressVersion
  - hasAddresses
```
public final boolean hasAddresses()
```
    For responses, this returns true if the service returned a value for the Addresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - addresses
```
public final List<String> addresses()
```
    Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
    
    Example address strings:
    - For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    - For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    - For 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.
    - For 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.
    
    Example JSON Addresses specifications:
    - Empty array: "Addresses": []
    - Array with one address: "Addresses": ["192.0.2.44/32"]
    - Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
    - INVALID specification: "Addresses": [""] INVALID
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAddresses() method.
    Returns:
    Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
    
    Example address strings:
    
    For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    
    For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    
    For 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.
    
    For 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.
    
    Example JSON Addresses specifications:
    
    Empty array: "Addresses": []
    
    Array with one address: "Addresses": ["192.0.2.44/32"]
    
    Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
    
    INVALID specification: "Addresses": [""] INVALID
  - toBuilder
```
public IPSet.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<IPSet.Builder,IPSet>
  - builder
```
public static IPSet.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends IPSet.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class IPSet

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

id

arn

description

ipAddressVersion

ipAddressVersionAsString

hasAddresses

addresses

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields