software.amazon.awssdk.services.waf.model

Class IPSet

java.lang.Object

software.amazon.awssdk.services.waf.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>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IPSet.Builder

Method Summary

Modifier and Type	Method and Description
static IPSet.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIpSetDescriptors() For responses, this returns true if the service returned a value for the IPSetDescriptors property.
List<IPSetDescriptor>	ipSetDescriptors() The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from.
String	ipSetId() The IPSetId for an IPSet.
String	name() A friendly name or description of the IPSet.
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

ipSetId

public final 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.

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.

name

public final String name()

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.

hasIpSetDescriptors

public final boolean hasIpSetDescriptors()

For responses, this returns true if the service returned a value for the IPSetDescriptors 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.

ipSetDescriptors

public final List<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.

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 hasIpSetDescriptors() method.

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.

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