Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.



AccessLogSettings?: AccessLogSettings

Settings for logging access in this stage.

ApiGatewayManaged?: boolean

Specifies 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.

AutoDeploy?: boolean

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

ClientCertificateId?: string

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

CreatedDate?: Date

The timestamp when the stage was created.

DefaultRouteSettings?: RouteSettings

Default route settings for the stage.

DeploymentId?: string

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Description?: string

The description of the stage.

LastDeploymentStatusMessage?: string

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

LastUpdatedDate?: Date

The timestamp when the stage was last updated.

RouteSettings?: Record<string, RouteSettings>

Route settings for the stage, by routeKey.

StageName?: string

The name of the stage.

StageVariables?: Record<string, string>

A 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-._~:/?#&=,]+.

Tags?: Record<string, string>

The collection of tags. Each tag element is associated with a given resource.