Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data CheckCapacity = CheckCapacity' {}
- newCheckCapacity :: Scope -> CheckCapacity
- checkCapacity_scope :: Lens' CheckCapacity Scope
- checkCapacity_rules :: Lens' CheckCapacity [Rule]
- data CheckCapacityResponse = CheckCapacityResponse' {
- capacity :: Maybe Natural
- httpStatus :: Int
- newCheckCapacityResponse :: Int -> CheckCapacityResponse
- checkCapacityResponse_capacity :: Lens' CheckCapacityResponse (Maybe Natural)
- checkCapacityResponse_httpStatus :: Lens' CheckCapacityResponse Int
Creating a Request
data CheckCapacity Source #
See: newCheckCapacity
smart constructor.
CheckCapacity' | |
|
Instances
Create a value of CheckCapacity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CheckCapacity
, checkCapacity_scope
- 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,
or an Amazon Cognito user pool.
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.
CheckCapacity
, checkCapacity_rules
- An array of Rule that you're configuring to use in a rule group or web
ACL.
Request Lenses
checkCapacity_scope :: Lens' CheckCapacity Scope Source #
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, or an Amazon Cognito user pool.
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.
checkCapacity_rules :: Lens' CheckCapacity [Rule] Source #
An array of Rule that you're configuring to use in a rule group or web ACL.
Destructuring the Response
data CheckCapacityResponse Source #
See: newCheckCapacityResponse
smart constructor.
CheckCapacityResponse' | |
|
Instances
newCheckCapacityResponse Source #
Create a value of CheckCapacityResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CheckCapacityResponse
, checkCapacityResponse_capacity
- The capacity required by the rules and scope.
$sel:httpStatus:CheckCapacityResponse'
, checkCapacityResponse_httpStatus
- The response's http status code.
Response Lenses
checkCapacityResponse_capacity :: Lens' CheckCapacityResponse (Maybe Natural) Source #
The capacity required by the rules and scope.
checkCapacityResponse_httpStatus :: Lens' CheckCapacityResponse Int Source #
The response's http status code.