AWS::ApiGateway::UsagePlan ApiStage

ApiStage is a property of the AWS::ApiGateway::UsagePlan resource that specifies which stages and APIs to associate with a usage plan.

Syntax

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

JSON

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

YAML

  ApiId: String
  Stage: String
  Throttle: 
    Key : Value

Properties

ApiId

The ID of an API that is in the specified Stage property that you want to associate with the usage plan.

Required: No

Type: String

Update requires: No interruption

Stage

The name of the stage to associate with the usage plan.

Required: No

Type: String

Update requires: No interruption

Throttle

Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, "/pets/GET".

Duplicates are not allowed.

Required: No

Type: Map of ThrottleSettings

Update requires: No interruption

See also

• UsagePlan in the Amazon API Gateway REST API Reference