public interface AWSWAFAsync extends AWSWAF
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
This is the AWS WAF API Reference. This guide is for developers who need detailed information about the AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.
createByteMatchSet, createIPSet, createRule, createSqlInjectionMatchSet, createWebACL, deleteByteMatchSet, deleteIPSet, deleteRule, deleteSqlInjectionMatchSet, deleteWebACL, getByteMatchSet, getCachedResponseMetadata, getChangeToken, getChangeTokenStatus, getIPSet, getRule, getSampledRequests, getSqlInjectionMatchSet, getWebACL, listByteMatchSets, listIPSets, listRules, listSqlInjectionMatchSets, listWebACLs, setEndpoint, setRegion, shutdown, updateByteMatchSet, updateIPSet, updateRule, updateSqlInjectionMatchSet, updateWebACL
Future<CreateByteMatchSetResult> createByteMatchSetAsync(CreateByteMatchSetRequest createByteMatchSetRequest)
Creates a ByteMatchSet
. You then use
UpdateByteMatchSet to identify the part of a web request that you
want AWS WAF to inspect, such as the values of the
User-Agent
header or the query string. For example, you can
create a ByteMatchSet
that matches any requests with
User-Agent
headers that contain the string
BadBot
. You can then configure AWS WAF to reject those
requests.
To create and configure a ByteMatchSet
, perform the
following steps:
ChangeToken
parameter of a
CreateByteMatchSet
request.CreateByteMatchSet
request.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an
UpdateByteMatchSet
request.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createByteMatchSetRequest
- Future<CreateByteMatchSetResult> createByteMatchSetAsync(CreateByteMatchSetRequest createByteMatchSetRequest, AsyncHandler<CreateByteMatchSetRequest,CreateByteMatchSetResult> asyncHandler)
Creates a ByteMatchSet
. You then use
UpdateByteMatchSet to identify the part of a web request that you
want AWS WAF to inspect, such as the values of the
User-Agent
header or the query string. For example, you can
create a ByteMatchSet
that matches any requests with
User-Agent
headers that contain the string
BadBot
. You can then configure AWS WAF to reject those
requests.
To create and configure a ByteMatchSet
, perform the
following steps:
ChangeToken
parameter of a
CreateByteMatchSet
request.CreateByteMatchSet
request.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an
UpdateByteMatchSet
request.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createByteMatchSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateIPSetResult> createIPSetAsync(CreateIPSetRequest createIPSetRequest)
Creates an IPSet, which you use to specify which web requests you
want to allow or block based on the IP addresses that the requests
originate from. For example, if you're receiving a lot of requests from
one or more individual IP addresses or one or more ranges of IP addresses
and you want to block the requests, you can create an IPSet
that contains those IP addresses and then configure AWS WAF to block the
requests.
To create and configure an IPSet
, perform the following
steps:
ChangeToken
parameter of a CreateIPSet
request.CreateIPSet
request.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an
UpdateIPSet request.UpdateIPSet
request to specify the IP
addresses that you want AWS WAF to watch for.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createIPSetRequest
- Future<CreateIPSetResult> createIPSetAsync(CreateIPSetRequest createIPSetRequest, AsyncHandler<CreateIPSetRequest,CreateIPSetResult> asyncHandler)
Creates an IPSet, which you use to specify which web requests you
want to allow or block based on the IP addresses that the requests
originate from. For example, if you're receiving a lot of requests from
one or more individual IP addresses or one or more ranges of IP addresses
and you want to block the requests, you can create an IPSet
that contains those IP addresses and then configure AWS WAF to block the
requests.
To create and configure an IPSet
, perform the following
steps:
ChangeToken
parameter of a CreateIPSet
request.CreateIPSet
request.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an
UpdateIPSet request.UpdateIPSet
request to specify the IP
addresses that you want AWS WAF to watch for.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createIPSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateRuleResult> createRuleAsync(CreateRuleRequest createRuleRequest)
Creates a Rule
, which contains the IPSet
objects, ByteMatchSet
objects, and other predicates that
identify the requests that you want to block. If you add more than one
predicate to a Rule
, a request must match all of the
specifications to be allowed or blocked. For example, suppose you add the
following to a Rule
:
IPSet
that matches the IP address
192.0.2.44/32
ByteMatchSet
that matches BadBot
in the
User-Agent
header
You then add the Rule
to a WebACL
and specify
that you want to blocks requests that satisfy the Rule
. For
a request to be blocked, it must come from the IP address 192.0.2.44
and the User-Agent
header in the request must contain
the value BadBot
.
To create and configure a Rule
, perform the following steps:
Rule
. For more information, see CreateByteMatchSet,
CreateIPSet, and CreateSqlInjectionMatchSet.ChangeToken
parameter of a CreateRule
request.CreateRule
request.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an UpdateRule
request.UpdateRule
request to specify the predicates
that you want to include in the Rule
.WebACL
that contains the
Rule
. For more information, see CreateWebACL.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createRuleRequest
- Future<CreateRuleResult> createRuleAsync(CreateRuleRequest createRuleRequest, AsyncHandler<CreateRuleRequest,CreateRuleResult> asyncHandler)
Creates a Rule
, which contains the IPSet
objects, ByteMatchSet
objects, and other predicates that
identify the requests that you want to block. If you add more than one
predicate to a Rule
, a request must match all of the
specifications to be allowed or blocked. For example, suppose you add the
following to a Rule
:
IPSet
that matches the IP address
192.0.2.44/32
ByteMatchSet
that matches BadBot
in the
User-Agent
header
You then add the Rule
to a WebACL
and specify
that you want to blocks requests that satisfy the Rule
. For
a request to be blocked, it must come from the IP address 192.0.2.44
and the User-Agent
header in the request must contain
the value BadBot
.
To create and configure a Rule
, perform the following steps:
Rule
. For more information, see CreateByteMatchSet,
CreateIPSet, and CreateSqlInjectionMatchSet.ChangeToken
parameter of a CreateRule
request.CreateRule
request.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an UpdateRule
request.UpdateRule
request to specify the predicates
that you want to include in the Rule
.WebACL
that contains the
Rule
. For more information, see CreateWebACL.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createRuleRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateSqlInjectionMatchSetResult> createSqlInjectionMatchSetAsync(CreateSqlInjectionMatchSetRequest createSqlInjectionMatchSetRequest)
Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure a SqlInjectionMatchSet
, perform the
following steps:
ChangeToken
parameter of a
CreateSqlInjectionMatchSet
request.CreateSqlInjectionMatchSet
request.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an
UpdateSqlInjectionMatchSet request.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createSqlInjectionMatchSetRequest
- A request to create a SqlInjectionMatchSet.Future<CreateSqlInjectionMatchSetResult> createSqlInjectionMatchSetAsync(CreateSqlInjectionMatchSetRequest createSqlInjectionMatchSetRequest, AsyncHandler<CreateSqlInjectionMatchSetRequest,CreateSqlInjectionMatchSetResult> asyncHandler)
Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure a SqlInjectionMatchSet
, perform the
following steps:
ChangeToken
parameter of a
CreateSqlInjectionMatchSet
request.CreateSqlInjectionMatchSet
request.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an
UpdateSqlInjectionMatchSet request.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createSqlInjectionMatchSetRequest
- A request to create a SqlInjectionMatchSet.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateWebACLResult> createWebACLAsync(CreateWebACLRequest createWebACLRequest)
Creates a WebACL
, which contains the Rules
that
identify the CloudFront web requests that you want to allow, block, or
count. AWS WAF evaluates Rules
in order based on the value
of Priority
for each Rule
.
You also specify a default action, either ALLOW
or
BLOCK
. If a web request doesn't match any of the
Rules
in a WebACL
, AWS WAF responds to the
request with the default action.
To create and configure a WebACL
, perform the following
steps:
ByteMatchSet
objects and other
predicates that you want to include in Rules
. For more
information, see CreateByteMatchSet, UpdateByteMatchSet,
CreateIPSet, UpdateIPSet,
CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Rules
that you want to include in
the WebACL
. For more information, see CreateRule and
UpdateRule.ChangeToken
parameter of a CreateWebACL
request.CreateWebACL
request.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an
UpdateWebACL request.Rules
that you want to include in the WebACL
,
to specify the default action, and to associate the WebACL
with a CloudFront distribution.For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
createWebACLRequest
- Future<CreateWebACLResult> createWebACLAsync(CreateWebACLRequest createWebACLRequest, AsyncHandler<CreateWebACLRequest,CreateWebACLResult> asyncHandler)
Creates a WebACL
, which contains the Rules
that
identify the CloudFront web requests that you want to allow, block, or
count. AWS WAF evaluates Rules
in order based on the value
of Priority
for each Rule
.
You also specify a default action, either ALLOW
or
BLOCK
. If a web request doesn't match any of the
Rules
in a WebACL
, AWS WAF responds to the
request with the default action.
To create and configure a WebACL
, perform the following
steps:
ByteMatchSet
objects and other
predicates that you want to include in Rules
. For more
information, see CreateByteMatchSet, UpdateByteMatchSet,
CreateIPSet, UpdateIPSet,
CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Rules
that you want to include in
the WebACL
. For more information, see CreateRule and
UpdateRule.ChangeToken
parameter of a CreateWebACL
request.CreateWebACL
request.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an
UpdateWebACL request.Rules
that you want to include in the WebACL
,
to specify the default action, and to associate the WebACL
with a CloudFront distribution.For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
createWebACLRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteByteMatchSetResult> deleteByteMatchSetAsync(DeleteByteMatchSetRequest deleteByteMatchSetRequest)
Permanently deletes a ByteMatchSet. You can't delete a
ByteMatchSet
if it's still used in any Rules
or
if it still includes any ByteMatchTuple objects (any filters).
If you just want to remove a ByteMatchSet
from a
Rule
, use UpdateRule.
To permanently delete a ByteMatchSet
, perform the following
steps:
ByteMatchSet
to remove filters, if any. For
more information, see UpdateByteMatchSet.ChangeToken
parameter of a
DeleteByteMatchSet
request.DeleteByteMatchSet
request.deleteByteMatchSetRequest
- Future<DeleteByteMatchSetResult> deleteByteMatchSetAsync(DeleteByteMatchSetRequest deleteByteMatchSetRequest, AsyncHandler<DeleteByteMatchSetRequest,DeleteByteMatchSetResult> asyncHandler)
Permanently deletes a ByteMatchSet. You can't delete a
ByteMatchSet
if it's still used in any Rules
or
if it still includes any ByteMatchTuple objects (any filters).
If you just want to remove a ByteMatchSet
from a
Rule
, use UpdateRule.
To permanently delete a ByteMatchSet
, perform the following
steps:
ByteMatchSet
to remove filters, if any. For
more information, see UpdateByteMatchSet.ChangeToken
parameter of a
DeleteByteMatchSet
request.DeleteByteMatchSet
request.deleteByteMatchSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteIPSetResult> deleteIPSetAsync(DeleteIPSetRequest deleteIPSetRequest)
Permanently deletes an IPSet. You can't delete an
IPSet
if it's still used in any Rules
or if it
still includes any IP addresses.
If you just want to remove an IPSet
from a Rule
, use UpdateRule.
To permanently delete an IPSet
from AWS WAF, perform the
following steps:
IPSet
to remove IP address ranges, if any.
For more information, see UpdateIPSet.ChangeToken
parameter of a DeleteIPSet
request.DeleteIPSet
request.deleteIPSetRequest
- Future<DeleteIPSetResult> deleteIPSetAsync(DeleteIPSetRequest deleteIPSetRequest, AsyncHandler<DeleteIPSetRequest,DeleteIPSetResult> asyncHandler)
Permanently deletes an IPSet. You can't delete an
IPSet
if it's still used in any Rules
or if it
still includes any IP addresses.
If you just want to remove an IPSet
from a Rule
, use UpdateRule.
To permanently delete an IPSet
from AWS WAF, perform the
following steps:
IPSet
to remove IP address ranges, if any.
For more information, see UpdateIPSet.ChangeToken
parameter of a DeleteIPSet
request.DeleteIPSet
request.deleteIPSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest deleteRuleRequest)
Permanently deletes a Rule. You can't delete a Rule
if it's still used in any WebACL
objects or if it still
includes any predicates, such as ByteMatchSet
objects.
If you just want to remove a Rule
from a WebACL
, use UpdateWebACL.
To permanently delete a Rule
from AWS WAF, perform the
following steps:
Rule
to remove predicates, if any. For more
information, see UpdateRule.ChangeToken
parameter of a DeleteRule
request.DeleteRule
request.deleteRuleRequest
- Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest deleteRuleRequest, AsyncHandler<DeleteRuleRequest,DeleteRuleResult> asyncHandler)
Permanently deletes a Rule. You can't delete a Rule
if it's still used in any WebACL
objects or if it still
includes any predicates, such as ByteMatchSet
objects.
If you just want to remove a Rule
from a WebACL
, use UpdateWebACL.
To permanently delete a Rule
from AWS WAF, perform the
following steps:
Rule
to remove predicates, if any. For more
information, see UpdateRule.ChangeToken
parameter of a DeleteRule
request.DeleteRule
request.deleteRuleRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteSqlInjectionMatchSetResult> deleteSqlInjectionMatchSetAsync(DeleteSqlInjectionMatchSetRequest deleteSqlInjectionMatchSetRequest)
Permanently deletes a SqlInjectionMatchSet. You can't delete a
SqlInjectionMatchSet
if it's still used in any
Rules
or if it still contains any
SqlInjectionMatchTuple objects.
If you just want to remove a SqlInjectionMatchSet
from a
Rule
, use UpdateRule.
To permanently delete a SqlInjectionMatchSet
from AWS WAF,
perform the following steps:
SqlInjectionMatchSet
to remove filters, if
any. For more information, see UpdateSqlInjectionMatchSet.ChangeToken
parameter of a
DeleteSqlInjectionMatchSet
request.DeleteSqlInjectionMatchSet
request.deleteSqlInjectionMatchSetRequest
- A request to delete a SqlInjectionMatchSet from AWS WAF.Future<DeleteSqlInjectionMatchSetResult> deleteSqlInjectionMatchSetAsync(DeleteSqlInjectionMatchSetRequest deleteSqlInjectionMatchSetRequest, AsyncHandler<DeleteSqlInjectionMatchSetRequest,DeleteSqlInjectionMatchSetResult> asyncHandler)
Permanently deletes a SqlInjectionMatchSet. You can't delete a
SqlInjectionMatchSet
if it's still used in any
Rules
or if it still contains any
SqlInjectionMatchTuple objects.
If you just want to remove a SqlInjectionMatchSet
from a
Rule
, use UpdateRule.
To permanently delete a SqlInjectionMatchSet
from AWS WAF,
perform the following steps:
SqlInjectionMatchSet
to remove filters, if
any. For more information, see UpdateSqlInjectionMatchSet.ChangeToken
parameter of a
DeleteSqlInjectionMatchSet
request.DeleteSqlInjectionMatchSet
request.deleteSqlInjectionMatchSetRequest
- A request to delete a SqlInjectionMatchSet from AWS WAF.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteWebACLResult> deleteWebACLAsync(DeleteWebACLRequest deleteWebACLRequest)
Permanently deletes a WebACL. You can't delete a
WebACL
if it still contains any Rules
.
To delete a WebACL
, perform the following steps:
WebACL
to remove Rules
, if any.
For more information, see UpdateWebACL.ChangeToken
parameter of a DeleteWebACL
request.DeleteWebACL
request.deleteWebACLRequest
- Future<DeleteWebACLResult> deleteWebACLAsync(DeleteWebACLRequest deleteWebACLRequest, AsyncHandler<DeleteWebACLRequest,DeleteWebACLResult> asyncHandler)
Permanently deletes a WebACL. You can't delete a
WebACL
if it still contains any Rules
.
To delete a WebACL
, perform the following steps:
WebACL
to remove Rules
, if any.
For more information, see UpdateWebACL.ChangeToken
parameter of a DeleteWebACL
request.DeleteWebACL
request.deleteWebACLRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetByteMatchSetResult> getByteMatchSetAsync(GetByteMatchSetRequest getByteMatchSetRequest)
Returns the ByteMatchSet specified by ByteMatchSetId
.
getByteMatchSetRequest
- Future<GetByteMatchSetResult> getByteMatchSetAsync(GetByteMatchSetRequest getByteMatchSetRequest, AsyncHandler<GetByteMatchSetRequest,GetByteMatchSetResult> asyncHandler)
Returns the ByteMatchSet specified by ByteMatchSetId
.
getByteMatchSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetChangeTokenResult> getChangeTokenAsync(GetChangeTokenRequest getChangeTokenRequest)
When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.
Each create, update, or delete request must use a unique change token. If
your application submits a GetChangeToken
request and then
submits a second GetChangeToken
request before submitting a
create, update, or delete request, the second GetChangeToken
request returns the same value as the first GetChangeToken
request.
When you use a change token in a create, update, or delete request, the
status of the change token changes to PENDING
, which
indicates that AWS WAF is propagating the change to all AWS WAF servers.
Use GetChangeTokenStatus
to determine the status of your
change token.
getChangeTokenRequest
- Future<GetChangeTokenResult> getChangeTokenAsync(GetChangeTokenRequest getChangeTokenRequest, AsyncHandler<GetChangeTokenRequest,GetChangeTokenResult> asyncHandler)
When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.
Each create, update, or delete request must use a unique change token. If
your application submits a GetChangeToken
request and then
submits a second GetChangeToken
request before submitting a
create, update, or delete request, the second GetChangeToken
request returns the same value as the first GetChangeToken
request.
When you use a change token in a create, update, or delete request, the
status of the change token changes to PENDING
, which
indicates that AWS WAF is propagating the change to all AWS WAF servers.
Use GetChangeTokenStatus
to determine the status of your
change token.
getChangeTokenRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetChangeTokenStatusResult> getChangeTokenStatusAsync(GetChangeTokenStatusRequest getChangeTokenStatusRequest)
Returns the status of a ChangeToken
that you got by calling
GetChangeToken. ChangeTokenStatus
is one of the
following values:
PROVISIONED
: You requested the change token by calling
GetChangeToken
, but you haven't used it yet in a call to
create, update, or delete an AWS WAF object.PENDING
: AWS WAF is propagating the create, update, or
delete request to all AWS WAF servers.IN_SYNC
: Propagation is complete.getChangeTokenStatusRequest
- Future<GetChangeTokenStatusResult> getChangeTokenStatusAsync(GetChangeTokenStatusRequest getChangeTokenStatusRequest, AsyncHandler<GetChangeTokenStatusRequest,GetChangeTokenStatusResult> asyncHandler)
Returns the status of a ChangeToken
that you got by calling
GetChangeToken. ChangeTokenStatus
is one of the
following values:
PROVISIONED
: You requested the change token by calling
GetChangeToken
, but you haven't used it yet in a call to
create, update, or delete an AWS WAF object.PENDING
: AWS WAF is propagating the create, update, or
delete request to all AWS WAF servers.IN_SYNC
: Propagation is complete.getChangeTokenStatusRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetIPSetResult> getIPSetAsync(GetIPSetRequest getIPSetRequest)
Returns the IPSet that is specified by IPSetId
.
getIPSetRequest
- Future<GetIPSetResult> getIPSetAsync(GetIPSetRequest getIPSetRequest, AsyncHandler<GetIPSetRequest,GetIPSetResult> asyncHandler)
Returns the IPSet that is specified by IPSetId
.
getIPSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetRuleResult> getRuleAsync(GetRuleRequest getRuleRequest)
Returns the Rule that is specified by the RuleId
that
you included in the GetRule
request.
getRuleRequest
- Future<GetRuleResult> getRuleAsync(GetRuleRequest getRuleRequest, AsyncHandler<GetRuleRequest,GetRuleResult> asyncHandler)
Returns the Rule that is specified by the RuleId
that
you included in the GetRule
request.
getRuleRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSampledRequestsResult> getSampledRequestsAsync(GetSampledRequestsRequest getSampledRequestsRequest)
Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 100 requests, and you can specify any time range in the previous three hours.
GetSampledRequests
returns a time range, which is usually
the time range that you specified. However, if your resource (such as a
CloudFront distribution) received 5,000 requests before the specified
time range elapsed, GetSampledRequests
returns an updated
time range. This new time range indicates the actual period during which
AWS WAF selected the requests in the sample.
getSampledRequestsRequest
- Future<GetSampledRequestsResult> getSampledRequestsAsync(GetSampledRequestsRequest getSampledRequestsRequest, AsyncHandler<GetSampledRequestsRequest,GetSampledRequestsResult> asyncHandler)
Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 100 requests, and you can specify any time range in the previous three hours.
GetSampledRequests
returns a time range, which is usually
the time range that you specified. However, if your resource (such as a
CloudFront distribution) received 5,000 requests before the specified
time range elapsed, GetSampledRequests
returns an updated
time range. This new time range indicates the actual period during which
AWS WAF selected the requests in the sample.
getSampledRequestsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSqlInjectionMatchSetResult> getSqlInjectionMatchSetAsync(GetSqlInjectionMatchSetRequest getSqlInjectionMatchSetRequest)
Returns the SqlInjectionMatchSet that is specified by
SqlInjectionMatchSetId
.
getSqlInjectionMatchSetRequest
- A request to get a SqlInjectionMatchSet.Future<GetSqlInjectionMatchSetResult> getSqlInjectionMatchSetAsync(GetSqlInjectionMatchSetRequest getSqlInjectionMatchSetRequest, AsyncHandler<GetSqlInjectionMatchSetRequest,GetSqlInjectionMatchSetResult> asyncHandler)
Returns the SqlInjectionMatchSet that is specified by
SqlInjectionMatchSetId
.
getSqlInjectionMatchSetRequest
- A request to get a SqlInjectionMatchSet.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetWebACLResult> getWebACLAsync(GetWebACLRequest getWebACLRequest)
Returns the WebACL that is specified by WebACLId
.
getWebACLRequest
- Future<GetWebACLResult> getWebACLAsync(GetWebACLRequest getWebACLRequest, AsyncHandler<GetWebACLRequest,GetWebACLResult> asyncHandler)
Returns the WebACL that is specified by WebACLId
.
getWebACLRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListByteMatchSetsResult> listByteMatchSetsAsync(ListByteMatchSetsRequest listByteMatchSetsRequest)
Returns an array of ByteMatchSetSummary objects.
listByteMatchSetsRequest
- Future<ListByteMatchSetsResult> listByteMatchSetsAsync(ListByteMatchSetsRequest listByteMatchSetsRequest, AsyncHandler<ListByteMatchSetsRequest,ListByteMatchSetsResult> asyncHandler)
Returns an array of ByteMatchSetSummary objects.
listByteMatchSetsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListIPSetsResult> listIPSetsAsync(ListIPSetsRequest listIPSetsRequest)
Returns an array of IPSetSummary objects in the response.
listIPSetsRequest
- Future<ListIPSetsResult> listIPSetsAsync(ListIPSetsRequest listIPSetsRequest, AsyncHandler<ListIPSetsRequest,ListIPSetsResult> asyncHandler)
Returns an array of IPSetSummary objects in the response.
listIPSetsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListRulesResult> listRulesAsync(ListRulesRequest listRulesRequest)
Returns an array of RuleSummary objects.
listRulesRequest
- Future<ListRulesResult> listRulesAsync(ListRulesRequest listRulesRequest, AsyncHandler<ListRulesRequest,ListRulesResult> asyncHandler)
Returns an array of RuleSummary objects.
listRulesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListSqlInjectionMatchSetsResult> listSqlInjectionMatchSetsAsync(ListSqlInjectionMatchSetsRequest listSqlInjectionMatchSetsRequest)
Returns an array of SqlInjectionMatchSet objects.
listSqlInjectionMatchSetsRequest
- A request to list the SqlInjectionMatchSet objects created
by the current AWS account.Future<ListSqlInjectionMatchSetsResult> listSqlInjectionMatchSetsAsync(ListSqlInjectionMatchSetsRequest listSqlInjectionMatchSetsRequest, AsyncHandler<ListSqlInjectionMatchSetsRequest,ListSqlInjectionMatchSetsResult> asyncHandler)
Returns an array of SqlInjectionMatchSet objects.
listSqlInjectionMatchSetsRequest
- A request to list the SqlInjectionMatchSet objects created
by the current AWS account.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListWebACLsResult> listWebACLsAsync(ListWebACLsRequest listWebACLsRequest)
Returns an array of WebACLSummary objects in the response.
listWebACLsRequest
- Future<ListWebACLsResult> listWebACLsAsync(ListWebACLsRequest listWebACLsRequest, AsyncHandler<ListWebACLsRequest,ListWebACLsResult> asyncHandler)
Returns an array of WebACLSummary objects in the response.
listWebACLsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateByteMatchSetResult> updateByteMatchSetAsync(UpdateByteMatchSetRequest updateByteMatchSetRequest)
Inserts or deletes ByteMatchTuple objects (filters) in a
ByteMatchSet. For each ByteMatchTuple
object, you
specify the following values:
ByteMatchSetUpdate
object, you delete the existing
object and add a new one.User-Agent
header.TargetString
in the ByteMatchTuple data type.
For example, you can add a ByteMatchSetUpdate
object that
matches web requests in which User-Agent
headers contain the
string BadBot
. You can then configure AWS WAF to block those
requests.
To create and configure a ByteMatchSet
, perform the
following steps:
ByteMatchSet.
For more information, see
CreateByteMatchSet.ChangeToken
parameter of an
UpdateByteMatchSet
request.UpdateByteMatchSet
request to specify the part
of the request that you want AWS WAF to inspect (for example, the header
or the URI) and the value that you want AWS WAF to watch for.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateByteMatchSetRequest
- Future<UpdateByteMatchSetResult> updateByteMatchSetAsync(UpdateByteMatchSetRequest updateByteMatchSetRequest, AsyncHandler<UpdateByteMatchSetRequest,UpdateByteMatchSetResult> asyncHandler)
Inserts or deletes ByteMatchTuple objects (filters) in a
ByteMatchSet. For each ByteMatchTuple
object, you
specify the following values:
ByteMatchSetUpdate
object, you delete the existing
object and add a new one.User-Agent
header.TargetString
in the ByteMatchTuple data type.
For example, you can add a ByteMatchSetUpdate
object that
matches web requests in which User-Agent
headers contain the
string BadBot
. You can then configure AWS WAF to block those
requests.
To create and configure a ByteMatchSet
, perform the
following steps:
ByteMatchSet.
For more information, see
CreateByteMatchSet.ChangeToken
parameter of an
UpdateByteMatchSet
request.UpdateByteMatchSet
request to specify the part
of the request that you want AWS WAF to inspect (for example, the header
or the URI) and the value that you want AWS WAF to watch for.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateByteMatchSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateIPSetResult> updateIPSetAsync(UpdateIPSetRequest updateIPSetRequest)
Inserts or deletes IPSetDescriptor objects in an
IPSet
. For each IPSetDescriptor
object, you
specify the following values:
IPSetDescriptor
object, you delete the existing
object and add a new one.IPv4
.192.0.2.0/24
(for the range of IP addresses from
192.0.2.0
to 192.0.2.255
) or
192.0.2.44/32
(for the individual IP address
192.0.2.44
).AWS WAF supports /8, /16, /24, and /32 IP address ranges. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
You use an IPSet
to specify which web requests you want to
allow or block based on the IP addresses that the requests originated
from. For example, if you're receiving a lot of requests from one or a
small number of IP addresses and you want to block the requests, you can
create an IPSet
that specifies those IP addresses, and then
configure AWS WAF to block the requests.
To create and configure an IPSet
, perform the following
steps:
ChangeToken
parameter of an UpdateIPSet request.UpdateIPSet
request to specify the IP
addresses that you want AWS WAF to watch for.
When you update an IPSet
, you specify the IP addresses that
you want to add and/or the IP addresses that you want to delete. If you
want to change an IP address, you delete the existing IP address and add
the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateIPSetRequest
- Future<UpdateIPSetResult> updateIPSetAsync(UpdateIPSetRequest updateIPSetRequest, AsyncHandler<UpdateIPSetRequest,UpdateIPSetResult> asyncHandler)
Inserts or deletes IPSetDescriptor objects in an
IPSet
. For each IPSetDescriptor
object, you
specify the following values:
IPSetDescriptor
object, you delete the existing
object and add a new one.IPv4
.192.0.2.0/24
(for the range of IP addresses from
192.0.2.0
to 192.0.2.255
) or
192.0.2.44/32
(for the individual IP address
192.0.2.44
).AWS WAF supports /8, /16, /24, and /32 IP address ranges. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
You use an IPSet
to specify which web requests you want to
allow or block based on the IP addresses that the requests originated
from. For example, if you're receiving a lot of requests from one or a
small number of IP addresses and you want to block the requests, you can
create an IPSet
that specifies those IP addresses, and then
configure AWS WAF to block the requests.
To create and configure an IPSet
, perform the following
steps:
ChangeToken
parameter of an UpdateIPSet request.UpdateIPSet
request to specify the IP
addresses that you want AWS WAF to watch for.
When you update an IPSet
, you specify the IP addresses that
you want to add and/or the IP addresses that you want to delete. If you
want to change an IP address, you delete the existing IP address and add
the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateIPSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateRuleResult> updateRuleAsync(UpdateRuleRequest updateRuleRequest)
Inserts or deletes Predicate objects in a Rule
. Each
Predicate
object identifies a predicate, such as a
ByteMatchSet or an IPSet, that specifies the web requests
that you want to allow, block, or count. If you add more than one
predicate to a Rule
, a request must match all of the
specifications to be allowed, blocked, or counted. For example, suppose
you add the following to a Rule
:
ByteMatchSet
that matches the value
BadBot
in the User-Agent
headerIPSet
that matches the IP address
192.0.2.44
You then add the Rule
to a WebACL
and specify
that you want to block requests that satisfy the Rule
. For a
request to be blocked, the User-Agent
header in the request
must contain the value BadBot
and the request must
originate from the IP address 192.0.2.44.
To create and configure a Rule
, perform the following steps:
Rule
.Rule
. See CreateRule.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an UpdateRule
request.UpdateRule
request to add predicates to the
Rule
.WebACL
that contains the
Rule
. See CreateWebACL.
If you want to replace one ByteMatchSet
or
IPSet
with another, you delete the existing one and add the
new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateRuleRequest
- Future<UpdateRuleResult> updateRuleAsync(UpdateRuleRequest updateRuleRequest, AsyncHandler<UpdateRuleRequest,UpdateRuleResult> asyncHandler)
Inserts or deletes Predicate objects in a Rule
. Each
Predicate
object identifies a predicate, such as a
ByteMatchSet or an IPSet, that specifies the web requests
that you want to allow, block, or count. If you add more than one
predicate to a Rule
, a request must match all of the
specifications to be allowed, blocked, or counted. For example, suppose
you add the following to a Rule
:
ByteMatchSet
that matches the value
BadBot
in the User-Agent
headerIPSet
that matches the IP address
192.0.2.44
You then add the Rule
to a WebACL
and specify
that you want to block requests that satisfy the Rule
. For a
request to be blocked, the User-Agent
header in the request
must contain the value BadBot
and the request must
originate from the IP address 192.0.2.44.
To create and configure a Rule
, perform the following steps:
Rule
.Rule
. See CreateRule.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an UpdateRule
request.UpdateRule
request to add predicates to the
Rule
.WebACL
that contains the
Rule
. See CreateWebACL.
If you want to replace one ByteMatchSet
or
IPSet
with another, you delete the existing one and add the
new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateRuleRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateSqlInjectionMatchSetResult> updateSqlInjectionMatchSetAsync(UpdateSqlInjectionMatchSetRequest updateSqlInjectionMatchSetRequest)
Inserts or deletes SqlInjectionMatchTuple objects (filters) in a
SqlInjectionMatchSet. For each SqlInjectionMatchTuple
object, you specify the following values:
Action
: Whether to insert the object into or delete the
object from the array. To change a SqlInjectionMatchTuple
,
you delete the existing object and add a new one.FieldToMatch
: The part of web requests that you want AWS
WAF to inspect and, if you want AWS WAF to inspect a header, the name of
the header.TextTransformation
: Which text transformation, if any,
to perform on the web request before inspecting the request for snippets
of malicious SQL code.
You use SqlInjectionMatchSet
objects to specify which
CloudFront requests you want to allow, block, or count. For example, if
you're receiving requests that contain snippets of SQL code in the query
string and you want to block the requests, you can create a
SqlInjectionMatchSet
with the applicable settings, and then
configure AWS WAF to block the requests.
To create and configure a SqlInjectionMatchSet
, perform the
following steps:
ChangeToken
parameter of an UpdateIPSet request.UpdateSqlInjectionMatchSet
request to specify
the parts of web requests that you want AWS WAF to inspect for snippets
of SQL code.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateSqlInjectionMatchSetRequest
- A request to update a SqlInjectionMatchSet.Future<UpdateSqlInjectionMatchSetResult> updateSqlInjectionMatchSetAsync(UpdateSqlInjectionMatchSetRequest updateSqlInjectionMatchSetRequest, AsyncHandler<UpdateSqlInjectionMatchSetRequest,UpdateSqlInjectionMatchSetResult> asyncHandler)
Inserts or deletes SqlInjectionMatchTuple objects (filters) in a
SqlInjectionMatchSet. For each SqlInjectionMatchTuple
object, you specify the following values:
Action
: Whether to insert the object into or delete the
object from the array. To change a SqlInjectionMatchTuple
,
you delete the existing object and add a new one.FieldToMatch
: The part of web requests that you want AWS
WAF to inspect and, if you want AWS WAF to inspect a header, the name of
the header.TextTransformation
: Which text transformation, if any,
to perform on the web request before inspecting the request for snippets
of malicious SQL code.
You use SqlInjectionMatchSet
objects to specify which
CloudFront requests you want to allow, block, or count. For example, if
you're receiving requests that contain snippets of SQL code in the query
string and you want to block the requests, you can create a
SqlInjectionMatchSet
with the applicable settings, and then
configure AWS WAF to block the requests.
To create and configure a SqlInjectionMatchSet
, perform the
following steps:
ChangeToken
parameter of an UpdateIPSet request.UpdateSqlInjectionMatchSet
request to specify
the parts of web requests that you want AWS WAF to inspect for snippets
of SQL code.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateSqlInjectionMatchSetRequest
- A request to update a SqlInjectionMatchSet.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateWebACLResult> updateWebACLAsync(UpdateWebACLRequest updateWebACLRequest)
Inserts or deletes ActivatedRule objects in a WebACL
.
Each Rule
identifies web requests that you want to allow,
block, or count. When you update a WebACL
, you specify the
following values:
WebACL
, either
ALLOW
or BLOCK
. AWS WAF performs the default
action if a request doesn't match the criteria in any of the
Rules
in a WebACL
.Rules
that you want to add and/or delete. If you
want to replace one Rule
with another, you delete the
existing Rule
and add the new one.Rule
, whether you want AWS WAF to allow
requests, block requests, or count requests that match the conditions in
the Rule
.Rules
in a WebACL
. If you add more than one
Rule
to a WebACL
, AWS WAF evaluates each
request against the Rules
in order based on the value of
Priority
. (The Rule
that has the lowest value
for Priority
is evaluated first.) When a web request matches
all of the predicates (such as ByteMatchSets
and
IPSets
) in a Rule
, AWS WAF immediately takes
the corresponding action, allow or block, and doesn't evaluate the
request against the remaining Rules
in the
WebACL
, if any.WebACL
.
To create and configure a WebACL
, perform the following
steps:
Rules
. For more information, see CreateByteMatchSet,
UpdateByteMatchSet, CreateIPSet, UpdateIPSet,
CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Rules
that you want to include in
the WebACL
. For more information, see CreateRule and
UpdateRule.WebACL
. See CreateWebACL.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an
UpdateWebACL request.UpdateWebACL
request to specify the
Rules
that you want to include in the WebACL
,
to specify the default action, and to associate the WebACL
with a CloudFront distribution.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateWebACLRequest
- Future<UpdateWebACLResult> updateWebACLAsync(UpdateWebACLRequest updateWebACLRequest, AsyncHandler<UpdateWebACLRequest,UpdateWebACLResult> asyncHandler)
Inserts or deletes ActivatedRule objects in a WebACL
.
Each Rule
identifies web requests that you want to allow,
block, or count. When you update a WebACL
, you specify the
following values:
WebACL
, either
ALLOW
or BLOCK
. AWS WAF performs the default
action if a request doesn't match the criteria in any of the
Rules
in a WebACL
.Rules
that you want to add and/or delete. If you
want to replace one Rule
with another, you delete the
existing Rule
and add the new one.Rule
, whether you want AWS WAF to allow
requests, block requests, or count requests that match the conditions in
the Rule
.Rules
in a WebACL
. If you add more than one
Rule
to a WebACL
, AWS WAF evaluates each
request against the Rules
in order based on the value of
Priority
. (The Rule
that has the lowest value
for Priority
is evaluated first.) When a web request matches
all of the predicates (such as ByteMatchSets
and
IPSets
) in a Rule
, AWS WAF immediately takes
the corresponding action, allow or block, and doesn't evaluate the
request against the remaining Rules
in the
WebACL
, if any.WebACL
.
To create and configure a WebACL
, perform the following
steps:
Rules
. For more information, see CreateByteMatchSet,
UpdateByteMatchSet, CreateIPSet, UpdateIPSet,
CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Rules
that you want to include in
the WebACL
. For more information, see CreateRule and
UpdateRule.WebACL
. See CreateWebACL.GetChangeToken
to get the change token that you
provide in the ChangeToken
parameter of an
UpdateWebACL request.UpdateWebACL
request to specify the
Rules
that you want to include in the WebACL
,
to specify the default action, and to associate the WebACL
with a CloudFront distribution.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateWebACLRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2015. All rights reserved.