AWS::ApiGateway::UsagePlan ApiStage - AWS CloudFormation
SyntaxPropertiesSee also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::ApiGateway::UsagePlan ApiStage

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

Syntax

To declare this entity in your 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