Deployment
`StageDescription` is a property of the AWS::ApiGateway::Deployment resource that configures a deployment stage.
Constructors
Properties
Specifies settings for logging access in this stage.
Specifies whether a cache cluster is enabled for the stage.
The size of the stage's cache cluster. For more information, see cacheClusterSize in the API Gateway API Reference.
Indicates whether the cached responses are encrypted.
The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide.
Specifies settings for the canary deployment in this stage.
The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
A description of the purpose of the stage.
The version identifier of the API documentation snapshot.
The logging level for this method. For valid values, see the `loggingLevel` property of the MethodSetting resource in the Amazon API Gateway API Reference.
Configures settings for all of the stage's methods.
Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
An array of arbitrary tags (key-value pairs) to associate with the stage.
The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
The target request steady-state rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
Specifies whether active tracing with X-ray is enabled for this stage. For more information, see Trace API Gateway API Execution with X-Ray in the API Gateway Developer Guide.