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.
api_stages
(Attributes List) The associated API stages of a usage plan. (see below for nested schema)description
(String) The description of a usage plan.quota
(Attributes) The target maximum number of permitted requests per a given unit time interval. (see below for nested schema)tags
(Attributes List) The collection of tags. Each tag element is associated with a given resource. (see below for nested schema)throttle
(Attributes) A map containing method level throttling information for API stage in a usage plan. (see below for nested schema)usage_plan_name
(String) The name of a usage plan.id
(String) Uniquely identifies the resource.usage_plan_id
(String)api_stages
Optional:
api_id
(String) API Id of the associated API stage in a usage plan.stage
(String) API stage name of the associated API stage in a usage plan.throttle
(Attributes Map) Map containing method level throttling information for API stage in a usage plan. (see below for nested schema)api_stages.throttle
Optional:
burst_limit
(Number) The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.rate_limit
(Number) The API target request rate limit.quota
Optional:
limit
(Number) The target maximum number of requests that can be made in a given time period.offset
(Number) The number of requests subtracted from the given limit in the initial time period.period
(String) The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".tags
Required:
key
(String) The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.value
(String) The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.throttle
Optional:
burst_limit
(Number) The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.rate_limit
(Number) The API target request rate limit.Import is supported using the following syntax:
$ terraform import awscc_apigateway_usage_plan.example <resource ID>