You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
CSOAR-3203 : Revise the AWS WAF integration documentation in accordance with the latest documentation updates. (#5278)
* CSOAR-3203 : modified the existing doc as per new documentation content
* CSOAR-3203 : fixed minor issue
* CSOAR-3203 fixed minor issues
* CSOAR-3203 : implemented review comments
* CSOAR-3203 : removed unwanted parameters
* Updates from review
* More updates from review
---------
Co-authored-by: John Pipkin <[email protected]>
Copy file name to clipboardExpand all lines: docs/platform-services/automation-service/app-central/integrations/aws-waf.md
+220-6Lines changed: 220 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,72 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
9
9
***Version: 1.1
10
10
Updated: March 26, 2025***
11
11
12
+
## Overview
13
+
14
+
### Purpose
15
+
12
16
AWS WAF is a web application firewall that helps protect web applications from attacks by allowing you to configure rules that allow, block, or monitor (count) web requests based on conditions that you define.
17
+
This integration is designed to manage and retrieve WAF security configurations, including IP sets, regex pattern sets, rule groups, and web access control lists (web ACLs). It enables you to define, update, delete, and retrieve security rule assets that inspect and control web request traffic.
18
+
19
+
### Use cases
20
+
21
+
* Creating and managing IP allowlists/denylists
22
+
* Defining regex-based pattern rules for request inspection
23
+
* Grouping multiple rules in custom rule groups
24
+
* Fetching details and summaries of rule components
25
+
* Updating existing rules in response to new threats
26
+
27
+
### Supported versions
28
+
29
+
This integration supports WAFv2 API actions and works with resources.
30
+
It is compatible with all standard environments where WAFv2 actions are supported.
* Proper region selection for WAFv2 API calls (`regional` or `global` scope)
41
+
* API credentials with sufficient access
42
+
43
+
### Limitations
44
+
45
+
* Regex complexity may be limited by the WAF regex engine's constraints.
46
+
* All changes require propagation time before taking effect (~1-2 minutes).
47
+
48
+
## Configure AWS WAF in Automation Service and Cloud SOAR
49
+
50
+
import IntegrationsAuth from '../../../../reuse/integrations-authentication.md';
51
+
52
+
<IntegrationsAuth/>
53
+
54
+
### Installation
55
+
56
+
[Install](/docs/platform-services/automation-service/automation-service-app-central/#install-an-integration-from-app-central) the AWS WAF application from App Central.
57
+
58
+
### Configuration
59
+
60
+
After installing the AWS WAF application, create an AWS WAF resource to begin executing actions.
61
+
62
+
Refer to the image below for guidance on creating an AWS WAF resource.
#### Delete IP Set / Regex Pattern Set / Rule Group
176
+
* Method: POST
177
+
* Action: Delete (Type)
178
+
* Required Parameters:
179
+
* Name, ID, Scope, Region
180
+
181
+
### Enrichment APIs
182
+
183
+
#### Get IP Set / Rule Group / Web ACL / Managed Rule Set
184
+
* Method: GET
185
+
* Action: Get (Type) ex: Get IP Set/Get Rule Group
186
+
* Required Parameters:
187
+
* Id, Name, Scope
188
+
189
+
#### List IP Sets / Regex Pattern Sets / Rule Groups / Web ACLs / Managed Rule Sets
190
+
* Method: GET
191
+
* Action: List (Type)s
192
+
* Optional Parameters: Limit, NextMarker
193
+
194
+
#### List Resources for Web ACLs
195
+
* Method: GET
196
+
* Action: ListResourcesForWebACL
197
+
* Required Parameters:
198
+
* WebACLArn
199
+
200
+
### Rate limits and quotas
201
+
202
+
| API type | Quota/rate limit |
203
+
| :-- | :-- |
204
+
| IP sets per region | 100 |
205
+
| Regex sets per region | 100 |
206
+
| Rule groups per region | 100 |
207
+
| API transactions (TPS) |~5-10 TPS per account per API |
208
+
209
+
Limits may vary by region and can be increased via AWS Support.
210
+
211
+
## Troubleshooting
212
+
213
+
### Common issues
214
+
215
+
| Issue | Description | Solution |
216
+
| :-- | :-- | :-- |
217
+
| WAFNonexistentItemException | Occurs when trying to access or delete a non-existent resource. | Double-check the ID, Name, and Scope. Use List APIs to confirm existence. |
218
+
| WAFOptimisticLockException | Indicates a stale or missing LockToken when updating or deleting resources. | Always fetch the latest LockToken using Get API before performing updates/deletes. |
219
+
| WAFInvalidParameterException | One or more parameters are invalid or missing. | Verify that all required parameters are included and correctly formatted (for example, CIDR for IP sets). |
220
+
| AccessDeniedException | Occurs when permissions are insufficient. | Check IAM roles and policies assigned to the user or service making the request. Ensure `wafv2:*` permissions are included. |
221
+
| Resource still appears after deletion. | A deleted IPSet, RuleGroup, etc. still seems accessible in the UI or APIs. | Allow a few seconds for propagation. Use Get `<action-type>` or List `<action-type>` to confirm removal. |
222
+
| IP addresses not being blocked. | Traffic from listed IPs still reaches the application. | Ensure the IPSet is attached to a WebACL and the WebACL is associated with the resource (for example, CloudFront or ALB). |
223
+
224
+
225
+
### FAQs
226
+
227
+
#### Can I reuse an IPSet in different rule groups?
228
+
229
+
Yes, an IPSet can be used in several rule groups or WebACLs. You don’t need to create a new one for each use.
230
+
231
+
#### What’s the difference between REGIONAL and CLOUDFRONT scopes?
232
+
233
+
REGIONAL is used for AWS services like Application Load Balancers, API Gateway, and App Runner.
234
+
235
+
CLOUDFRONT is specifically for CloudFront distributions and must be managed in the US East (N. Virginia) region.
236
+
237
+
#### Why aren’t my changes showing up right away?
238
+
239
+
Updates can take a few moments to fully apply within AWS. Try retrieving the latest configuration using the appropriate Get API call to confirm.
240
+
241
+
#### What if the IP address I provide isn’t in CIDR format?
242
+
243
+
If the IP isn’t formatted correctly (for example, missing the CIDR suffix), AWS WAF will return a WAFInvalidParameterException. Make sure IPs follow the CIDR notation like 192.0.2.0/24.
0 commit comments