AbstractAWSWAFV2 (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.AbstractAWSWAFV2

All Implemented Interfaces:

AWSWAFV2

Direct Known Subclasses:

AbstractAWSWAFV2Async
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSWAFV2
extends Object
implements AWSWAFV2
```
Abstract implementation of AWSWAFV2. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.wafv2.AWSWAFV2
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateWebACLResult`	`associateWebACL(AssociateWebACLRequest request)` Associates a web ACL with a regional application resource, to protect the resource.
`CheckCapacityResult`	`checkCapacity(CheckCapacityRequest request)` Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules.
`CreateIPSetResult`	`createIPSet(CreateIPSetRequest request)` Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses.
`CreateRegexPatternSetResult`	`createRegexPatternSet(CreateRegexPatternSetRequest request)` Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.
`CreateRuleGroupResult`	`createRuleGroup(CreateRuleGroupRequest request)` Creates a RuleGroup per the specifications provided.
`CreateWebACLResult`	`createWebACL(CreateWebACLRequest request)` Creates a WebACL per the specifications provided.
`DeleteFirewallManagerRuleGroupsResult`	`deleteFirewallManagerRuleGroups(DeleteFirewallManagerRuleGroupsRequest request)` Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.
`DeleteIPSetResult`	`deleteIPSet(DeleteIPSetRequest request)` Deletes the specified IPSet.
`DeleteLoggingConfigurationResult`	`deleteLoggingConfiguration(DeleteLoggingConfigurationRequest request)` Deletes the LoggingConfiguration from the specified web ACL.
`DeletePermissionPolicyResult`	`deletePermissionPolicy(DeletePermissionPolicyRequest request)` Permanently deletes an IAM policy from the specified rule group.
`DeleteRegexPatternSetResult`	`deleteRegexPatternSet(DeleteRegexPatternSetRequest request)` Deletes the specified RegexPatternSet.
`DeleteRuleGroupResult`	`deleteRuleGroup(DeleteRuleGroupRequest request)` Deletes the specified RuleGroup.
`DeleteWebACLResult`	`deleteWebACL(DeleteWebACLRequest request)` Deletes the specified WebACL.
`DescribeManagedRuleGroupResult`	`describeManagedRuleGroup(DescribeManagedRuleGroupRequest request)` Provides high-level information for a managed rule group, including descriptions of the rules.
`DisassociateWebACLResult`	`disassociateWebACL(DisassociateWebACLRequest request)` Disassociates the specified regional application resource from any existing web ACL association.
`GenerateMobileSdkReleaseUrlResult`	`generateMobileSdkReleaseUrl(GenerateMobileSdkReleaseUrlRequest request)` Generates a presigned download URL for the specified release of the mobile SDK.
`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.
`GetIPSetResult`	`getIPSet(GetIPSetRequest request)` Retrieves the specified IPSet.
`GetLoggingConfigurationResult`	`getLoggingConfiguration(GetLoggingConfigurationRequest request)` Returns the LoggingConfiguration for the specified web ACL.
`GetManagedRuleSetResult`	`getManagedRuleSet(GetManagedRuleSetRequest request)` Retrieves the specified managed rule set.
`GetMobileSdkReleaseResult`	`getMobileSdkRelease(GetMobileSdkReleaseRequest request)` Retrieves information for the specified mobile SDK release, including release notes and tags.
`GetPermissionPolicyResult`	`getPermissionPolicy(GetPermissionPolicyRequest request)` Returns the IAM policy that is attached to the specified rule group.
`GetRateBasedStatementManagedKeysResult`	`getRateBasedStatementManagedKeys(GetRateBasedStatementManagedKeysRequest request)` Retrieves the keys that are currently blocked by a rate-based rule instance.
`GetRegexPatternSetResult`	`getRegexPatternSet(GetRegexPatternSetRequest request)` Retrieves the specified RegexPatternSet.
`GetRuleGroupResult`	`getRuleGroup(GetRuleGroupRequest request)` Retrieves the specified RuleGroup.
`GetSampledRequestsResult`	`getSampledRequests(GetSampledRequestsRequest request)` Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose.
`GetWebACLResult`	`getWebACL(GetWebACLRequest request)` Retrieves the specified WebACL.
`GetWebACLForResourceResult`	`getWebACLForResource(GetWebACLForResourceRequest request)` Retrieves the WebACL for the specified resource.
`ListAvailableManagedRuleGroupsResult`	`listAvailableManagedRuleGroups(ListAvailableManagedRuleGroupsRequest request)` Retrieves an array of managed rule groups that are available for you to use.
`ListAvailableManagedRuleGroupVersionsResult`	`listAvailableManagedRuleGroupVersions(ListAvailableManagedRuleGroupVersionsRequest request)` Returns a list of the available versions for the specified managed rule group.
`ListIPSetsResult`	`listIPSets(ListIPSetsRequest request)` Retrieves an array of IPSetSummary objects for the IP sets that you manage.
`ListLoggingConfigurationsResult`	`listLoggingConfigurations(ListLoggingConfigurationsRequest request)` Retrieves an array of your LoggingConfiguration objects.
`ListManagedRuleSetsResult`	`listManagedRuleSets(ListManagedRuleSetsRequest request)` Retrieves the managed rule sets that you own.
`ListMobileSdkReleasesResult`	`listMobileSdkReleases(ListMobileSdkReleasesRequest request)` Retrieves a list of the available releases for the mobile SDK and the specified device platform.
`ListRegexPatternSetsResult`	`listRegexPatternSets(ListRegexPatternSetsRequest request)` Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
`ListResourcesForWebACLResult`	`listResourcesForWebACL(ListResourcesForWebACLRequest request)` Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL.
`ListRuleGroupsResult`	`listRuleGroups(ListRuleGroupsRequest request)` Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Retrieves the TagInfoForResource for the specified resource.
`ListWebACLsResult`	`listWebACLs(ListWebACLsRequest request)` Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
`PutLoggingConfigurationResult`	`putLoggingConfiguration(PutLoggingConfigurationRequest request)` Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.
`PutManagedRuleSetVersionsResult`	`putManagedRuleSetVersions(PutManagedRuleSetVersionsRequest request)` Defines the versions of your managed rule set that you are offering to the customers.
`PutPermissionPolicyResult`	`putPermissionPolicy(PutPermissionPolicyRequest request)` Attaches an IAM policy to the specified resource.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Associates tags with the specified Amazon Web Services resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Disassociates tags from an Amazon Web Services resource.
`UpdateIPSetResult`	`updateIPSet(UpdateIPSetRequest request)` Updates the specified IPSet.
`UpdateManagedRuleSetVersionExpiryDateResult`	`updateManagedRuleSetVersionExpiryDate(UpdateManagedRuleSetVersionExpiryDateRequest request)` Updates the expiration information for your managed rule set.
`UpdateRegexPatternSetResult`	`updateRegexPatternSet(UpdateRegexPatternSetRequest request)` Updates the specified RegexPatternSet.
`UpdateRuleGroupResult`	`updateRuleGroup(UpdateRuleGroupRequest request)` Updates the specified RuleGroup.
`UpdateWebACLResult`	`updateWebACL(UpdateWebACLRequest request)` Updates the specified WebACL.

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

- Method Detail
  - associateWebACL
```
public AssociateWebACLResult associateWebACL(AssociateWebACLRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service.
    
    For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution.
    
    When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
    
    Specified by:
    
    associateWebACL in interface AWSWAFV2
    
    Returns:
    
    Result of the AssociateWebACL operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - checkCapacity
```
public CheckCapacityResult checkCapacity(CheckCapacityRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.
    
    WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
    
    Specified by:
    
    checkCapacity in interface AWSWAFV2
    
    Returns:
    
    Result of the CheckCapacity operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createIPSet
```
public CreateIPSetResult createIPSet(CreateIPSetRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.
    
    Specified by:
    
    createIPSet in interface AWSWAFV2
    
    Returns:
    
    Result of the CreateIPSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createRegexPatternSet
```
public CreateRegexPatternSetResult createRegexPatternSet(CreateRegexPatternSetRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.
    
    Specified by:
    
    createRegexPatternSet in interface AWSWAFV2
    
    Returns:
    
    Result of the CreateRegexPatternSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createRuleGroup
```
public CreateRuleGroupResult createRuleGroup(CreateRuleGroupRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Creates a RuleGroup per the specifications provided.
    
    A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
    
    Specified by:
    
    createRuleGroup in interface AWSWAFV2
    
    Returns:
    
    Result of the CreateRuleGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createWebACL
```
public CreateWebACLResult createWebACL(CreateWebACLRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Creates a WebACL per the specifications provided.
    
    A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, Amazon Cognito user pool, or an App Runner service.
    
    Specified by:
    
    createWebACL in interface AWSWAFV2
    
    Returns:
    
    Result of the CreateWebACL operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteFirewallManagerRuleGroups
```
public DeleteFirewallManagerRuleGroupsResult deleteFirewallManagerRuleGroups(DeleteFirewallManagerRuleGroupsRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.
    
    You can only use this if ManagedByFirewallManager is false in the specified WebACL.
    
    Specified by:
    
    deleteFirewallManagerRuleGroups in interface AWSWAFV2
    
    Returns:
    
    Result of the DeleteFirewallManagerRuleGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteIPSet
```
public DeleteIPSetResult deleteIPSet(DeleteIPSetRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Deletes the specified IPSet.
    
    Specified by:
    
    deleteIPSet in interface AWSWAFV2
    
    Returns:
    
    Result of the DeleteIPSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteLoggingConfiguration
```
public DeleteLoggingConfigurationResult deleteLoggingConfiguration(DeleteLoggingConfigurationRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Deletes the LoggingConfiguration from the specified web ACL.
    
    Specified by:
    
    deleteLoggingConfiguration in interface AWSWAFV2
    
    Returns:
    
    Result of the DeleteLoggingConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deletePermissionPolicy
```
public DeletePermissionPolicyResult deletePermissionPolicy(DeletePermissionPolicyRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Permanently deletes an IAM policy from the specified rule group.
    
    You must be the owner of the rule group to perform this operation.
    
    Specified by:
    
    deletePermissionPolicy in interface AWSWAFV2
    
    Returns:
    
    Result of the DeletePermissionPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRegexPatternSet
```
public DeleteRegexPatternSetResult deleteRegexPatternSet(DeleteRegexPatternSetRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Deletes the specified RegexPatternSet.
    
    Specified by:
    
    deleteRegexPatternSet in interface AWSWAFV2
    
    Returns:
    
    Result of the DeleteRegexPatternSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRuleGroup
```
public DeleteRuleGroupResult deleteRuleGroup(DeleteRuleGroupRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Deletes the specified RuleGroup.
    
    Specified by:
    
    deleteRuleGroup in interface AWSWAFV2
    
    Returns:
    
    Result of the DeleteRuleGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWebACL
```
public DeleteWebACLResult deleteWebACL(DeleteWebACLRequest request)
```
    Description copied from interface: AWSWAFV2
    Deletes the specified WebACL.
    
    You can only use this if ManagedByFirewallManager is false in the specified WebACL.
    Before deleting any web ACL, first disassociate it from all resources.
    
    To retrieve a list of the resources that are associated with a web ACL, use the following calls:
    
    For regional resources, call ListResourcesForWebACL.
    
    For Amazon CloudFront distributions, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId.
    
    To disassociate a resource from a web ACL, use the following calls:
    
    For regional resources, call DisassociateWebACL.
    
    For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.
    Specified by:
    
    deleteWebACL in interface AWSWAFV2
    
    Returns:
    
    Result of the DeleteWebACL operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeManagedRuleGroup
```
public DescribeManagedRuleGroupResult describeManagedRuleGroup(DescribeManagedRuleGroupRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Provides high-level information for a managed rule group, including descriptions of the rules.
    
    Specified by:
    
    describeManagedRuleGroup in interface AWSWAFV2
    
    Returns:
    
    Result of the DescribeManagedRuleGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateWebACL
```
public DisassociateWebACLResult disassociateWebACL(DisassociateWebACLRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service.
    
    For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.
    
    Specified by:
    
    disassociateWebACL in interface AWSWAFV2
    
    Returns:
    
    Result of the DisassociateWebACL operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - generateMobileSdkReleaseUrl
```
public GenerateMobileSdkReleaseUrlResult generateMobileSdkReleaseUrl(GenerateMobileSdkReleaseUrlRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Generates a presigned download URL for the specified release of the mobile SDK.
    
    The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.
    
    Specified by:
    
    generateMobileSdkReleaseUrl in interface AWSWAFV2
    
    Returns:
    
    Result of the GenerateMobileSdkReleaseUrl operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getIPSet
```
public GetIPSetResult getIPSet(GetIPSetRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves the specified IPSet.
    
    Specified by:
    
    getIPSet in interface AWSWAFV2
    
    Returns:
    
    Result of the GetIPSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getLoggingConfiguration
```
public GetLoggingConfigurationResult getLoggingConfiguration(GetLoggingConfigurationRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Returns the LoggingConfiguration for the specified web ACL.
    
    Specified by:
    
    getLoggingConfiguration in interface AWSWAFV2
    
    Returns:
    
    Result of the GetLoggingConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getManagedRuleSet
```
public GetManagedRuleSetResult getManagedRuleSet(GetManagedRuleSetRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves the specified managed rule set.
    
    This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
    
    Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
    
    Specified by:
    
    getManagedRuleSet in interface AWSWAFV2
    
    Returns:
    
    Result of the GetManagedRuleSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getMobileSdkRelease
```
public GetMobileSdkReleaseResult getMobileSdkRelease(GetMobileSdkReleaseRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves information for the specified mobile SDK release, including release notes and tags.
    
    The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.
    
    Specified by:
    
    getMobileSdkRelease in interface AWSWAFV2
    
    Returns:
    
    Result of the GetMobileSdkRelease operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getPermissionPolicy
```
public GetPermissionPolicyResult getPermissionPolicy(GetPermissionPolicyRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Returns the IAM policy that is attached to the specified rule group.
    
    You must be the owner of the rule group to perform this operation.
    
    Specified by:
    
    getPermissionPolicy in interface AWSWAFV2
    
    Returns:
    
    Result of the GetPermissionPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRateBasedStatementManagedKeys
```
public GetRateBasedStatementManagedKeysResult getRateBasedStatementManagedKeys(GetRateBasedStatementManagedKeysRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.
    
    For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.
    
    WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.
    
    Specified by:
    
    getRateBasedStatementManagedKeys in interface AWSWAFV2
    
    Returns:
    
    Result of the GetRateBasedStatementManagedKeys operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRegexPatternSet
```
public GetRegexPatternSetResult getRegexPatternSet(GetRegexPatternSetRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves the specified RegexPatternSet.
    
    Specified by:
    
    getRegexPatternSet in interface AWSWAFV2
    
    Returns:
    
    Result of the GetRegexPatternSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRuleGroup
```
public GetRuleGroupResult getRuleGroup(GetRuleGroupRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves the specified RuleGroup.
    
    Specified by:
    
    getRuleGroup in interface AWSWAFV2
    
    Returns:
    
    Result of the GetRuleGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSampledRequests
```
public GetSampledRequestsResult getSampledRequests(GetSampledRequestsRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 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 WAF selected the requests in the sample.
    
    Specified by:
    
    getSampledRequests in interface AWSWAFV2
    
    Returns:
    
    Result of the GetSampledRequests operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getWebACL
```
public GetWebACLResult getWebACL(GetWebACLRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves the specified WebACL.
    
    Specified by:
    
    getWebACL in interface AWSWAFV2
    
    Returns:
    
    Result of the GetWebACL operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getWebACLForResource
```
public GetWebACLForResourceResult getWebACLForResource(GetWebACLForResourceRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves the WebACL for the specified resource.
    
    Specified by:
    
    getWebACLForResource in interface AWSWAFV2
    
    Returns:
    
    Result of the GetWebACLForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAvailableManagedRuleGroupVersions
```
public ListAvailableManagedRuleGroupVersionsResult listAvailableManagedRuleGroupVersions(ListAvailableManagedRuleGroupVersionsRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Returns a list of the available versions for the specified managed rule group.
    
    Specified by:
    
    listAvailableManagedRuleGroupVersions in interface AWSWAFV2
    
    Returns:
    
    Result of the ListAvailableManagedRuleGroupVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAvailableManagedRuleGroups
```
public ListAvailableManagedRuleGroupsResult listAvailableManagedRuleGroups(ListAvailableManagedRuleGroupsRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.
    
    Specified by:
    
    listAvailableManagedRuleGroups in interface AWSWAFV2
    
    Returns:
    
    Result of the ListAvailableManagedRuleGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listIPSets
```
public ListIPSetsResult listIPSets(ListIPSetsRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves an array of IPSetSummary objects for the IP sets that you manage.
    
    Specified by:
    
    listIPSets in interface AWSWAFV2
    
    Returns:
    
    Result of the ListIPSets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listLoggingConfigurations
```
public ListLoggingConfigurationsResult listLoggingConfigurations(ListLoggingConfigurationsRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves an array of your LoggingConfiguration objects.
    
    Specified by:
    
    listLoggingConfigurations in interface AWSWAFV2
    
    Returns:
    
    Result of the ListLoggingConfigurations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listManagedRuleSets
```
public ListManagedRuleSetsResult listManagedRuleSets(ListManagedRuleSetsRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves the managed rule sets that you own.
    
    This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
    
    Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
    
    Specified by:
    
    listManagedRuleSets in interface AWSWAFV2
    
    Returns:
    
    Result of the ListManagedRuleSets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listMobileSdkReleases
```
public ListMobileSdkReleasesResult listMobileSdkReleases(ListMobileSdkReleasesRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves a list of the available releases for the mobile SDK and the specified device platform.
    
    The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.
    
    Specified by:
    
    listMobileSdkReleases in interface AWSWAFV2
    
    Returns:
    
    Result of the ListMobileSdkReleases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRegexPatternSets
```
public ListRegexPatternSetsResult listRegexPatternSets(ListRegexPatternSetsRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
    
    Specified by:
    
    listRegexPatternSets in interface AWSWAFV2
    
    Returns:
    
    Result of the ListRegexPatternSets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listResourcesForWebACL
```
public ListResourcesForWebACLResult listResourcesForWebACL(ListResourcesForWebACLRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of Amazon CloudFront resources, use the CloudFront call ListDistributionsByWebACLId.
    
    Specified by:
    
    listResourcesForWebACL in interface AWSWAFV2
    
    Returns:
    
    Result of the ListResourcesForWebACL operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRuleGroups
```
public ListRuleGroupsResult listRuleGroups(ListRuleGroupsRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
    
    Specified by:
    
    listRuleGroups in interface AWSWAFV2
    
    Returns:
    
    Result of the ListRuleGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
    
    You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
    
    Specified by:
    
    listTagsForResource in interface AWSWAFV2
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listWebACLs
```
public ListWebACLsResult listWebACLs(ListWebACLsRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
    
    Specified by:
    
    listWebACLs in interface AWSWAFV2
    
    Returns:
    
    Result of the ListWebACLs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putLoggingConfiguration
```
public PutLoggingConfigurationResult putLoggingConfiguration(PutLoggingConfigurationRequest request)
```
    Description copied from interface: AWSWAFV2
    Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.
    This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.
    
    To modify an existing logging configuration, do the following:
    
    Retrieve it by calling GetLoggingConfiguration
    
    Update its settings as needed
    
    Provide the complete logging configuration specification to this call
    You can define one logging destination per web ACL.
    
    You can access information about the traffic that WAF inspects using the following steps:
    1. Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.
      
      The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.
      
      For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.
    2. Associate your logging destination to your web ACL using a PutLoggingConfiguration request.
    When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
    
    For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.
    Specified by:
    
    putLoggingConfiguration in interface AWSWAFV2
    
    Returns:
    
    Result of the PutLoggingConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putManagedRuleSetVersions
```
public PutManagedRuleSetVersionsResult putManagedRuleSetVersions(PutManagedRuleSetVersionsRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.
    
    This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
    
    Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
    
    Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using.
    
    To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.
    
    Specified by:
    
    putManagedRuleSetVersions in interface AWSWAFV2
    
    Returns:
    
    Result of the PutManagedRuleSetVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putPermissionPolicy
```
public PutPermissionPolicyResult putPermissionPolicy(PutPermissionPolicyRequest request)
```
    Description copied from interface: AWSWAFV2
    Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.
    
    You must be the owner of the rule group to perform this operation.
    
    This action is subject to the following restrictions:
    - You can attach only one policy with each PutPermissionPolicy request.
    - The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same Region.
    - The user making the request must be the owner of the rule group.
    Specified by:
    
    putPermissionPolicy in interface AWSWAFV2
    
    Returns:
    
    Result of the PutPermissionPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
    
    You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
    
    Specified by:
    
    tagResource in interface AWSWAFV2
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.
    
    Specified by:
    
    untagResource in interface AWSWAFV2
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateIPSet
```
public UpdateIPSetResult updateIPSet(UpdateIPSetRequest request)
```
    Description copied from interface: AWSWAFV2
    Updates the specified IPSet.
    This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.
    
    To modify an IP set, do the following:
    
    Retrieve it by calling GetIPSet
    
    Update its settings as needed
    
    Provide the complete IP set specification to this call
    When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
    Specified by:
    
    updateIPSet in interface AWSWAFV2
    
    Returns:
    
    Result of the UpdateIPSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateManagedRuleSetVersionExpiryDate
```
public UpdateManagedRuleSetVersionExpiryDateResult updateManagedRuleSetVersionExpiryDate(UpdateManagedRuleSetVersionExpiryDateRequest request)
```
    Description copied from interface: AWSWAFV2
    
    Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.
    
    This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
    
    Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
    
    Specified by:
    
    updateManagedRuleSetVersionExpiryDate in interface AWSWAFV2
    
    Returns:
    
    Result of the UpdateManagedRuleSetVersionExpiryDate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateRegexPatternSet
```
public UpdateRegexPatternSetResult updateRegexPatternSet(UpdateRegexPatternSetRequest request)
```
    Description copied from interface: AWSWAFV2
    Updates the specified RegexPatternSet.
    This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.
    
    To modify a regex pattern set, do the following:
    
    Retrieve it by calling GetRegexPatternSet
    
    Update its settings as needed
    
    Provide the complete regex pattern set specification to this call
    When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
    Specified by:
    
    updateRegexPatternSet in interface AWSWAFV2
    
    Returns:
    
    Result of the UpdateRegexPatternSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateRuleGroup
```
public UpdateRuleGroupResult updateRuleGroup(UpdateRuleGroupRequest request)
```
    Description copied from interface: AWSWAFV2
    Updates the specified RuleGroup.
    This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.
    
    To modify a rule group, do the following:
    
    Retrieve it by calling GetRuleGroup
    
    Update its settings as needed
    
    Provide the complete rule group specification to this call
    When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
    
    A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
    Specified by:
    
    updateRuleGroup in interface AWSWAFV2
    
    Returns:
    
    Result of the UpdateRuleGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateWebACL
```
public UpdateWebACLResult updateWebACL(UpdateWebACLRequest request)
```
    Description copied from interface: AWSWAFV2
    Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.
    This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.
    
    To modify a web ACL, do the following:
    
    Retrieve it by calling GetWebACL
    
    Update its settings as needed
    
    Provide the complete web ACL specification to this call
    When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
    
    A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, Amazon Cognito user pool, or an App Runner service.
    Specified by:
    
    updateWebACL in interface AWSWAFV2
    
    Returns:
    
    Result of the UpdateWebACL operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSWAFV2
    
    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 AWSWAFV2
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSWAFV2
    
    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 AWSWAFV2
    
    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 AbstractAWSWAFV2

Field Summary

Fields inherited from interface com.amazonaws.services.wafv2.AWSWAFV2

Method Summary

Methods inherited from class java.lang.Object

Method Detail

associateWebACL

checkCapacity

createIPSet

createRegexPatternSet

createRuleGroup

createWebACL

deleteFirewallManagerRuleGroups

deleteIPSet

deleteLoggingConfiguration

deletePermissionPolicy

deleteRegexPatternSet

deleteRuleGroup

deleteWebACL

describeManagedRuleGroup

disassociateWebACL

generateMobileSdkReleaseUrl

getIPSet

getLoggingConfiguration

getManagedRuleSet

getMobileSdkRelease

getPermissionPolicy

getRateBasedStatementManagedKeys

getRegexPatternSet

getRuleGroup

getSampledRequests

getWebACL

getWebACLForResource

listAvailableManagedRuleGroupVersions

listAvailableManagedRuleGroups

listIPSets

listLoggingConfigurations

listManagedRuleSets

listMobileSdkReleases

listRegexPatternSets

listResourcesForWebACL

listRuleGroups

listTagsForResource

listWebACLs

putLoggingConfiguration

putManagedRuleSetVersions

putPermissionPolicy

tagResource

untagResource

updateIPSet

updateManagedRuleSetVersionExpiryDate

updateRegexPatternSet

updateRuleGroup

updateWebACL

shutdown

getCachedResponseMetadata