AWS::ApiGateway::UsagePlan ApiStage - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::ApiGateway::UsagePlan ApiStage

API stage name of the associated API stage in a usage plan.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{ "ApiId" : String, "Stage" : String, "Throttle" : {Key: Value, ...} }

YAML

ApiId: String Stage: String Throttle: Key: Value

Properties

ApiId

API Id of the associated API stage in a usage plan.

Required: No

Type: String

Update requires: No interruption

Stage

API stage name of the associated API stage in a usage plan.

Required: No

Type: String

Update requires: No interruption

Throttle

Map containing method level throttling information for API stage in a usage plan.

Required: No

Type: Object of ThrottleSettings

Update requires: No interruption

See also

  • UsagePlan in the Amazon API Gateway REST API Reference