Safe Haskell	None
Language	Haskell2010

Stratosphere.ResourceProperties.ApiGatewayUsagePlanThrottleSettings

Description

ThrottleSettings is a property of the AWS::ApiGateway::UsagePlan resource that specifies the overall request rate (average requests per second) and burst capacity when users call your Amazon API Gateway (API Gateway) APIs.

Documentation

data ApiGatewayUsagePlanThrottleSettings Source #

Full data type definition for ApiGatewayUsagePlanThrottleSettings. See apiGatewayUsagePlanThrottleSettings for a more convenient constructor.

Constructors

ApiGatewayUsagePlanThrottleSettings
Fields _apiGatewayUsagePlanThrottleSettingsBurstLimit :: Maybe (Val Integer') _apiGatewayUsagePlanThrottleSettingsRateLimit :: Maybe Double'

Instances

Show ApiGatewayUsagePlanThrottleSettings Source #
Methods showsPrec :: Int -> ApiGatewayUsagePlanThrottleSettings -> ShowS # show :: ApiGatewayUsagePlanThrottleSettings -> String # showList :: [ApiGatewayUsagePlanThrottleSettings] -> ShowS #
Generic ApiGatewayUsagePlanThrottleSettings Source #
Associated Types type Rep ApiGatewayUsagePlanThrottleSettings :: * -> * # Methods from :: ApiGatewayUsagePlanThrottleSettings -> Rep ApiGatewayUsagePlanThrottleSettings x # to :: Rep ApiGatewayUsagePlanThrottleSettings x -> ApiGatewayUsagePlanThrottleSettings #
ToJSON ApiGatewayUsagePlanThrottleSettings Source #
Methods toJSON :: ApiGatewayUsagePlanThrottleSettings -> Value # toEncoding :: ApiGatewayUsagePlanThrottleSettings -> Encoding # toJSONList :: [ApiGatewayUsagePlanThrottleSettings] -> Value # toEncodingList :: [ApiGatewayUsagePlanThrottleSettings] -> Encoding #
FromJSON ApiGatewayUsagePlanThrottleSettings Source #
Methods parseJSON :: Value -> Parser ApiGatewayUsagePlanThrottleSettings # parseJSONList :: Value -> Parser [ApiGatewayUsagePlanThrottleSettings] #
type Rep ApiGatewayUsagePlanThrottleSettings Source #
type Rep ApiGatewayUsagePlanThrottleSettings = D1 (MetaData "ApiGatewayUsagePlanThrottleSettings" "Stratosphere.ResourceProperties.ApiGatewayUsagePlanThrottleSettings" "stratosphere-0.2.0-B1WeL9cnxuQ3qer3csMa6f" False) (C1 (MetaCons "ApiGatewayUsagePlanThrottleSettings" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayUsagePlanThrottleSettingsBurstLimit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Integer')))) (S1 (MetaSel (Just Symbol "_apiGatewayUsagePlanThrottleSettingsRateLimit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Double')))))

apiGatewayUsagePlanThrottleSettings :: ApiGatewayUsagePlanThrottleSettings Source #

Constructor for ApiGatewayUsagePlanThrottleSettings containing required fields as arguments.

aguptsBurstLimit :: Lens' ApiGatewayUsagePlanThrottleSettings (Maybe (Val Integer')) Source #

The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity. For more information about request throttling, see Manage API Request Throttling in the API Gateway Developer Guide.

aguptsRateLimit :: Lens' ApiGatewayUsagePlanThrottleSettings (Maybe Double') Source #

The API request steady-state rate limit (average requests per second over an extended period of time). For more information about request throttling, see Manage API Request Throttling in the API Gateway Developer Guide.