AWS CloudFormation
User Guide (Version )

AWS::ApiGateway::Deployment StageDescription

StageDescription is a property of the AWS::ApiGateway::Deployment resource that configures a deployment stage.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "AccessLogSetting" : AccessLogSetting, "CacheClusterEnabled" : Boolean, "CacheClusterSize" : String, "CacheDataEncrypted" : Boolean, "CacheTtlInSeconds" : Integer, "CachingEnabled" : Boolean, "CanarySetting" : CanarySetting, "ClientCertificateId" : String, "DataTraceEnabled" : Boolean, "Description" : String, "DocumentationVersion" : String, "LoggingLevel" : String, "MethodSettings" : [ MethodSetting, ... ], "MetricsEnabled" : Boolean, "Tags" : [ Tag, ... ], "ThrottlingBurstLimit" : Integer, "ThrottlingRateLimit" : Double, "TracingEnabled" : Boolean, "Variables" : {Key : Value, ...} }

Properties

AccessLogSetting

Specifies settings for logging access in this stage.

Required: No

Type: AccessLogSetting

Update requires: No interruption

CacheClusterEnabled

Indicates whether cache clustering is enabled for the stage.

Required: No

Type: Boolean

Update requires: No interruption

CacheClusterSize

The size of the stage's cache cluster.

Required: No

Type: String

Update requires: No interruption

CacheDataEncrypted

Indicates whether the cached responses are encrypted.

Required: No

Type: Boolean

Update requires: No interruption

CacheTtlInSeconds

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

Required: No

Type: Integer

Update requires: No interruption

CachingEnabled

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.

Required: No

Type: Boolean

Update requires: No interruption

CanarySetting

Specifies settings for the canary deployment in this stage.

Required: No

Type: CanarySetting

Update requires: No interruption

ClientCertificateId

The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.

Required: No

Type: String

Update requires: No interruption

DataTraceEnabled

Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.

Required: No

Type: Boolean

Update requires: No interruption

Description

A description of the purpose of the stage.

Required: No

Type: String

Update requires: No interruption

DocumentationVersion

The version identifier of the API documentation snapshot.

Required: No

Type: String

Update requires: No interruption

LoggingLevel

The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.

Required: No

Type: String

Update requires: No interruption

MethodSettings

Configures settings for all of the stage's methods.

Required: No

Type: List of MethodSetting

Update requires: No interruption

MetricsEnabled

Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

Required: No

Type: Boolean

Update requires: No interruption

Tags

An array of arbitrary tags (key-value pairs) to associate with the stage.

Required: No

Type: List of Tag

Update requires: No interruption

ThrottlingBurstLimit

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.

Required: No

Type: Integer

Update requires: No interruption

ThrottlingRateLimit

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.

Required: No

Type: Double

Update requires: No interruption

TracingEnabled

Specifies whether active tracing with X-ray is enabled for this stage.

For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide.

Required: No

Type: Boolean

Update requires: No interruption

Variables

A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

Required: No

Type: Map of String

Update requires: No interruption

See Also

  • Stage in the Amazon API Gateway REST API Reference

On this page: