AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

MethodSetting

import "github.com/aws/aws-sdk-go/service/apigateway"

type MethodSetting struct { CacheDataEncrypted *bool `locationName:"cacheDataEncrypted" type:"boolean"` CacheTtlInSeconds *int64 `locationName:"cacheTtlInSeconds" type:"integer"` CachingEnabled *bool `locationName:"cachingEnabled" type:"boolean"` DataTraceEnabled *bool `locationName:"dataTraceEnabled" type:"boolean"` LoggingLevel *string `locationName:"loggingLevel" type:"string"` MetricsEnabled *bool `locationName:"metricsEnabled" type:"boolean"` RequireAuthorizationForCacheControl *bool `locationName:"requireAuthorizationForCacheControl" type:"boolean"` ThrottlingBurstLimit *int64 `locationName:"throttlingBurstLimit" type:"integer"` ThrottlingRateLimit *float64 `locationName:"throttlingRateLimit" type:"double"` UnauthorizedCacheControlHeaderStrategy *string `locationName:"unauthorizedCacheControlHeaderStrategy" type:"string" enum:"UnauthorizedCacheControlHeaderStrategy"` }

Specifies the method setting properties.

CacheDataEncrypted

Type: *bool

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.

CacheTtlInSeconds

Type: *int64

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.

CachingEnabled

Type: *bool

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.

DataTraceEnabled

Type: *bool

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.

LoggingLevel

Type: *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.

MetricsEnabled

Type: *bool

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.

RequireAuthorizationForCacheControl

Type: *bool

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.

ThrottlingBurstLimit

Type: *int64

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

ThrottlingRateLimit

Type: *float64

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

UnauthorizedCacheControlHeaderStrategy

Type: *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.

Method

GoString

func (s MethodSetting) GoString() string

GoString returns the string representation

SetCacheDataEncrypted

func (s *MethodSetting) SetCacheDataEncrypted(v bool) *MethodSetting

SetCacheDataEncrypted sets the CacheDataEncrypted field's value.

SetCacheTtlInSeconds

func (s *MethodSetting) SetCacheTtlInSeconds(v int64) *MethodSetting

SetCacheTtlInSeconds sets the CacheTtlInSeconds field's value.

SetCachingEnabled

func (s *MethodSetting) SetCachingEnabled(v bool) *MethodSetting

SetCachingEnabled sets the CachingEnabled field's value.

SetDataTraceEnabled

func (s *MethodSetting) SetDataTraceEnabled(v bool) *MethodSetting

SetDataTraceEnabled sets the DataTraceEnabled field's value.

SetLoggingLevel

func (s *MethodSetting) SetLoggingLevel(v string) *MethodSetting

SetLoggingLevel sets the LoggingLevel field's value.

SetMetricsEnabled

func (s *MethodSetting) SetMetricsEnabled(v bool) *MethodSetting

SetMetricsEnabled sets the MetricsEnabled field's value.

SetRequireAuthorizationForCacheControl

func (s *MethodSetting) SetRequireAuthorizationForCacheControl(v bool) *MethodSetting

SetRequireAuthorizationForCacheControl sets the RequireAuthorizationForCacheControl field's value.

SetThrottlingBurstLimit

func (s *MethodSetting) SetThrottlingBurstLimit(v int64) *MethodSetting

SetThrottlingBurstLimit sets the ThrottlingBurstLimit field's value.

SetThrottlingRateLimit

func (s *MethodSetting) SetThrottlingRateLimit(v float64) *MethodSetting

SetThrottlingRateLimit sets the ThrottlingRateLimit field's value.

SetUnauthorizedCacheControlHeaderStrategy

func (s *MethodSetting) SetUnauthorizedCacheControlHeaderStrategy(v string) *MethodSetting

SetUnauthorizedCacheControlHeaderStrategy sets the UnauthorizedCacheControlHeaderStrategy field's value.

String

func (s MethodSetting) String() string

String returns the string representation

On this page: