Safe Haskell | None |
---|---|
Language | Haskell2010 |
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.
- data ApiGatewayUsagePlan = ApiGatewayUsagePlan {
- _apiGatewayUsagePlanApiStages :: Maybe [ApiGatewayUsagePlanApiStage]
- _apiGatewayUsagePlanDescription :: Maybe (Val Text)
- _apiGatewayUsagePlanQuota :: Maybe ApiGatewayUsagePlanQuotaSettings
- _apiGatewayUsagePlanThrottle :: Maybe ApiGatewayUsagePlanThrottleSettings
- _apiGatewayUsagePlanUsagePlanName :: Maybe (Val Text)
- apiGatewayUsagePlan :: ApiGatewayUsagePlan
- agupApiStages :: Lens' ApiGatewayUsagePlan (Maybe [ApiGatewayUsagePlanApiStage])
- agupDescription :: Lens' ApiGatewayUsagePlan (Maybe (Val Text))
- agupQuota :: Lens' ApiGatewayUsagePlan (Maybe ApiGatewayUsagePlanQuotaSettings)
- agupThrottle :: Lens' ApiGatewayUsagePlan (Maybe ApiGatewayUsagePlanThrottleSettings)
- agupUsagePlanName :: Lens' ApiGatewayUsagePlan (Maybe (Val Text))
Documentation
data ApiGatewayUsagePlan Source #
Full data type definition for ApiGatewayUsagePlan. See
apiGatewayUsagePlan
for a more convenient constructor.
apiGatewayUsagePlan :: ApiGatewayUsagePlan Source #
Constructor for ApiGatewayUsagePlan
containing required fields as
arguments.
agupApiStages :: Lens' ApiGatewayUsagePlan (Maybe [ApiGatewayUsagePlanApiStage]) Source #
The APIs and API stages to associate with this usage plan.
agupDescription :: Lens' ApiGatewayUsagePlan (Maybe (Val Text)) Source #
The purpose of this usage plan.
agupQuota :: Lens' ApiGatewayUsagePlan (Maybe ApiGatewayUsagePlanQuotaSettings) Source #
Configures the number of requests that users can make within a given interval.
agupThrottle :: Lens' ApiGatewayUsagePlan (Maybe ApiGatewayUsagePlanThrottleSettings) Source #
Configures the overall request rate (average requests per second) and burst capacity.
agupUsagePlanName :: Lens' ApiGatewayUsagePlan (Maybe (Val Text)) Source #
A name for this usage plan.