Stratosphere.Resources.ApiGatewayUsagePlan

The AWS::ApiGateway::UsagePlan resource specifies a usage plan for deployed Amazon API Gateway (API Gateway) APIs. A usage plan enforces throttling and quota limits on individual client API keys. For more information, see Creating and Using API Usage Plans in Amazon API Gateway in the API Gateway Developer Guide.

Documentation

data ApiGatewayUsagePlan

Full data type definition for ApiGatewayUsagePlan. See apiGatewayUsagePlan for a more convenient constructor.

Constructors

ApiGatewayUsagePlan

Fields

• _apiGatewayUsagePlanApiStages :: Maybe [ApiGatewayUsagePlanApiStage]
• _apiGatewayUsagePlanDescription :: Maybe (Val Text)
• _apiGatewayUsagePlanQuota :: Maybe ApiGatewayUsagePlanQuotaSettings
• _apiGatewayUsagePlanThrottle :: Maybe ApiGatewayUsagePlanThrottleSettings
• _apiGatewayUsagePlanUsagePlanName :: Maybe (Val Text)

Instances

Show ApiGatewayUsagePlan

Methods

showsPrec :: Int -> ApiGatewayUsagePlan -> ShowS

show :: ApiGatewayUsagePlan -> String

showList :: [ApiGatewayUsagePlan] -> ShowS

Generic ApiGatewayUsagePlan

Associated Types

type Rep ApiGatewayUsagePlan :: * -> *

Methods

from :: ApiGatewayUsagePlan -> Rep ApiGatewayUsagePlan x

to :: Rep ApiGatewayUsagePlan x -> ApiGatewayUsagePlan

ToJSON ApiGatewayUsagePlan

Methods

toJSON :: ApiGatewayUsagePlan -> Value

toEncoding :: ApiGatewayUsagePlan -> Encoding

toJSONList :: [ApiGatewayUsagePlan] -> Value

toEncodingList :: [ApiGatewayUsagePlan] -> Encoding

FromJSON ApiGatewayUsagePlan

Methods

parseJSON :: Value -> Parser ApiGatewayUsagePlan

parseJSONList :: Value -> Parser [ApiGatewayUsagePlan]

type Rep ApiGatewayUsagePlan

type Rep ApiGatewayUsagePlan = D1 (MetaData "ApiGatewayUsagePlan" "Stratosphere.Resources.ApiGatewayUsagePlan" "stratosphere-0.2.2-Fnop5S0NvsvBmp7LUeJWuv" False) (C1 (MetaCons "ApiGatewayUsagePlan" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayUsagePlanApiStages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [ApiGatewayUsagePlanApiStage]))) (S1 (MetaSel (Just Symbol "_apiGatewayUsagePlanDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayUsagePlanQuota") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ApiGatewayUsagePlanQuotaSettings))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayUsagePlanThrottle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ApiGatewayUsagePlanThrottleSettings))) (S1 (MetaSel (Just Symbol "_apiGatewayUsagePlanUsagePlanName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text))))))))

apiGatewayUsagePlan :: ApiGatewayUsagePlan

Constructor for ApiGatewayUsagePlan containing required fields as arguments.

agupApiStages :: Lens' ApiGatewayUsagePlan (Maybe [ApiGatewayUsagePlanApiStage])

The APIs and API stages to associate with this usage plan.

agupDescription :: Lens' ApiGatewayUsagePlan (Maybe (Val Text))

The purpose of this usage plan.

agupQuota :: Lens' ApiGatewayUsagePlan (Maybe ApiGatewayUsagePlanQuotaSettings)

Configures the number of requests that users can make within a given interval.

agupThrottle :: Lens' ApiGatewayUsagePlan (Maybe ApiGatewayUsagePlanThrottleSettings)

Configures the overall request rate (average requests per second) and burst capacity.

agupUsagePlanName :: Lens' ApiGatewayUsagePlan (Maybe (Val Text))

A name for this usage plan.