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_encrypted ⇒ Boolean

Specifies whether the cached responses are encrypted.

Returns:

  • (Boolean)


4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4121

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_seconds ⇒ Integer

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.

Returns:

  • (Integer)


4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4121

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_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.

Returns:

  • (Boolean)


4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4121

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_enabled ⇒ Boolean

Specifies whether data trace logging is enabled 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.

Returns:

  • (Boolean)


4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4121

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_level ⇒ String

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values 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)


4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4121

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_enabled ⇒ Boolean

Specifies whether Amazon CloudWatch metrics are enabled for this method.

Returns:

  • (Boolean)


4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4121

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_control ⇒ Boolean

Specifies whether authorization is required for a cache invalidation request.

Returns:

  • (Boolean)


4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4121

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_limit ⇒ Integer

Specifies the throttling burst limit.

Returns:

  • (Integer)


4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4121

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_limit ⇒ Float

Specifies the throttling rate limit.

Returns:

  • (Float)


4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4121

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_strategy ⇒ String

Specifies how to handle unauthorized requests for cache invalidation.

Returns:

  • (String)


4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4121

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