CacheClusterEnabled |
Boolean
|
Required: No. Indicates whether cache clustering is enabled for the stage. |
CacheClusterSize |
String
|
Required: No. The size of the stage's cache cluster. |
CacheDataEncrypted |
Boolean
|
Required: No. Indicates whether the cached responses are encrypted. |
CacheTtlInSeconds |
Number
|
Required: No. The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses. |
CachingEnabled |
Boolean
|
Required: No. 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. |
ClientCertificateId |
String
|
Required: No. The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage. |
DataTraceEnabled |
Boolean
|
Required: No. Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs. |
Description |
String
|
Required: No. A description of the purpose of the stage. |
LoggingLevel |
String
|
Required: No. The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference. |
MethodSettings |
AmazonAPIGatewayDeploymentStageDescriptionMethodSetting
|
Required: No. Configures settings for all of the stage's methods. |
MetricsEnabled |
Boolean
|
Required: No. Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage. |
StageName |
String
|
Required: No. The name of the stage, which API Gateway uses as the first path segment in the invoke Uniform Resource Identifier (URI). |
ThrottlingBurstLimit |
Number
|
Required: No. 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. |
ThrottlingRateLimit |
Number
|
Required: No. 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. |
Variables |
Map
|
Required: No. 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-._~:/?#&=,]+. |