class Amazonite::ApiGateway::MethodSetting

Overview

Specifies the method setting properties.

Included Modules

Defined in:

api_gateway/method_setting.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(metrics_enabled : Bool | Nil = nil, logging_level : String | Nil = nil, data_trace_enabled : Bool | Nil = nil, throttling_burst_limit : Int32 | Nil = nil, throttling_rate_limit : Float64 | Nil = nil, caching_enabled : Bool | Nil = nil, cache_ttl_in_seconds : Int32 | Nil = nil, cache_data_encrypted : Bool | Nil = nil, require_authorization_for_cache_control : Bool | Nil = nil, unauthorized_cache_control_header_strategy : UnauthorizedCacheControlHeaderStrategy | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def cache_data_encrypted : Bool | Nil #

Specifies whether the cached responses are encrypted.


[View source]
def cache_data_encrypted=(cache_data_encrypted : Bool | Nil) #

Specifies whether the cached responses are encrypted.


[View source]
def cache_ttl_in_seconds : Int32 | Nil #

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


[View source]
def cache_ttl_in_seconds=(cache_ttl_in_seconds : Int32 | Nil) #

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


[View source]
def caching_enabled : Bool | Nil #

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.


[View source]
def caching_enabled=(caching_enabled : Bool | Nil) #

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.


[View source]
def data_trace_enabled : Bool | Nil #

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.


[View source]
def data_trace_enabled=(data_trace_enabled : Bool | Nil) #

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.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def logging_level : String | Nil #

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.


[View source]
def logging_level=(logging_level : String | Nil) #

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.


[View source]
def metrics_enabled : Bool | Nil #

Specifies whether Amazon CloudWatch metrics are enabled for this method.


[View source]
def metrics_enabled=(metrics_enabled : Bool | Nil) #

Specifies whether Amazon CloudWatch metrics are enabled for this method.


[View source]
def require_authorization_for_cache_control : Bool | Nil #

Specifies whether authorization is required for a cache invalidation request.


[View source]
def require_authorization_for_cache_control=(require_authorization_for_cache_control : Bool | Nil) #

Specifies whether authorization is required for a cache invalidation request.


[View source]
def throttling_burst_limit : Int32 | Nil #

Specifies the throttling burst limit.


[View source]
def throttling_burst_limit=(throttling_burst_limit : Int32 | Nil) #

Specifies the throttling burst limit.


[View source]
def throttling_rate_limit : Float64 | Nil #

Specifies the throttling rate limit.


[View source]
def throttling_rate_limit=(throttling_rate_limit : Float64 | Nil) #

Specifies the throttling rate limit.


[View source]
def unauthorized_cache_control_header_strategy : UnauthorizedCacheControlHeaderStrategy | Nil #

Specifies how to handle unauthorized requests for cache invalidation.


[View source]
def unauthorized_cache_control_header_strategy=(unauthorized_cache_control_header_strategy : UnauthorizedCacheControlHeaderStrategy | Nil) #

Specifies how to handle unauthorized requests for cache invalidation.


[View source]
def validate! : Nil #

[View source]