AWS Documentation » AWS CloudFormation » User Guide » Template Reference » Resource Property Types Reference » Amazon API Gateway UsagePlan ApiStage

Filter View: All JSON YAML

Amazon API Gateway UsagePlan ApiStage

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

Syntax

JSON

{
  "ApiId" : String,
  "Stage" : String,
  "Throttle" : { String: [ ThrottleSettings, ...  ] }
}

YAML

ApiId: String
Stage: String
Throttle: 
  String:
    - ThrottleSettings

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

Stage

The name of an API Gateway stage to associate with the usage plan.

Required: No

Type: String

Throttle

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

Duplicates are not allowed.

Required: No

Type: Map of sting-to-Amazon API Gateway UsagePlan ThrottleSettings

Update requires: No interruption