@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSWAFV2 extends Object implements AWSWAFV2
AWSWAFV2. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| 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.
|
CreateAPIKeyResult |
createAPIKey(CreateAPIKeyRequest request)
Creates an API key that contains a set of token domains.
|
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.
|
DeleteAPIKeyResult |
deleteAPIKey(DeleteAPIKeyRequest request)
Deletes the specified API key.
|
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.
|
DescribeAllManagedProductsResult |
describeAllManagedProducts(DescribeAllManagedProductsRequest request)
Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services
Marketplace managed rule groups.
|
DescribeManagedProductsByVendorResult |
describeManagedProductsByVendor(DescribeManagedProductsByVendorRequest request)
Provides high-level information for the managed rule groups owned by a specific vendor.
|
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.
|
GetDecryptedAPIKeyResult |
getDecryptedAPIKey(GetDecryptedAPIKeyRequest request)
Returns your API key in decrypted form.
|
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 IP addresses 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.
|
ListAPIKeysResult |
listAPIKeys(ListAPIKeysRequest request)
Retrieves a list of the API keys that you've defined for the specified scope.
|
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.
|
public AssociateWebACLResult associateWebACL(AssociateWebACLRequest request)
AWSWAFV2Associates 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, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
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 in the Amazon CloudFront Developer Guide.
Required permissions for customer-managed IAM policies
This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the WAF Developer Guide.
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
After you change a rule action setting, you might see the old action in some places and the new action in others.
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
associateWebACL in interface AWSWAFV2public CheckCapacityResult checkCapacity(CheckCapacityRequest request)
AWSWAFV2Returns 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. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
checkCapacity in interface AWSWAFV2public CreateAPIKeyResult createAPIKey(CreateAPIKeyRequest request)
AWSWAFV2Creates an API key that contains a set of token domains.
API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.
You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.
createAPIKey in interface AWSWAFV2public CreateIPSetResult createIPSet(CreateIPSetRequest request)
AWSWAFV2Creates 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.
createIPSet in interface AWSWAFV2public CreateRegexPatternSetResult createRegexPatternSet(CreateRegexPatternSetRequest request)
AWSWAFV2Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.
createRegexPatternSet in interface AWSWAFV2public CreateRuleGroupResult createRuleGroup(CreateRuleGroupRequest request)
AWSWAFV2Creates 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.
createRuleGroup in interface AWSWAFV2public CreateWebACLResult createWebACL(CreateWebACLRequest request)
AWSWAFV2Creates 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 a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. 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, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
createWebACL in interface AWSWAFV2public DeleteAPIKeyResult deleteAPIKey(DeleteAPIKeyRequest request)
AWSWAFV2Deletes the specified API key.
After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.
deleteAPIKey in interface AWSWAFV2public DeleteFirewallManagerRuleGroupsResult deleteFirewallManagerRuleGroups(DeleteFirewallManagerRuleGroupsRequest request)
AWSWAFV2Deletes 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.
deleteFirewallManagerRuleGroups in interface AWSWAFV2public DeleteIPSetResult deleteIPSet(DeleteIPSetRequest request)
AWSWAFV2Deletes the specified IPSet.
deleteIPSet in interface AWSWAFV2public DeleteLoggingConfigurationResult deleteLoggingConfiguration(DeleteLoggingConfigurationRequest request)
AWSWAFV2Deletes the LoggingConfiguration from the specified web ACL.
deleteLoggingConfiguration in interface AWSWAFV2public DeletePermissionPolicyResult deletePermissionPolicy(DeletePermissionPolicyRequest request)
AWSWAFV2Permanently deletes an IAM policy from the specified rule group.
You must be the owner of the rule group to perform this operation.
deletePermissionPolicy in interface AWSWAFV2public DeleteRegexPatternSetResult deleteRegexPatternSet(DeleteRegexPatternSetRequest request)
AWSWAFV2Deletes the specified RegexPatternSet.
deleteRegexPatternSet in interface AWSWAFV2public DeleteRuleGroupResult deleteRuleGroup(DeleteRuleGroupRequest request)
AWSWAFV2Deletes the specified RuleGroup.
deleteRuleGroup in interface AWSWAFV2public DeleteWebACLResult deleteWebACL(DeleteWebACLRequest request)
AWSWAFV2Deletes 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 in the Amazon CloudFront API Reference.
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 in the Amazon CloudFront API Reference.
deleteWebACL in interface AWSWAFV2public DescribeAllManagedProductsResult describeAllManagedProducts(DescribeAllManagedProductsRequest request)
AWSWAFV2Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.
describeAllManagedProducts in interface AWSWAFV2public DescribeManagedProductsByVendorResult describeManagedProductsByVendor(DescribeManagedProductsByVendorRequest request)
AWSWAFV2Provides high-level information for the managed rule groups owned by a specific vendor.
describeManagedProductsByVendor in interface AWSWAFV2public DescribeManagedRuleGroupResult describeManagedRuleGroup(DescribeManagedRuleGroupRequest request)
AWSWAFV2Provides high-level information for a managed rule group, including descriptions of the rules.
describeManagedRuleGroup in interface AWSWAFV2public DisassociateWebACLResult disassociateWebACL(DisassociateWebACLRequest request)
AWSWAFV2Disassociates 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, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
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 in the Amazon CloudFront API Reference.
Required permissions for customer-managed IAM policies
This call requires permissions that are specific to the protected resource type. For details, see Permissions for DisassociateWebACL in the WAF Developer Guide.
disassociateWebACL in interface AWSWAFV2public GenerateMobileSdkReleaseUrlResult generateMobileSdkReleaseUrl(GenerateMobileSdkReleaseUrlRequest request)
AWSWAFV2Generates 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.
generateMobileSdkReleaseUrl in interface AWSWAFV2public GetDecryptedAPIKeyResult getDecryptedAPIKey(GetDecryptedAPIKeyRequest request)
AWSWAFV2Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.
API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.
getDecryptedAPIKey in interface AWSWAFV2public GetIPSetResult getIPSet(GetIPSetRequest request)
AWSWAFV2Retrieves the specified IPSet.
getIPSet in interface AWSWAFV2public GetLoggingConfigurationResult getLoggingConfiguration(GetLoggingConfigurationRequest request)
AWSWAFV2Returns the LoggingConfiguration for the specified web ACL.
getLoggingConfiguration in interface AWSWAFV2public GetManagedRuleSetResult getManagedRuleSet(GetManagedRuleSetRequest request)
AWSWAFV2Retrieves 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.
getManagedRuleSet in interface AWSWAFV2public GetMobileSdkReleaseResult getMobileSdkRelease(GetMobileSdkReleaseRequest request)
AWSWAFV2Retrieves 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.
getMobileSdkRelease in interface AWSWAFV2public GetPermissionPolicyResult getPermissionPolicy(GetPermissionPolicyRequest request)
AWSWAFV2Returns the IAM policy that is attached to the specified rule group.
You must be the owner of the rule group to perform this operation.
getPermissionPolicy in interface AWSWAFV2public GetRateBasedStatementManagedKeysResult getRateBasedStatementManagedKeys(GetRateBasedStatementManagedKeysRequest request)
AWSWAFV2Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address.
The maximum number of addresses 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.
getRateBasedStatementManagedKeys in interface AWSWAFV2public GetRegexPatternSetResult getRegexPatternSet(GetRegexPatternSetRequest request)
AWSWAFV2Retrieves the specified RegexPatternSet.
getRegexPatternSet in interface AWSWAFV2public GetRuleGroupResult getRuleGroup(GetRuleGroupRequest request)
AWSWAFV2Retrieves the specified RuleGroup.
getRuleGroup in interface AWSWAFV2public GetSampledRequestsResult getSampledRequests(GetSampledRequestsRequest request)
AWSWAFV2Gets 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.
getSampledRequests in interface AWSWAFV2public GetWebACLResult getWebACL(GetWebACLRequest request)
AWSWAFV2Retrieves the specified WebACL.
getWebACL in interface AWSWAFV2public GetWebACLForResourceResult getWebACLForResource(GetWebACLForResourceRequest request)
AWSWAFV2Retrieves the WebACL for the specified resource.
This call uses GetWebACL, to verify that your account has permission to access the retrieved web
ACL. If you get an error that indicates that your account isn't authorized to perform
wafv2:GetWebACL on the resource, that error won't be included in your CloudTrail event history.
For Amazon CloudFront, don't use this call. Instead, call the CloudFront action
GetDistributionConfig. For information, see GetDistributionConfig in the Amazon CloudFront API Reference.
Required permissions for customer-managed IAM policies
This call requires permissions that are specific to the protected resource type. For details, see Permissions for GetWebACLForResource in the WAF Developer Guide.
getWebACLForResource in interface AWSWAFV2public ListAPIKeysResult listAPIKeys(ListAPIKeysRequest request)
AWSWAFV2Retrieves a list of the API keys that you've defined for the specified scope.
API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.
listAPIKeys in interface AWSWAFV2public ListAvailableManagedRuleGroupVersionsResult listAvailableManagedRuleGroupVersions(ListAvailableManagedRuleGroupVersionsRequest request)
AWSWAFV2Returns a list of the available versions for the specified managed rule group.
listAvailableManagedRuleGroupVersions in interface AWSWAFV2public ListAvailableManagedRuleGroupsResult listAvailableManagedRuleGroups(ListAvailableManagedRuleGroupsRequest request)
AWSWAFV2Retrieves 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.
listAvailableManagedRuleGroups in interface AWSWAFV2public ListIPSetsResult listIPSets(ListIPSetsRequest request)
AWSWAFV2Retrieves an array of IPSetSummary objects for the IP sets that you manage.
listIPSets in interface AWSWAFV2public ListLoggingConfigurationsResult listLoggingConfigurations(ListLoggingConfigurationsRequest request)
AWSWAFV2Retrieves an array of your LoggingConfiguration objects.
listLoggingConfigurations in interface AWSWAFV2public ListManagedRuleSetsResult listManagedRuleSets(ListManagedRuleSetsRequest request)
AWSWAFV2Retrieves 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.
listManagedRuleSets in interface AWSWAFV2public ListMobileSdkReleasesResult listMobileSdkReleases(ListMobileSdkReleasesRequest request)
AWSWAFV2Retrieves 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.
listMobileSdkReleases in interface AWSWAFV2public ListRegexPatternSetsResult listRegexPatternSets(ListRegexPatternSetsRequest request)
AWSWAFV2Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
listRegexPatternSets in interface AWSWAFV2public ListResourcesForWebACLResult listResourcesForWebACL(ListResourcesForWebACLRequest request)
AWSWAFV2Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL.
For Amazon CloudFront, don't use this call. Instead, use the CloudFront call
ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.
Required permissions for customer-managed IAM policies
This call requires permissions that are specific to the protected resource type. For details, see Permissions for ListResourcesForWebACL in the WAF Developer Guide.
listResourcesForWebACL in interface AWSWAFV2public ListRuleGroupsResult listRuleGroups(ListRuleGroupsRequest request)
AWSWAFV2Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
listRuleGroups in interface AWSWAFV2public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSWAFV2Retrieves 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.
listTagsForResource in interface AWSWAFV2public ListWebACLsResult listWebACLs(ListWebACLsRequest request)
AWSWAFV2Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
listWebACLs in interface AWSWAFV2public PutLoggingConfigurationResult putLoggingConfiguration(PutLoggingConfigurationRequest request)
AWSWAFV2Enables 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:
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.
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.
putLoggingConfiguration in interface AWSWAFV2public PutManagedRuleSetVersionsResult putManagedRuleSetVersions(PutManagedRuleSetVersionsRequest request)
AWSWAFV2Defines 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.
putManagedRuleSetVersions in interface AWSWAFV2public PutPermissionPolicyResult putPermissionPolicy(PutPermissionPolicyRequest request)
AWSWAFV2Attaches 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.
putPermissionPolicy in interface AWSWAFV2public TagResourceResult tagResource(TagResourceRequest request)
AWSWAFV2Associates 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.
tagResource in interface AWSWAFV2public UntagResourceResult untagResource(UntagResourceRequest request)
AWSWAFV2Disassociates 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.
untagResource in interface AWSWAFV2public UpdateIPSetResult updateIPSet(UpdateIPSetRequest request)
AWSWAFV2Updates 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
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
After you change a rule action setting, you might see the old action in some places and the new action in others.
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
updateIPSet in interface AWSWAFV2public UpdateManagedRuleSetVersionExpiryDateResult updateManagedRuleSetVersionExpiryDate(UpdateManagedRuleSetVersionExpiryDateRequest request)
AWSWAFV2Updates 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.
updateManagedRuleSetVersionExpiryDate in interface AWSWAFV2public UpdateRegexPatternSetResult updateRegexPatternSet(UpdateRegexPatternSetRequest request)
AWSWAFV2Updates 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
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
After you change a rule action setting, you might see the old action in some places and the new action in others.
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
updateRegexPatternSet in interface AWSWAFV2public UpdateRuleGroupResult updateRuleGroup(UpdateRuleGroupRequest request)
AWSWAFV2Updates 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
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.
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
After you change a rule action setting, you might see the old action in some places and the new action in others.
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
updateRuleGroup in interface AWSWAFV2public UpdateWebACLResult updateWebACL(UpdateWebACLRequest request)
AWSWAFV2Updates 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
A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. 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, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
After you change a rule action setting, you might see the old action in some places and the new action in others.
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
updateWebACL in interface AWSWAFV2public void shutdown()
AWSWAFV2public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSWAFV2Response 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.
getCachedResponseMetadata in interface AWSWAFV2request - The originally executed request.