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. |
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. |
HttpMethod |
String
|
Required: Yes. The HTTP method. |
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. |
MetricsEnabled |
Boolean
|
Required: No. Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage. |
ResourcePath |
String
|
Required: Yes. The resource path for this method. Forward slashes (/) are encoded as ~1 and the initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash (/). |
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. |