Package software.amazon.awssdk.services.waf.model

Class IPSetDescriptor

java.lang.Object

software.amazon.awssdk.services.waf.model.IPSetDescriptor

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IPSetDescriptor.Builder,IPSetDescriptor>

@Generated("software.amazon.awssdk:codegen")
public final class IPSetDescriptor
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IPSetDescriptor.Builder,IPSetDescriptor>

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.

Specifies the IP address type (IPV4 or IPV6) and the IP address range (in CIDR format) that web requests originate from.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IPSetDescriptor.Builder

Method Summary

Modifier and Type	Method	Description
static IPSetDescriptor.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends IPSetDescriptor.Builder>	serializableBuilderClass()
IPSetDescriptor.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
IPSetDescriptorType	type()	Specify IPV4 or IPV6.
String	typeAsString()	Specify IPV4 or IPV6.
String	value()	Specify an IPv4 address by using CIDR notation.

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

type

public final IPSetDescriptorType type()

Specify IPV4 or IPV6.

If the service returns an enum value that is not available in the current SDK version, type will return IPSetDescriptorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Specify IPV4 or IPV6.

See Also:

IPSetDescriptorType

typeAsString

public final String typeAsString()

Specify IPV4 or IPV6.

If the service returns an enum value that is not available in the current SDK version, type will return IPSetDescriptorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Specify IPV4 or IPV6.

See Also:

IPSetDescriptorType

value

public final String value()

Specify an IPv4 address by using CIDR notation. For example:

• 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.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Specify an IPv6 address by using CIDR notation. For example:

• 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.

Returns:

Specify an IPv4 address by using CIDR notation. For example:

• 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.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Specify an IPv6 address by using CIDR notation. For example:

• 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.

toBuilder

public IPSetDescriptor.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IPSetDescriptor.Builder,IPSetDescriptor>

builder

public static IPSetDescriptor.Builder builder()

serializableBuilderClass

public static Class<? extends IPSetDescriptor.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