Usage
data class UsagePlanArgs(val apiStages: Output<List<UsagePlanApiStageArgs>>? = null, val description: Output<String>? = null, val quota: Output<UsagePlanQuotaSettingsArgs>? = null, val tags: Output<List<TagArgs>>? = null, val throttle: Output<UsagePlanThrottleSettingsArgs>? = null, val usagePlanName: Output<String>? = null) : ConvertibleToJava<UsagePlanArgs>
The `AWS::ApiGateway::UsagePlan` resource creates a usage plan for deployed APIs. A usage plan sets a target for the 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. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using to monitor costs and to manage API requests.
Constructors
Link copied to clipboard
constructor(apiStages: Output<List<UsagePlanApiStageArgs>>? = null, description: Output<String>? = null, quota: Output<UsagePlanQuotaSettingsArgs>? = null, tags: Output<List<TagArgs>>? = null, throttle: Output<UsagePlanThrottleSettingsArgs>? = null, usagePlanName: Output<String>? = null)
Properties
Link copied to clipboard
The associated API stages of a usage plan.
Link copied to clipboard
The description of a usage plan.
Link copied to clipboard
The target maximum number of permitted requests per a given unit time interval.
Link copied to clipboard
A map containing method level throttling information for API stage in a usage plan.
Link copied to clipboard
The name of a usage plan.