Stratosphere.ResourceProperties.ApiGatewayUsagePlanQuotaSettings

QuotaSettings is a property of the AWS::ApiGateway::UsagePlan resource that specifies the maximum number of requests users can make to your Amazon API Gateway (API Gateway) APIs.

Documentation

data ApiGatewayUsagePlanQuotaSettings

Full data type definition for ApiGatewayUsagePlanQuotaSettings. See apiGatewayUsagePlanQuotaSettings for a more convenient constructor.

Constructors

ApiGatewayUsagePlanQuotaSettings

Fields

• _apiGatewayUsagePlanQuotaSettingsLimit :: Maybe (Val Integer')
• _apiGatewayUsagePlanQuotaSettingsOffset :: Maybe (Val Integer')
• _apiGatewayUsagePlanQuotaSettingsPeriod :: Maybe Period

Instances

Show ApiGatewayUsagePlanQuotaSettings

Methods

showsPrec :: Int -> ApiGatewayUsagePlanQuotaSettings -> ShowS

show :: ApiGatewayUsagePlanQuotaSettings -> String

showList :: [ApiGatewayUsagePlanQuotaSettings] -> ShowS

Generic ApiGatewayUsagePlanQuotaSettings

Associated Types

type Rep ApiGatewayUsagePlanQuotaSettings :: * -> *

Methods

from :: ApiGatewayUsagePlanQuotaSettings -> Rep ApiGatewayUsagePlanQuotaSettings x

to :: Rep ApiGatewayUsagePlanQuotaSettings x -> ApiGatewayUsagePlanQuotaSettings

ToJSON ApiGatewayUsagePlanQuotaSettings

Methods

toJSON :: ApiGatewayUsagePlanQuotaSettings -> Value

toEncoding :: ApiGatewayUsagePlanQuotaSettings -> Encoding

toJSONList :: [ApiGatewayUsagePlanQuotaSettings] -> Value

toEncodingList :: [ApiGatewayUsagePlanQuotaSettings] -> Encoding

FromJSON ApiGatewayUsagePlanQuotaSettings

Methods

parseJSON :: Value -> Parser ApiGatewayUsagePlanQuotaSettings

parseJSONList :: Value -> Parser [ApiGatewayUsagePlanQuotaSettings]

type Rep ApiGatewayUsagePlanQuotaSettings

type Rep ApiGatewayUsagePlanQuotaSettings = D1 (MetaData "ApiGatewayUsagePlanQuotaSettings" "Stratosphere.ResourceProperties.ApiGatewayUsagePlanQuotaSettings" "stratosphere-0.2.2-Fnop5S0NvsvBmp7LUeJWuv" False) (C1 (MetaCons "ApiGatewayUsagePlanQuotaSettings" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayUsagePlanQuotaSettingsLimit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Integer')))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayUsagePlanQuotaSettingsOffset") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Integer')))) (S1 (MetaSel (Just Symbol "_apiGatewayUsagePlanQuotaSettingsPeriod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Period))))))

apiGatewayUsagePlanQuotaSettings :: ApiGatewayUsagePlanQuotaSettings

Constructor for ApiGatewayUsagePlanQuotaSettings containing required fields as arguments.

agupqsLimit :: Lens' ApiGatewayUsagePlanQuotaSettings (Maybe (Val Integer'))

The maximum number of requests that users can make within the specified time period.

agupqsOffset :: Lens' ApiGatewayUsagePlanQuotaSettings (Maybe (Val Integer'))

For the initial time period, the number of requests to subtract from the specified limit. When you first implement a usage plan, the plan might start in the middle of the week or month. With this property, you can decrease the limit for this initial time period.

agupqsPeriod :: Lens' ApiGatewayUsagePlanQuotaSettings (Maybe Period)

The time period for which the maximum limit of requests applies, such as DAY or WEEK. For valid values, see the period property for the UsagePlan resource in the Amazon API Gateway REST API Reference.