You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::MethodSetting
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::MethodSetting
- Defined in:
- (unknown)
Overview
Specifies the method setting properties.
Instance Attribute Summary collapse
-
#cache_data_encrypted ⇒ Boolean
Specifies whether the cached responses are encrypted.
-
#cache_ttl_in_seconds ⇒ Integer
Specifies the time to live (TTL), in seconds, for cached responses.
-
#caching_enabled ⇒ Boolean
Specifies whether responses should be cached and returned for requests.
-
#data_trace_enabled ⇒ Boolean
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
-
#logging_level ⇒ String
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
-
#metrics_enabled ⇒ Boolean
Specifies whether Amazon CloudWatch metrics are enabled for this method.
-
#require_authorization_for_cache_control ⇒ Boolean
Specifies whether authorization is required for a cache invalidation request.
-
#throttling_burst_limit ⇒ Integer
Specifies the throttling burst limit.
-
#throttling_rate_limit ⇒ Float
Specifies the throttling rate limit.
-
#unauthorized_cache_control_header_strategy ⇒ String
Specifies how to handle unauthorized requests for cache invalidation.
Instance Attribute Details
#cache_data_encrypted ⇒ Boolean
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.
#cache_ttl_in_seconds ⇒ Integer
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.
#caching_enabled ⇒ Boolean
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.
#data_trace_enabled ⇒ Boolean
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.
#logging_level ⇒ String
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 are OFF
, ERROR
, and INFO
. Choose ERROR
to write
only error-level entries to CloudWatch Logs, or choose INFO
to include
all ERROR
events as well as extra informational events.
#metrics_enabled ⇒ Boolean
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.
#require_authorization_for_cache_control ⇒ Boolean
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.
#throttling_burst_limit ⇒ Integer
Specifies the throttling burst limit. The PATCH path for this setting is
/`{method_setting_key}`/throttling/burstLimit
, and the value is an
integer.
#throttling_rate_limit ⇒ Float
Specifies the throttling rate limit. The PATCH path for this setting is
/`{method_setting_key}`/throttling/rateLimit
, and the value is a
double.
#unauthorized_cache_control_header_strategy ⇒ String
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 are FAIL_WITH_403
,
SUCCEED_WITH_RESPONSE_HEADER
, SUCCEED_WITHOUT_RESPONSE_HEADER
.
Possible values:
- FAIL_WITH_403
- SUCCEED_WITH_RESPONSE_HEADER
- SUCCEED_WITHOUT_RESPONSE_HEADER