Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon API Gateway Deployment StageDescription

StageDescription is a property of the AWS::ApiGateway::Deployment resource that configures an Amazon API Gateway (API Gateway) deployment stage.

Syntax

JSON

Copy
{ "CacheClusterEnabled" : Boolean, "CacheClusterSize" : String, "CacheDataEncrypted" : Boolean, "CacheTtlInSeconds" : Integer, "CachingEnabled" : Boolean, "ClientCertificateId" : String, "DataTraceEnabled" : Boolean, "Description" : String, "DocumentationVersion" : String, "LoggingLevel" : String, "MethodSettings" : [ MethodSetting ], "MetricsEnabled" : Boolean, "StageName" : String, "ThrottlingBurstLimit" : Integer, "ThrottlingRateLimit" : Number, "Variables" : { String:String, ... } }

Properties

CacheClusterEnabled

Indicates whether cache clustering is enabled for the stage.

Required: No

Type: Boolean

CacheClusterSize

The size of the stage's cache cluster.

Required: No

Type: String

CacheDataEncrypted

Indicates whether the cached responses are encrypted.

Required: No

Type: Boolean

CacheTtlInSeconds

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

Required: No

Type: Integer

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

ClientCertificateId

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

Required: No

Type: String

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

Description

A description of the purpose of the stage.

Required: No

Type: String

DocumentationVersion

The version identifier of the API documentation snapshot.

Required: No

Type: String

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

MethodSettings

Configures settings for all of the stage's methods.

Required: No

Type: Amazon API Gateway Deployment StageDescription MethodSetting

MetricsEnabled

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

Required: No

Type: Boolean

StageName

The name of the stage, which API Gateway uses as the first path segment in the invoke Uniform Resource Identifier (URI).

Required: No

Type: String

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

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: Number

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: Mapping of key-value pairs

On this page: