public class IPSet
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Contains one or more IP addresses or blocks of IP addresses specified in
Classless Inter-Domain Routing (CIDR) notation. 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 /24
, a /16
, or a /8
CIDR. For more
information about CIDR notation, perform an Internet search on
cidr notation
.
Modifier and Type | Field and Description |
---|---|
private java.util.List<IPSetDescriptor> |
iPSetDescriptors
The IP address type (
IPV4 ) and the IP address range (in CIDR
notation) that web requests originate from. |
private java.lang.String |
iPSetId
The
IPSetId for an IPSet . |
private java.lang.String |
name
A friendly name or description of the IPSet.
|
Constructor and Description |
---|
IPSet() |
Modifier and Type | Method and Description |
---|---|
IPSet |
clone() |
boolean |
equals(java.lang.Object obj) |
java.util.List<IPSetDescriptor> |
getIPSetDescriptors()
The IP address type (
IPV4 ) and the IP address range (in CIDR
notation) that web requests originate from. |
java.lang.String |
getIPSetId()
The
IPSetId for an IPSet . |
java.lang.String |
getName()
A friendly name or description of the IPSet.
|
int |
hashCode() |
void |
setIPSetDescriptors(java.util.Collection<IPSetDescriptor> iPSetDescriptors)
The IP address type (
IPV4 ) and the IP address range (in CIDR
notation) that web requests originate from. |
void |
setIPSetId(java.lang.String iPSetId)
The
IPSetId for an IPSet . |
void |
setName(java.lang.String name)
A friendly name or description of the IPSet.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
IPSet |
withIPSetDescriptors(java.util.Collection<IPSetDescriptor> iPSetDescriptors)
The IP address type (
IPV4 ) and the IP address range (in CIDR
notation) that web requests originate from. |
IPSet |
withIPSetDescriptors(IPSetDescriptor... iPSetDescriptors)
The IP address type (
IPV4 ) and the IP address range (in CIDR
notation) that web requests originate from. |
IPSet |
withIPSetId(java.lang.String iPSetId)
The
IPSetId for an IPSet . |
IPSet |
withName(java.lang.String name)
A friendly name or description of the IPSet.
|
private java.lang.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.
private java.lang.String name
A friendly name or description of the IPSet. You can't change the
name of an IPSet
after you create it.
private java.util.List<IPSetDescriptor> iPSetDescriptors
The IP address type (IPV4
) and the IP address range (in CIDR
notation) that web requests originate from. If the WebACL
is
associated with a CloudFront distribution, this is the value of one of
the following fields in CloudFront access logs:
c-ip
, if the viewer did not use an HTTP proxy or a load
balancer to send the requestx-forwarded-for
, if the viewer did use an HTTP proxy or
a load balancer to send the requestpublic void setIPSetId(java.lang.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.
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.
public java.lang.String getIPSetId()
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.
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.
public IPSet withIPSetId(java.lang.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.
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.
public void setName(java.lang.String name)
A friendly name or description of the IPSet. You can't change the
name of an IPSet
after you create it.
name
- A friendly name or description of the IPSet. You can't
change the name of an IPSet
after you create it.public java.lang.String getName()
A friendly name or description of the IPSet. You can't change the
name of an IPSet
after you create it.
IPSet
after you create it.public IPSet withName(java.lang.String name)
A friendly name or description of the IPSet. You can't change the
name of an IPSet
after you create it.
name
- A friendly name or description of the IPSet. You can't
change the name of an IPSet
after you create it.public java.util.List<IPSetDescriptor> getIPSetDescriptors()
The IP address type (IPV4
) and the IP address range (in CIDR
notation) that web requests originate from. If the WebACL
is
associated with a CloudFront distribution, this is the value of one of
the following fields in CloudFront access logs:
c-ip
, if the viewer did not use an HTTP proxy or a load
balancer to send the requestx-forwarded-for
, if the viewer did use an HTTP proxy or
a load balancer to send the requestIPV4
) and the IP address range
(in CIDR notation) that web requests originate from. If the
WebACL
is associated with a CloudFront distribution,
this is the value of one of the following fields in CloudFront
access logs:
c-ip
, if the viewer did not use an HTTP proxy or
a load balancer to send the requestx-forwarded-for
, if the viewer did use an HTTP
proxy or a load balancer to send the requestpublic void setIPSetDescriptors(java.util.Collection<IPSetDescriptor> iPSetDescriptors)
The IP address type (IPV4
) and the IP address range (in CIDR
notation) that web requests originate from. If the WebACL
is
associated with a CloudFront distribution, this is the value of one of
the following fields in CloudFront access logs:
c-ip
, if the viewer did not use an HTTP proxy or a load
balancer to send the requestx-forwarded-for
, if the viewer did use an HTTP proxy or
a load balancer to send the requestiPSetDescriptors
- The IP address type (IPV4
) and the IP address range
(in CIDR notation) that web requests originate from. If the
WebACL
is associated with a CloudFront distribution,
this is the value of one of the following fields in CloudFront
access logs:
c-ip
, if the viewer did not use an HTTP proxy or
a load balancer to send the requestx-forwarded-for
, if the viewer did use an HTTP
proxy or a load balancer to send the requestpublic IPSet withIPSetDescriptors(IPSetDescriptor... iPSetDescriptors)
The IP address type (IPV4
) and the IP address range (in CIDR
notation) that web requests originate from. If the WebACL
is
associated with a CloudFront distribution, this is the value of one of
the following fields in CloudFront access logs:
c-ip
, if the viewer did not use an HTTP proxy or a load
balancer to send the requestx-forwarded-for
, if the viewer did use an HTTP proxy or
a load balancer to send the request
NOTE: This method appends the values to the existing list (if
any). Use setIPSetDescriptors(java.util.Collection)
or
withIPSetDescriptors(java.util.Collection)
if you want to
override the existing values.
iPSetDescriptors
- The IP address type (IPV4
) and the IP address range
(in CIDR notation) that web requests originate from. If the
WebACL
is associated with a CloudFront distribution,
this is the value of one of the following fields in CloudFront
access logs:
c-ip
, if the viewer did not use an HTTP proxy or
a load balancer to send the requestx-forwarded-for
, if the viewer did use an HTTP
proxy or a load balancer to send the requestpublic IPSet withIPSetDescriptors(java.util.Collection<IPSetDescriptor> iPSetDescriptors)
The IP address type (IPV4
) and the IP address range (in CIDR
notation) that web requests originate from. If the WebACL
is
associated with a CloudFront distribution, this is the value of one of
the following fields in CloudFront access logs:
c-ip
, if the viewer did not use an HTTP proxy or a load
balancer to send the requestx-forwarded-for
, if the viewer did use an HTTP proxy or
a load balancer to send the requestiPSetDescriptors
- The IP address type (IPV4
) and the IP address range
(in CIDR notation) that web requests originate from. If the
WebACL
is associated with a CloudFront distribution,
this is the value of one of the following fields in CloudFront
access logs:
c-ip
, if the viewer did not use an HTTP proxy or
a load balancer to send the requestx-forwarded-for
, if the viewer did use an HTTP
proxy or a load balancer to send the requestpublic java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public IPSet clone()
clone
in class java.lang.Object