MethodSetting
Specifies the method setting properties.
Contents
- cacheDataEncrypted
-
Specifies whether the cached responses are encrypted. The PATCH path for this setting is
/{method_setting_key}/caching/dataEncrypted
, and the value is a Boolean.Type: Boolean
Required: No
- cacheTtlInSeconds
-
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is
/{method_setting_key}/caching/ttlInSeconds
, and the value is an integer.Type: Integer
Required: No
- 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. The PATCH path for this setting is
/{method_setting_key}/caching/enabled
, and the value is a Boolean.Type: Boolean
Required: No
- dataTraceEnabled
-
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is
/{method_setting_key}/logging/dataTrace
, and the value is a Boolean.Type: Boolean
Required: No
- loggingLevel
-
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is
/{method_setting_key}/logging/loglevel
, and the available levels areOFF
,ERROR
, andINFO
. ChooseERROR
to write only error-level entries to CloudWatch Logs, or chooseINFO
to include allERROR
events as well as extra informational events.Type: String
Required: No
- metricsEnabled
-
Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is
/{method_setting_key}/metrics/enabled
, and the value is a Boolean.Type: Boolean
Required: No
- requireAuthorizationForCacheControl
-
Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is
/{method_setting_key}/caching/requireAuthorizationForCacheControl
, and the value is a Boolean.Type: Boolean
Required: No
- throttlingBurstLimit
-
Specifies the throttling burst limit. The PATCH path for this setting is
/{method_setting_key}/throttling/burstLimit
, and the value is an integer.Type: Integer
Required: No
- throttlingRateLimit
-
Specifies the throttling rate limit. The PATCH path for this setting is
/{method_setting_key}/throttling/rateLimit
, and the value is a double.Type: Double
Required: No
- unauthorizedCacheControlHeaderStrategy
-
Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is
/{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy
, and the available values areFAIL_WITH_403
,SUCCEED_WITH_RESPONSE_HEADER
,SUCCEED_WITHOUT_RESPONSE_HEADER
.Type: String
Valid Values:
FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: