We are excited to announce our new API Documentation.
Optional
AccessOptional
ApiSpecifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
Optional
AutoSpecifies whether updates to an API automatically trigger a new deployment. The default value is false.
Optional
ClientThe identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
Optional
CreatedThe timestamp when the stage was created.
Optional
DefaultDefault route settings for the stage.
Optional
DeploymentThe identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
Optional
DescriptionThe description of the stage.
Optional
LastDescribes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
Optional
LastThe timestamp when the stage was last updated.
Optional
RouteRoute settings for the stage, by routeKey.
Optional
StageThe name of the stage.
Optional
StageA map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
Optional
TagsThe collection of tags. Each tag element is associated with a given resource.
Settings for logging access in this stage.