Amazon API Gateway ApiKey StageKey
StageKey
is a property of the AWS::ApiGateway::ApiKey resource that specifies the Amazon API Gateway (API Gateway) stage to associate with
the API key. This association allows only clients with the key to make requests to
methods in that stage.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
Properties
RestApiId
-
The ID of a
RestApi
resource that includes the stage with which you want to associate the API key.Required: No
Type: String
StageName
-
The name of the stage with which to associate the API key. The stage must be included in the
RestApi
resource that you specified in theRestApiId
property.Required: No
Type: String