Class: Aws::APIGateway::Types::MethodSetting

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

Specifies the method setting properties.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cache_data_encryptedBoolean

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.

Returns:

  • (Boolean)


5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5283

class MethodSetting < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#cache_ttl_in_secondsInteger

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.

Returns:

  • (Integer)


5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5283

class MethodSetting < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#caching_enabledBoolean

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.

Returns:

  • (Boolean)


5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5283

class MethodSetting < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#data_trace_enabledBoolean

Specifies whether full requests and responses are logged for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs. The PATCH path for this setting is /\{method_setting_key\}/logging/dataTrace, and the value is a Boolean.

Returns:

  • (Boolean)


5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5283

class MethodSetting < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#logging_levelString

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.

Returns:

  • (String)


5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5283

class MethodSetting < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#metrics_enabledBoolean

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.

Returns:

  • (Boolean)


5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5283

class MethodSetting < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#require_authorization_for_cache_controlBoolean

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.

Returns:

  • (Boolean)


5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5283

class MethodSetting < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#throttling_burst_limitInteger

Specifies the throttling burst limit. The PATCH path for this setting is /\{method_setting_key\}/throttling/burstLimit, and the value is an integer.

Returns:

  • (Integer)


5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5283

class MethodSetting < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#throttling_rate_limitFloat

Specifies the throttling rate limit. The PATCH path for this setting is /\{method_setting_key\}/throttling/rateLimit, and the value is a double.

Returns:

  • (Float)


5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5283

class MethodSetting < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#unauthorized_cache_control_header_strategyString

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.

Returns:

  • (String)


5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5283

class MethodSetting < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy)
  SENSITIVE = []
  include Aws::Structure
end