AbstractAWSWAF (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.waf.AbstractAWSWAF

All Implemented Interfaces:

AWSWAF

Direct Known Subclasses:

AbstractAWSWAFAsync
```
public class AbstractAWSWAF
extends Object
implements AWSWAF
```
Abstract implementation of AWSWAF. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Method Summary

Methods
Modifier and Type	Method and Description
`CreateByteMatchSetResult`	`createByteMatchSet(CreateByteMatchSetRequest request)` Creates a `ByteMatchSet`.
`CreateIPSetResult`	`createIPSet(CreateIPSetRequest request)` 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.
`CreateRuleResult`	`createRule(CreateRuleRequest request)` Creates a `Rule`, which contains the `IPSet` objects, `ByteMatchSet` objects, and other predicates that identify the requests that you want to block.
`CreateSizeConstraintSetResult`	`createSizeConstraintSet(CreateSizeConstraintSetRequest request)` Creates a `SizeConstraintSet`.
`CreateSqlInjectionMatchSetResult`	`createSqlInjectionMatchSet(CreateSqlInjectionMatchSetRequest request)` 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.
`CreateWebACLResult`	`createWebACL(CreateWebACLRequest request)` Creates a `WebACL`, which contains the `Rules` that identify the CloudFront web requests that you want to allow, block, or count.
`DeleteByteMatchSetResult`	`deleteByteMatchSet(DeleteByteMatchSetRequest request)` Permanently deletes a ByteMatchSet.
`DeleteIPSetResult`	`deleteIPSet(DeleteIPSetRequest request)` Permanently deletes an IPSet.
`DeleteRuleResult`	`deleteRule(DeleteRuleRequest request)` Permanently deletes a Rule.
`DeleteSizeConstraintSetResult`	`deleteSizeConstraintSet(DeleteSizeConstraintSetRequest request)` Permanently deletes a SizeConstraintSet.
`DeleteSqlInjectionMatchSetResult`	`deleteSqlInjectionMatchSet(DeleteSqlInjectionMatchSetRequest request)` Permanently deletes a SqlInjectionMatchSet.
`DeleteWebACLResult`	`deleteWebACL(DeleteWebACLRequest request)` Permanently deletes a WebACL.
`GetByteMatchSetResult`	`getByteMatchSet(GetByteMatchSetRequest request)` Returns the ByteMatchSet specified by `ByteMatchSetId`.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetChangeTokenResult`	`getChangeToken(GetChangeTokenRequest request)` 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.
`GetChangeTokenStatusResult`	`getChangeTokenStatus(GetChangeTokenStatusRequest request)` Returns the status of a `ChangeToken` that you got by calling GetChangeToken.
`GetIPSetResult`	`getIPSet(GetIPSetRequest request)` Returns the IPSet that is specified by `IPSetId`.
`GetRuleResult`	`getRule(GetRuleRequest request)` Returns the Rule that is specified by the `RuleId` that you included in the `GetRule` request.
`GetSampledRequestsResult`	`getSampledRequests(GetSampledRequestsRequest request)` 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.
`GetSizeConstraintSetResult`	`getSizeConstraintSet(GetSizeConstraintSetRequest request)` Returns the SizeConstraintSet specified by `SizeConstraintSetId`.
`GetSqlInjectionMatchSetResult`	`getSqlInjectionMatchSet(GetSqlInjectionMatchSetRequest request)` Returns the SqlInjectionMatchSet that is specified by `SqlInjectionMatchSetId`.
`GetWebACLResult`	`getWebACL(GetWebACLRequest request)` Returns the WebACL that is specified by `WebACLId`.
`ListByteMatchSetsResult`	`listByteMatchSets(ListByteMatchSetsRequest request)` Returns an array of ByteMatchSetSummary objects.
`ListIPSetsResult`	`listIPSets(ListIPSetsRequest request)` Returns an array of IPSetSummary objects in the response.
`ListRulesResult`	`listRules(ListRulesRequest request)` Returns an array of RuleSummary objects.
`ListSizeConstraintSetsResult`	`listSizeConstraintSets(ListSizeConstraintSetsRequest request)` Returns an array of SizeConstraintSetSummary objects.
`ListSqlInjectionMatchSetsResult`	`listSqlInjectionMatchSets(ListSqlInjectionMatchSetsRequest request)` Returns an array of SqlInjectionMatchSet objects.
`ListWebACLsResult`	`listWebACLs(ListWebACLsRequest request)` Returns an array of WebACLSummary objects in the response.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://waf.amazonaws.com/").
`void`	`setRegion(Region region)` An alternative to `AWSWAF.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateByteMatchSetResult`	`updateByteMatchSet(UpdateByteMatchSetRequest request)` Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet.
`UpdateIPSetResult`	`updateIPSet(UpdateIPSetRequest request)` Inserts or deletes IPSetDescriptor objects in an `IPSet`.
`UpdateRuleResult`	`updateRule(UpdateRuleRequest request)` Inserts or deletes Predicate objects in a `Rule`.
`UpdateSizeConstraintSetResult`	`updateSizeConstraintSet(UpdateSizeConstraintSetRequest request)` Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet.
`UpdateSqlInjectionMatchSetResult`	`updateSqlInjectionMatchSet(UpdateSqlInjectionMatchSetRequest request)` Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet.
`UpdateWebACLResult`	`updateWebACL(UpdateWebACLRequest request)` Inserts or deletes ActivatedRule objects in a `WebACL`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSWAF
    
    Overrides the default endpoint for this client ("https://waf.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "waf.amazonaws.com/") or a full URL, including the protocol (ex: "https://waf.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AWSWAF
    
    Parameters:
    endpoint - The endpoint (ex: "waf.amazonaws.com/") or a full URL, including the protocol (ex: "https://waf.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSWAF
    
    An alternative to AWSWAF.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AWSWAF
    
    Parameters:
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    See Also:
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - createByteMatchSet
```
public CreateByteMatchSetResult createByteMatchSet(CreateByteMatchSetRequest request)
```
    Description copied from interface: AWSWAF
    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:
    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request.
    2. Submit a CreateByteMatchSet request.
    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.
    4. Submit an 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.
    Specified by:
    
    createByteMatchSet in interface AWSWAF
    
    Returns:
    Result of the CreateByteMatchSet operation returned by the service.
  - createIPSet
```
public CreateIPSetResult createIPSet(CreateIPSetRequest request)
```
    Description copied from interface: AWSWAF
    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:
    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.
    2. Submit a CreateIPSet request.
    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
    4. Submit an 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.
    Specified by:
    
    createIPSet in interface AWSWAF
    
    Returns:
    Result of the CreateIPSet operation returned by the service.
  - createRule
```
public CreateRuleResult createRule(CreateRuleRequest request)
```
    Description copied from interface: AWSWAF
    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:
    - An IPSet that matches the IP address 192.0.2.44/32
    - A 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:
    1. Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.
    3. Submit a CreateRule request.
    4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
    5. Submit an UpdateRule request to specify the predicates that you want to include in the Rule.
    6. Create and update a 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.
    Specified by:
    
    createRule in interface AWSWAF
    
    Returns:
    Result of the CreateRule operation returned by the service.
  - createSizeConstraintSet
```
public CreateSizeConstraintSetResult createSizeConstraintSet(CreateSizeConstraintSetRequest request)
```
    Description copied from interface: AWSWAF
    Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.
    
    To create and configure a SizeConstraintSet, perform the following steps:
    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request.
    2. Submit a CreateSizeConstraintSet request.
    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.
    4. Submit an UpdateSizeConstraintSet 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.
    Specified by:
    
    createSizeConstraintSet in interface AWSWAF
    
    Returns:
    Result of the CreateSizeConstraintSet operation returned by the service.
  - createSqlInjectionMatchSet
```
public CreateSqlInjectionMatchSetResult createSqlInjectionMatchSet(CreateSqlInjectionMatchSetRequest request)
```
    Description copied from interface: AWSWAF
    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:
    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request.
    2. Submit a CreateSqlInjectionMatchSet request.
    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request.
    4. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious 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.
    Specified by:
    
    createSqlInjectionMatchSet in interface AWSWAF
    
    Parameters:
    request - A request to create a SqlInjectionMatchSet.
    
    Returns:
    Result of the CreateSqlInjectionMatchSet operation returned by the service.
  - createWebACL
```
public CreateWebACLResult createWebACL(CreateWebACLRequest request)
```
    Description copied from interface: AWSWAF
    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:
    1. Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
    2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.
    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request.
    4. Submit a CreateWebACL request.
    5. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.
    6. Submit an 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, see the AWS WAF Developer Guide.
    Specified by:
    
    createWebACL in interface AWSWAF
    
    Returns:
    Result of the CreateWebACL operation returned by the service.
  - deleteByteMatchSet
```
public DeleteByteMatchSetResult deleteByteMatchSet(DeleteByteMatchSetRequest request)
```
    Description copied from interface: AWSWAF
    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:
    1. Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.
    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request.
    3. Submit a DeleteByteMatchSet request.
    Specified by:
    
    deleteByteMatchSet in interface AWSWAF
    
    Returns:
    Result of the DeleteByteMatchSet operation returned by the service.
  - deleteIPSet
```
public DeleteIPSetResult deleteIPSet(DeleteIPSetRequest request)
```
    Description copied from interface: AWSWAF
    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:
    1. Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.
    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request.
    3. Submit a DeleteIPSet request.
    Specified by:
    
    deleteIPSet in interface AWSWAF
    
    Returns:
    Result of the DeleteIPSet operation returned by the service.
  - deleteRule
```
public DeleteRuleResult deleteRule(DeleteRuleRequest request)
```
    Description copied from interface: AWSWAF
    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:
    1. Update the Rule to remove predicates, if any. For more information, see UpdateRule.
    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request.
    3. Submit a DeleteRule request.
    Specified by:
    
    deleteRule in interface AWSWAF
    
    Returns:
    Result of the DeleteRule operation returned by the service.
  - deleteSizeConstraintSet
```
public DeleteSizeConstraintSetResult deleteSizeConstraintSet(DeleteSizeConstraintSetRequest request)
```
    Description copied from interface: AWSWAF
    Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters).
    
    If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule.
    
    To permanently delete a SizeConstraintSet, perform the following steps:
    1. Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet.
    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request.
    3. Submit a DeleteSizeConstraintSet request.
    Specified by:
    
    deleteSizeConstraintSet in interface AWSWAF
    
    Returns:
    Result of the DeleteSizeConstraintSet operation returned by the service.
  - deleteSqlInjectionMatchSet
```
public DeleteSqlInjectionMatchSetResult deleteSqlInjectionMatchSet(DeleteSqlInjectionMatchSetRequest request)
```
    Description copied from interface: AWSWAF
    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:
    1. Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.
    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request.
    3. Submit a DeleteSqlInjectionMatchSet request.
    Specified by:
    
    deleteSqlInjectionMatchSet in interface AWSWAF
    
    Parameters:
    request - A request to delete a SqlInjectionMatchSet from AWS WAF.
    
    Returns:
    Result of the DeleteSqlInjectionMatchSet operation returned by the service.
  - deleteWebACL
```
public DeleteWebACLResult deleteWebACL(DeleteWebACLRequest request)
```
    Description copied from interface: AWSWAF
    Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules.
    
    To delete a WebACL, perform the following steps:
    1. Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL.
    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request.
    3. Submit a DeleteWebACL request.
    Specified by:
    
    deleteWebACL in interface AWSWAF
    
    Returns:
    Result of the DeleteWebACL operation returned by the service.
  - getByteMatchSet
```
public GetByteMatchSetResult getByteMatchSet(GetByteMatchSetRequest request)
```
    Description copied from interface: AWSWAF
    
    Returns the ByteMatchSet specified by ByteMatchSetId.
    
    Specified by:
    
    getByteMatchSet in interface AWSWAF
    
    Returns:
    Result of the GetByteMatchSet operation returned by the service.
  - getChangeToken
```
public GetChangeTokenResult getChangeToken(GetChangeTokenRequest request)
```
    Description copied from interface: AWSWAF
    
    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.
    
    Specified by:
    
    getChangeToken in interface AWSWAF
    
    Returns:
    Result of the GetChangeToken operation returned by the service.
  - getChangeTokenStatus
```
public GetChangeTokenStatusResult getChangeTokenStatus(GetChangeTokenStatusRequest request)
```
    Description copied from interface: AWSWAF
    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.
    Specified by:
    
    getChangeTokenStatus in interface AWSWAF
    
    Returns:
    Result of the GetChangeTokenStatus operation returned by the service.
  - getIPSet
```
public GetIPSetResult getIPSet(GetIPSetRequest request)
```
    Description copied from interface: AWSWAF
    
    Returns the IPSet that is specified by IPSetId.
    
    Specified by:
    
    getIPSet in interface AWSWAF
    
    Returns:
    Result of the GetIPSet operation returned by the service.
  - getRule
```
public GetRuleResult getRule(GetRuleRequest request)
```
    Description copied from interface: AWSWAF
    
    Returns the Rule that is specified by the RuleId that you included in the GetRule request.
    
    Specified by:
    
    getRule in interface AWSWAF
    
    Returns:
    Result of the GetRule operation returned by the service.
  - getSampledRequests
```
public GetSampledRequestsResult getSampledRequests(GetSampledRequestsRequest request)
```
    Description copied from interface: AWSWAF
    
    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.
    
    Specified by:
    
    getSampledRequests in interface AWSWAF
    
    Returns:
    Result of the GetSampledRequests operation returned by the service.
  - getSizeConstraintSet
```
public GetSizeConstraintSetResult getSizeConstraintSet(GetSizeConstraintSetRequest request)
```
    Description copied from interface: AWSWAF
    
    Returns the SizeConstraintSet specified by SizeConstraintSetId.
    
    Specified by:
    
    getSizeConstraintSet in interface AWSWAF
    
    Returns:
    Result of the GetSizeConstraintSet operation returned by the service.
  - getSqlInjectionMatchSet
```
public GetSqlInjectionMatchSetResult getSqlInjectionMatchSet(GetSqlInjectionMatchSetRequest request)
```
    Description copied from interface: AWSWAF
    
    Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.
    
    Specified by:
    
    getSqlInjectionMatchSet in interface AWSWAF
    
    Parameters:
    request - A request to get a SqlInjectionMatchSet.
    
    Returns:
    Result of the GetSqlInjectionMatchSet operation returned by the service.
  - getWebACL
```
public GetWebACLResult getWebACL(GetWebACLRequest request)
```
    Description copied from interface: AWSWAF
    
    Returns the WebACL that is specified by WebACLId.
    
    Specified by:
    
    getWebACL in interface AWSWAF
    
    Returns:
    Result of the GetWebACL operation returned by the service.
  - listByteMatchSets
```
public ListByteMatchSetsResult listByteMatchSets(ListByteMatchSetsRequest request)
```
    Description copied from interface: AWSWAF
    
    Returns an array of ByteMatchSetSummary objects.
    
    Specified by:
    
    listByteMatchSets in interface AWSWAF
    
    Returns:
    Result of the ListByteMatchSets operation returned by the service.
  - listIPSets
```
public ListIPSetsResult listIPSets(ListIPSetsRequest request)
```
    Description copied from interface: AWSWAF
    
    Returns an array of IPSetSummary objects in the response.
    
    Specified by:
    
    listIPSets in interface AWSWAF
    
    Returns:
    Result of the ListIPSets operation returned by the service.
  - listRules
```
public ListRulesResult listRules(ListRulesRequest request)
```
    Description copied from interface: AWSWAF
    
    Returns an array of RuleSummary objects.
    
    Specified by:
    
    listRules in interface AWSWAF
    
    Returns:
    Result of the ListRules operation returned by the service.
  - listSizeConstraintSets
```
public ListSizeConstraintSetsResult listSizeConstraintSets(ListSizeConstraintSetsRequest request)
```
    Description copied from interface: AWSWAF
    
    Returns an array of SizeConstraintSetSummary objects.
    
    Specified by:
    
    listSizeConstraintSets in interface AWSWAF
    
    Returns:
    Result of the ListSizeConstraintSets operation returned by the service.
  - listSqlInjectionMatchSets
```
public ListSqlInjectionMatchSetsResult listSqlInjectionMatchSets(ListSqlInjectionMatchSetsRequest request)
```
    Description copied from interface: AWSWAF
    
    Returns an array of SqlInjectionMatchSet objects.
    
    Specified by:
    
    listSqlInjectionMatchSets in interface AWSWAF
    
    Parameters:
    request - A request to list the SqlInjectionMatchSet objects created by the current AWS account.
    
    Returns:
    Result of the ListSqlInjectionMatchSets operation returned by the service.
  - listWebACLs
```
public ListWebACLsResult listWebACLs(ListWebACLsRequest request)
```
    Description copied from interface: AWSWAF
    
    Returns an array of WebACLSummary objects in the response.
    
    Specified by:
    
    listWebACLs in interface AWSWAF
    
    Returns:
    Result of the ListWebACLs operation returned by the service.
  - updateByteMatchSet
```
public UpdateByteMatchSetResult updateByteMatchSet(UpdateByteMatchSetRequest request)
```
    Description copied from interface: AWSWAF
    Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:
    - Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.
    - The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.
    - The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.
    - Where to look, such as at the beginning or the end of a query string.
    - Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
    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:
    1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.
    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.
    3. Submit an 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.
    Specified by:
    
    updateByteMatchSet in interface AWSWAF
    
    Returns:
    Result of the UpdateByteMatchSet operation returned by the service.
  - updateIPSet
```
public UpdateIPSetResult updateIPSet(UpdateIPSetRequest request)
```
    Description copied from interface: AWSWAF
    Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:
    - Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.
    - The IP address version, IPv4.
    - The IP address in CIDR notation, for example, 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:
    1. Submit a CreateIPSet request.
    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
    3. Submit an 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.
    Specified by:
    
    updateIPSet in interface AWSWAF
    
    Returns:
    Result of the UpdateIPSet operation returned by the service.
  - updateRule
```
public UpdateRuleResult updateRule(UpdateRuleRequest request)
```
    Description copied from interface: AWSWAF
    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:
    - A ByteMatchSet that matches the value BadBot in the User-Agent header
    - An IPSet 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:
    1. Create and update the predicates that you want to include in the Rule.
    2. Create the Rule. See CreateRule.
    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
    4. Submit an UpdateRule request to add predicates to the Rule.
    5. Create and update a 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.
    Specified by:
    
    updateRule in interface AWSWAF
    
    Returns:
    Result of the UpdateRule operation returned by the service.
  - updateSizeConstraintSet
```
public UpdateSizeConstraintSetResult updateSizeConstraintSet(UpdateSizeConstraintSetRequest request)
```
    Description copied from interface: AWSWAF
    Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values:
    - Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one.
    - The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header.
    - Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF.
    - A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on.
    - The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.
    For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.
    
    To create and configure a SizeConstraintSet, perform the following steps:
    1. Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.
    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.
    3. Submit an UpdateSizeConstraintSet 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.
    Specified by:
    
    updateSizeConstraintSet in interface AWSWAF
    
    Returns:
    Result of the UpdateSizeConstraintSet operation returned by the service.
  - updateSqlInjectionMatchSet
```
public UpdateSqlInjectionMatchSetResult updateSqlInjectionMatchSet(UpdateSqlInjectionMatchSetRequest request)
```
    Description copied from interface: AWSWAF
    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:
    1. Submit a CreateSqlInjectionMatchSet request.
    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
    3. Submit an 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.
    Specified by:
    
    updateSqlInjectionMatchSet in interface AWSWAF
    
    Parameters:
    request - A request to update a SqlInjectionMatchSet.
    
    Returns:
    Result of the UpdateSqlInjectionMatchSet operation returned by the service.
  - updateWebACL
```
public UpdateWebACLResult updateWebACL(UpdateWebACLRequest request)
```
    Description copied from interface: AWSWAF
    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:
    - A default action for the 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.
    - The 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.
    - For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.
    - The order in which you want AWS WAF to evaluate the 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.
    - The CloudFront distribution that you want to associate with the WebACL.
    To create and configure a WebACL, perform the following steps:
    1. Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
    2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.
    3. Create a WebACL. See CreateWebACL.
    4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.
    5. Submit an 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.
    Specified by:
    
    updateWebACL in interface AWSWAF
    
    Returns:
    Result of the UpdateWebACL operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSWAF
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSWAF
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSWAF
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSWAF
    
    Parameters:
    request - The originally executed request.
    
    Returns:
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSWAF

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

createByteMatchSet

createIPSet

createRule

createSizeConstraintSet

createSqlInjectionMatchSet

createWebACL

deleteByteMatchSet

deleteIPSet

deleteRule

deleteSizeConstraintSet

deleteSqlInjectionMatchSet

deleteWebACL

getByteMatchSet

getChangeToken

getChangeTokenStatus

getIPSet

getRule

getSampledRequests

getSizeConstraintSet

getSqlInjectionMatchSet

getWebACL

listByteMatchSets

listIPSets

listRules

listSizeConstraintSets

listSqlInjectionMatchSets

listWebACLs

updateByteMatchSet

updateIPSet

updateRule

updateSizeConstraintSet

updateSqlInjectionMatchSet

updateWebACL

shutdown

getCachedResponseMetadata