Safe Haskell | None |
---|---|
Language | Haskell2010 |
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.
- data ApiGatewayUsagePlanQuotaSettings = ApiGatewayUsagePlanQuotaSettings {}
- apiGatewayUsagePlanQuotaSettings :: ApiGatewayUsagePlanQuotaSettings
- agupqsLimit :: Lens' ApiGatewayUsagePlanQuotaSettings (Maybe (Val Integer'))
- agupqsOffset :: Lens' ApiGatewayUsagePlanQuotaSettings (Maybe (Val Integer'))
- agupqsPeriod :: Lens' ApiGatewayUsagePlanQuotaSettings (Maybe Period)
Documentation
data ApiGatewayUsagePlanQuotaSettings Source #
Full data type definition for ApiGatewayUsagePlanQuotaSettings. See
apiGatewayUsagePlanQuotaSettings
for a more convenient constructor.
apiGatewayUsagePlanQuotaSettings :: ApiGatewayUsagePlanQuotaSettings Source #
Constructor for ApiGatewayUsagePlanQuotaSettings
containing required
fields as arguments.
agupqsLimit :: Lens' ApiGatewayUsagePlanQuotaSettings (Maybe (Val Integer')) Source #
The maximum number of requests that users can make within the specified time period.
agupqsOffset :: Lens' ApiGatewayUsagePlanQuotaSettings (Maybe (Val Integer')) Source #
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) Source #
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.