class Aws::APIGateway::Types::UsagePlan
Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.
<div class=“remarks” markdown=“1”> In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.
</div>
<div class=“seeAlso” markdown=“1”>
- Create and Use
Usage
Plans][1 -
</div>
[1]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
@!attribute [rw] id
The identifier of a UsagePlan resource. @return [String]
@!attribute [rw] name
The name of a usage plan. @return [String]
@!attribute [rw] description
The description of a usage plan. @return [String]
@!attribute [rw] api_stages
The associated API stages of a usage plan. @return [Array<Types::ApiStage>]
@!attribute [rw] throttle
The request throttle limits of a usage plan. @return [Types::ThrottleSettings]
@!attribute [rw] quota
The maximum number of permitted requests per a given unit time interval. @return [Types::QuotaSettings]
@!attribute [rw] product_code
The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace. @return [String]
@!attribute [rw] tags
The collection of tags. Each tag element is associated with a given resource. @return [Hash<String,String>]
Constants
- SENSITIVE