software.amazon.awssdk.services.waf.model

Class IPSet

java.lang.Object

software.amazon.awssdk.services.waf.model.IPSet

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<IPSet.Builder,IPSet>

@Generated(value="software.amazon.awssdk:codegen")
public class IPSet
extends Object
implements StructuredPojo, ToCopyableBuilder<IPSet.Builder,IPSet>

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

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

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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	name() A friendly name or description of the IPSet.
static Class<? extends IPSet.Builder>	serializableBuilderClass()
IPSet.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

ipSetId

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

ipSetDescriptors

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

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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<IPSet.Builder,IPSet>

Returns:

a builder for type T

builder

public static IPSet.Builder builder()

serializableBuilderClass

public static Class<? extends IPSet.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

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.