amazonka-wafv2-2.0: Amazon WAFV2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WAFV2.CheckCapacity

Description

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

Creating a Request

data CheckCapacity Source #

See: newCheckCapacity smart constructor.

Constructors

CheckCapacity' 

Fields

  • scope :: 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.
  • rules :: [Rule]

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

Instances

Instances details
ToJSON CheckCapacity Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Methods

toJSON :: CheckCapacity -> Value #

toEncoding :: CheckCapacity -> Encoding #

toJSONList :: [CheckCapacity] -> Value #

toEncodingList :: [CheckCapacity] -> Encoding #

ToHeaders CheckCapacity Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Methods

toHeaders :: CheckCapacity -> [Header] #

ToPath CheckCapacity Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Methods

toPath :: CheckCapacity -> ByteString #

ToQuery CheckCapacity Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Methods

toQuery :: CheckCapacity -> QueryString #

AWSRequest CheckCapacity Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Associated Types

type AWSResponse CheckCapacity #

Methods

request :: (Service -> Service) -> CheckCapacity -> Request CheckCapacity #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CheckCapacity -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CheckCapacity))) #

Generic CheckCapacity Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Associated Types

type Rep CheckCapacity :: Type -> Type #

Methods

from :: CheckCapacity -> Rep CheckCapacity x #

to :: Rep CheckCapacity x -> CheckCapacity #

Read CheckCapacity Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Methods

readsPrec :: Int -> ReadS CheckCapacity #

readList :: ReadS [CheckCapacity] #

readPrec :: ReadPrec CheckCapacity #

readListPrec :: ReadPrec [CheckCapacity] #

Show CheckCapacity Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Methods

showsPrec :: Int -> CheckCapacity -> ShowS #

show :: CheckCapacity -> String #

showList :: [CheckCapacity] -> ShowS #

NFData CheckCapacity Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Methods

rnf :: CheckCapacity -> () #

Eq CheckCapacity Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Methods

(==) :: CheckCapacity -> CheckCapacity -> Bool #

(/=) :: CheckCapacity -> CheckCapacity -> Bool #

Hashable CheckCapacity Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Methods

hashWithSalt :: Int -> CheckCapacity -> Int #

hash :: CheckCapacity -> Int #

type AWSResponse CheckCapacity Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

type AWSResponse CheckCapacity = CheckCapacityResponse
type Rep CheckCapacity Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

type Rep CheckCapacity = D1 ('MetaData "CheckCapacity" "Amazonka.WAFV2.CheckCapacity" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "CheckCapacity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scope) :*: S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Rule])))

newCheckCapacity Source #

Arguments

:: Scope

CheckCapacity

-> CheckCapacity 

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.

Constructors

CheckCapacityResponse' 

Fields

Instances

Instances details
Generic CheckCapacityResponse Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Associated Types

type Rep CheckCapacityResponse :: Type -> Type #

Methods

from :: CheckCapacityResponse -> Rep CheckCapacityResponse x #

to :: Rep CheckCapacityResponse x -> CheckCapacityResponse #

Read CheckCapacityResponse Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Methods

readsPrec :: Int -> ReadS CheckCapacityResponse #

readList :: ReadS [CheckCapacityResponse] #

readPrec :: ReadPrec CheckCapacityResponse #

readListPrec :: ReadPrec [CheckCapacityResponse] #

Show CheckCapacityResponse Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Methods

showsPrec :: Int -> CheckCapacityResponse -> ShowS #

show :: CheckCapacityResponse -> String #

showList :: [CheckCapacityResponse] -> ShowS #

NFData CheckCapacityResponse Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Methods

rnf :: CheckCapacityResponse -> () #

Eq CheckCapacityResponse Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

Methods

(==) :: CheckCapacityResponse -> CheckCapacityResponse -> Bool #

(/=) :: CheckCapacityResponse -> CheckCapacityResponse -> Bool #

type Rep CheckCapacityResponse Source # 
Instance details

Defined in Amazonka.WAFV2.CheckCapacity

type Rep CheckCapacityResponse = D1 ('MetaData "CheckCapacityResponse" "Amazonka.WAFV2.CheckCapacity" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "CheckCapacityResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "capacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCheckCapacityResponse Source #

Arguments

:: Int

$sel:httpStatus:CheckCapacityResponse'

-> CheckCapacityResponse 

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.