amazonka-apigateway-2.0: Amazon API Gateway 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.APIGateway.Types.ThrottleSettings

Description

 
Synopsis

Documentation

data ThrottleSettings Source #

The API request rate limits.

See: newThrottleSettings smart constructor.

Constructors

ThrottleSettings' 

Fields

  • burstLimit :: Maybe Int

    The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.

  • rateLimit :: Maybe Double

    The API target request rate limit.

Instances

Instances details
FromJSON ThrottleSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.ThrottleSettings

ToJSON ThrottleSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.ThrottleSettings

Generic ThrottleSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.ThrottleSettings

Associated Types

type Rep ThrottleSettings :: Type -> Type #

Read ThrottleSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.ThrottleSettings

Show ThrottleSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.ThrottleSettings

NFData ThrottleSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.ThrottleSettings

Methods

rnf :: ThrottleSettings -> () #

Eq ThrottleSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.ThrottleSettings

Hashable ThrottleSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.ThrottleSettings

type Rep ThrottleSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.ThrottleSettings

type Rep ThrottleSettings = D1 ('MetaData "ThrottleSettings" "Amazonka.APIGateway.Types.ThrottleSettings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ThrottleSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "burstLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "rateLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newThrottleSettings :: ThrottleSettings Source #

Create a value of ThrottleSettings 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:

$sel:burstLimit:ThrottleSettings', throttleSettings_burstLimit - The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.

$sel:rateLimit:ThrottleSettings', throttleSettings_rateLimit - The API target request rate limit.

throttleSettings_burstLimit :: Lens' ThrottleSettings (Maybe Int) Source #

The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.

throttleSettings_rateLimit :: Lens' ThrottleSettings (Maybe Double) Source #

The API target request rate limit.