@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateIPSetRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateIPSetRequest() |
Modifier and Type | Method and Description |
---|---|
CreateIPSetRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getAddresses()
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF
to inspect for in incoming requests.
|
String |
getDescription()
A description of the IP set that helps with identification.
|
String |
getIPAddressVersion()
The version of the IP addresses, either
IPV4 or IPV6 . |
String |
getName()
The name of the IP set.
|
String |
getScope()
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
|
List<Tag> |
getTags()
An array of key:value pairs to associate with the resource.
|
int |
hashCode() |
void |
setAddresses(Collection<String> addresses)
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF
to inspect for in incoming requests.
|
void |
setDescription(String description)
A description of the IP set that helps with identification.
|
void |
setIPAddressVersion(String iPAddressVersion)
The version of the IP addresses, either
IPV4 or IPV6 . |
void |
setName(String name)
The name of the IP set.
|
void |
setScope(String scope)
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
|
void |
setTags(Collection<Tag> tags)
An array of key:value pairs to associate with the resource.
|
String |
toString()
Returns a string representation of this object.
|
CreateIPSetRequest |
withAddresses(Collection<String> addresses)
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF
to inspect for in incoming requests.
|
CreateIPSetRequest |
withAddresses(String... addresses)
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF
to inspect for in incoming requests.
|
CreateIPSetRequest |
withDescription(String description)
A description of the IP set that helps with identification.
|
CreateIPSetRequest |
withIPAddressVersion(IPAddressVersion iPAddressVersion)
The version of the IP addresses, either
IPV4 or IPV6 . |
CreateIPSetRequest |
withIPAddressVersion(String iPAddressVersion)
The version of the IP addresses, either
IPV4 or IPV6 . |
CreateIPSetRequest |
withName(String name)
The name of the IP set.
|
CreateIPSetRequest |
withScope(Scope scope)
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
|
CreateIPSetRequest |
withScope(String scope)
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
|
CreateIPSetRequest |
withTags(Collection<Tag> tags)
An array of key:value pairs to associate with the resource.
|
CreateIPSetRequest |
withTags(Tag... tags)
An array of key:value pairs to associate with the resource.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setName(String name)
The name of the IP set. You cannot change the name of an IPSet
after you create it.
name
- The name of the IP set. You cannot change the name of an IPSet
after you create it.public String getName()
The name of the IP set. You cannot change the name of an IPSet
after you create it.
IPSet
after you create it.public CreateIPSetRequest withName(String name)
The name of the IP set. You cannot change the name of an IPSet
after you create it.
name
- The name of the IP set. You cannot change the name of an IPSet
after you create it.public void setScope(String scope)
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1
.
API and SDKs - For all calls, use the Region endpoint us-east-1.
scope
- Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional
application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL
API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access
instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Scope
public String getScope()
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1
.
API and SDKs - For all calls, use the Region endpoint us-east-1.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Scope
public CreateIPSetRequest withScope(String scope)
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1
.
API and SDKs - For all calls, use the Region endpoint us-east-1.
scope
- Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional
application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL
API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access
instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Scope
public CreateIPSetRequest withScope(Scope scope)
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1
.
API and SDKs - For all calls, use the Region endpoint us-east-1.
scope
- Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional
application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL
API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access
instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Scope
public void setDescription(String description)
A description of the IP set that helps with identification.
description
- A description of the IP set that helps with identification.public String getDescription()
A description of the IP set that helps with identification.
public CreateIPSetRequest withDescription(String description)
A description of the IP set that helps with identification.
description
- A description of the IP set that helps with identification.public void setIPAddressVersion(String iPAddressVersion)
The version of the IP addresses, either IPV4
or IPV6
.
iPAddressVersion
- The version of the IP addresses, either IPV4
or IPV6
.IPAddressVersion
public String getIPAddressVersion()
The version of the IP addresses, either IPV4
or IPV6
.
IPV4
or IPV6
.IPAddressVersion
public CreateIPSetRequest withIPAddressVersion(String iPAddressVersion)
The version of the IP addresses, either IPV4
or IPV6
.
iPAddressVersion
- The version of the IP addresses, either IPV4
or IPV6
.IPAddressVersion
public CreateIPSetRequest withIPAddressVersion(IPAddressVersion iPAddressVersion)
The version of the IP addresses, either IPV4
or IPV6
.
iPAddressVersion
- The version of the IP addresses, either IPV4
or IPV6
.IPAddressVersion
public List<String> getAddresses()
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF
to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR)
notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0
.
Example address strings:
For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32
.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24
.
For 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
.
For 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
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses
specifications:
Empty array: "Addresses": []
Array with one address: "Addresses": ["192.0.2.44/32"]
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
INVALID specification: "Addresses": [""]
INVALID
/0
.
Example address strings:
For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32
.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24
.
For 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
.
For 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
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses
specifications:
Empty array: "Addresses": []
Array with one address: "Addresses": ["192.0.2.44/32"]
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
INVALID specification: "Addresses": [""]
INVALID
public void setAddresses(Collection<String> addresses)
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF
to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR)
notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0
.
Example address strings:
For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32
.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24
.
For 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
.
For 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
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses
specifications:
Empty array: "Addresses": []
Array with one address: "Addresses": ["192.0.2.44/32"]
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
INVALID specification: "Addresses": [""]
INVALID
addresses
- Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you
want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain
Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0
.
Example address strings:
For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32
.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24
.
For 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
.
For 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
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses
specifications:
Empty array: "Addresses": []
Array with one address: "Addresses": ["192.0.2.44/32"]
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
INVALID specification: "Addresses": [""]
INVALID
public CreateIPSetRequest withAddresses(String... addresses)
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF
to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR)
notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0
.
Example address strings:
For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32
.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24
.
For 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
.
For 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
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses
specifications:
Empty array: "Addresses": []
Array with one address: "Addresses": ["192.0.2.44/32"]
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
INVALID specification: "Addresses": [""]
INVALID
NOTE: This method appends the values to the existing list (if any). Use
setAddresses(java.util.Collection)
or withAddresses(java.util.Collection)
if you want to
override the existing values.
addresses
- Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you
want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain
Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0
.
Example address strings:
For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32
.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24
.
For 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
.
For 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
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses
specifications:
Empty array: "Addresses": []
Array with one address: "Addresses": ["192.0.2.44/32"]
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
INVALID specification: "Addresses": [""]
INVALID
public CreateIPSetRequest withAddresses(Collection<String> addresses)
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF
to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR)
notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0
.
Example address strings:
For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32
.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24
.
For 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
.
For 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
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses
specifications:
Empty array: "Addresses": []
Array with one address: "Addresses": ["192.0.2.44/32"]
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
INVALID specification: "Addresses": [""]
INVALID
addresses
- Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you
want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain
Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0
.
Example address strings:
For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32
.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24
.
For 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
.
For 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
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses
specifications:
Empty array: "Addresses": []
Array with one address: "Addresses": ["192.0.2.44/32"]
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
INVALID specification: "Addresses": [""]
INVALID
public List<Tag> getTags()
An array of key:value pairs to associate with the resource.
public void setTags(Collection<Tag> tags)
An array of key:value pairs to associate with the resource.
tags
- An array of key:value pairs to associate with the resource.public CreateIPSetRequest withTags(Tag... tags)
An array of key:value pairs to associate with the resource.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- An array of key:value pairs to associate with the resource.public CreateIPSetRequest withTags(Collection<Tag> tags)
An array of key:value pairs to associate with the resource.
tags
- An array of key:value pairs to associate with the resource.public String toString()
toString
in class Object
Object.toString()
public CreateIPSetRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()