Class IPSet
- All Implemented Interfaces:
Serializable
,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
.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The IP address type (IPV4
) and the IP address range (in CIDR notation) that web requests originate from.TheIPSetId
for anIPSet
.getName()
A friendly name or description of the IPSet.int
hashCode()
void
setIPSetDescriptors
(Collection<IPSetDescriptor> iPSetDescriptors) The IP address type (IPV4
) and the IP address range (in CIDR notation) that web requests originate from.void
setIPSetId
(String iPSetId) TheIPSetId
for anIPSet
.void
A friendly name or description of the IPSet.toString()
Returns a string representation of this object; useful for testing and debugging.withIPSetDescriptors
(IPSetDescriptor... iPSetDescriptors) The IP address type (IPV4
) and the IP address range (in CIDR notation) that web requests originate from.withIPSetDescriptors
(Collection<IPSetDescriptor> iPSetDescriptors) The IP address type (IPV4
) and the IP address range (in CIDR notation) that web requests originate from.withIPSetId
(String iPSetId) TheIPSetId
for anIPSet
.A friendly name or description of the IPSet.
-
Constructor Details
-
IPSet
public IPSet()
-
-
Method Details
-
setIPSetId
The
IPSetId
for anIPSet
. You useIPSetId
to get information about anIPSet
(see GetIPSet), update anIPSet
(see UpdateIPSet), insert anIPSet
into aRule
or delete one from aRule
(see UpdateRule), and delete anIPSet
from AWS WAF (see DeleteIPSet).IPSetId
is returned by CreateIPSet and by ListIPSets.- Parameters:
iPSetId
- TheIPSetId
for anIPSet
. You useIPSetId
to get information about anIPSet
(see GetIPSet), update anIPSet
(see UpdateIPSet), insert anIPSet
into aRule
or delete one from aRule
(see UpdateRule), and delete anIPSet
from AWS WAF (see DeleteIPSet).IPSetId
is returned by CreateIPSet and by ListIPSets.
-
getIPSetId
The
IPSetId
for anIPSet
. You useIPSetId
to get information about anIPSet
(see GetIPSet), update anIPSet
(see UpdateIPSet), insert anIPSet
into aRule
or delete one from aRule
(see UpdateRule), and delete anIPSet
from AWS WAF (see DeleteIPSet).IPSetId
is returned by CreateIPSet and by ListIPSets.- Returns:
- The
IPSetId
for anIPSet
. You useIPSetId
to get information about anIPSet
(see GetIPSet), update anIPSet
(see UpdateIPSet), insert anIPSet
into aRule
or delete one from aRule
(see UpdateRule), and delete anIPSet
from AWS WAF (see DeleteIPSet).IPSetId
is returned by CreateIPSet and by ListIPSets.
-
withIPSetId
The
IPSetId
for anIPSet
. You useIPSetId
to get information about anIPSet
(see GetIPSet), update anIPSet
(see UpdateIPSet), insert anIPSet
into aRule
or delete one from aRule
(see UpdateRule), and delete anIPSet
from AWS WAF (see DeleteIPSet).IPSetId
is returned by CreateIPSet and by ListIPSets.- Parameters:
iPSetId
- TheIPSetId
for anIPSet
. You useIPSetId
to get information about anIPSet
(see GetIPSet), update anIPSet
(see UpdateIPSet), insert anIPSet
into aRule
or delete one from aRule
(see UpdateRule), and delete anIPSet
from AWS WAF (see DeleteIPSet).IPSetId
is returned by CreateIPSet and by ListIPSets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
A friendly name or description of the IPSet. You can't change the name of an
IPSet
after you create it.- Parameters:
name
- A friendly name or description of the IPSet. You can't change the name of anIPSet
after you create it.
-
getName
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.
-
withName
A friendly name or description of the IPSet. You can't change the name of an
IPSet
after you create it.- Parameters:
name
- A friendly name or description of the IPSet. You can't change the name of anIPSet
after you create it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getIPSetDescriptors
The IP address type (
IPV4
) and the IP address range (in CIDR notation) that web requests originate from. If theWebACL
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
- Returns:
- The IP address type (
IPV4
) and the IP address range (in CIDR notation) that web requests originate from. If theWebACL
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
-
setIPSetDescriptors
The IP address type (
IPV4
) and the IP address range (in CIDR notation) that web requests originate from. If theWebACL
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
- Parameters:
iPSetDescriptors
- The IP address type (IPV4
) and the IP address range (in CIDR notation) that web requests originate from. If theWebACL
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
-
withIPSetDescriptors
The IP address type (
IPV4
) and the IP address range (in CIDR notation) that web requests originate from. If theWebACL
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)
orwithIPSetDescriptors(java.util.Collection)
if you want to override the existing values.- Parameters:
iPSetDescriptors
- The IP address type (IPV4
) and the IP address range (in CIDR notation) that web requests originate from. If theWebACL
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withIPSetDescriptors
The IP address type (
IPV4
) and the IP address range (in CIDR notation) that web requests originate from. If theWebACL
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
- Parameters:
iPSetDescriptors
- The IP address type (IPV4
) and the IP address range (in CIDR notation) that web requests originate from. If theWebACL
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-