AWS::ApiGateway::Deployment MethodSetting
The MethodSetting
property type configures settings for all methods in a stage.
The MethodSettings
property of the Amazon API Gateway Deployment StageDescription property type contains a list of MethodSetting
property types.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "CacheDataEncrypted" :
Boolean
, "CacheTtlInSeconds" :Integer
, "CachingEnabled" :Boolean
, "DataTraceEnabled" :Boolean
, "HttpMethod" :String
, "LoggingLevel" :String
, "MetricsEnabled" :Boolean
, "ResourcePath" :String
, "ThrottlingBurstLimit" :Integer
, "ThrottlingRateLimit" :Double
}
YAML
CacheDataEncrypted:
Boolean
CacheTtlInSeconds:Integer
CachingEnabled:Boolean
DataTraceEnabled:Boolean
HttpMethod:String
LoggingLevel:String
MetricsEnabled:Boolean
ResourcePath:String
ThrottlingBurstLimit:Integer
ThrottlingRateLimit:Double
Properties
CacheDataEncrypted
-
Specifies whether the cached responses are encrypted.
Required: No
Type: Boolean
Update requires: No interruption
CacheTtlInSeconds
-
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
Required: No
Type: Integer
Update requires: No interruption
CachingEnabled
-
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
Required: No
Type: Boolean
Update requires: No interruption
DataTraceEnabled
-
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
Required: No
Type: Boolean
Update requires: No interruption
HttpMethod
-
The HTTP method.
Required: No
Type: String
Update requires: No interruption
LoggingLevel
-
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are
OFF
,ERROR
, andINFO
. ChooseERROR
to write only error-level entries to CloudWatch Logs, or chooseINFO
to include allERROR
events as well as extra informational events.Required: No
Type: String
Update requires: No interruption
MetricsEnabled
-
Specifies whether Amazon CloudWatch metrics are enabled for this method.
Required: No
Type: Boolean
Update requires: No interruption
ResourcePath
-
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 (/
).Required: No
Type: String
Update requires: No interruption
ThrottlingBurstLimit
-
Specifies the throttling burst limit.
Required: No
Type: Integer
Update requires: No interruption
ThrottlingRateLimit
-
Specifies the throttling rate limit.
Required: No
Type: Double
Update requires: No interruption
See also
-
Stage in the Amazon API Gateway REST API Reference