Skip to content

/AWS1/CL_WA2=>CHECKCAPACITY()

About CheckCapacity

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. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

Method Signature

IMPORTING

Required arguments:

IV_SCOPE TYPE /AWS1/WA2SCOPE /AWS1/WA2SCOPE

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. 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.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

IT_RULES TYPE /AWS1/CL_WA2RULE=>TT_RULES TT_RULES

An array of Rule that you're configuring to use in a rule group or web ACL.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_WA2CHECKCAPRESPONSE /AWS1/CL_WA2CHECKCAPRESPONSE