Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.APIGateway.Types.MethodSetting

Description

Synopsis

data MethodSetting = MethodSetting' {
- cacheTtlInSeconds :: Maybe Int
- dataTraceEnabled :: Maybe Bool
- throttlingBurstLimit :: Maybe Int
- cacheDataEncrypted :: Maybe Bool
- loggingLevel :: Maybe Text
- requireAuthorizationForCacheControl :: Maybe Bool
- cachingEnabled :: Maybe Bool
- metricsEnabled :: Maybe Bool
- throttlingRateLimit :: Maybe Double
- unauthorizedCacheControlHeaderStrategy :: Maybe UnauthorizedCacheControlHeaderStrategy
}
newMethodSetting :: MethodSetting
methodSetting_cacheTtlInSeconds :: Lens' MethodSetting (Maybe Int)
methodSetting_dataTraceEnabled :: Lens' MethodSetting (Maybe Bool)
methodSetting_throttlingBurstLimit :: Lens' MethodSetting (Maybe Int)
methodSetting_cacheDataEncrypted :: Lens' MethodSetting (Maybe Bool)
methodSetting_loggingLevel :: Lens' MethodSetting (Maybe Text)
methodSetting_requireAuthorizationForCacheControl :: Lens' MethodSetting (Maybe Bool)
methodSetting_cachingEnabled :: Lens' MethodSetting (Maybe Bool)
methodSetting_metricsEnabled :: Lens' MethodSetting (Maybe Bool)
methodSetting_throttlingRateLimit :: Lens' MethodSetting (Maybe Double)
methodSetting_unauthorizedCacheControlHeaderStrategy :: Lens' MethodSetting (Maybe UnauthorizedCacheControlHeaderStrategy)

Documentation

data MethodSetting Source #

Specifies the method setting properties.

See: newMethodSetting smart constructor.

Constructors

MethodSetting'

Fields

cacheTtlInSeconds :: Maybe Int
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.
dataTraceEnabled :: Maybe 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.
throttlingBurstLimit :: Maybe Int
Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.
cacheDataEncrypted :: Maybe 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.
loggingLevel :: Maybe Text
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.
requireAuthorizationForCacheControl :: Maybe 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.
cachingEnabled :: Maybe 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.
metricsEnabled :: Maybe 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.
throttlingRateLimit :: Maybe Double
Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.
unauthorizedCacheControlHeaderStrategy :: Maybe UnauthorizedCacheControlHeaderStrategy
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.

Instances

Instances details

Eq MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Methods (==) :: MethodSetting -> MethodSetting -> Bool # (/=) :: MethodSetting -> MethodSetting -> Bool #
Read MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Methods readsPrec :: Int -> ReadS MethodSetting # readList :: ReadS [MethodSetting] # readPrec :: ReadPrec MethodSetting # readListPrec :: ReadPrec [MethodSetting] #
Show MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Methods showsPrec :: Int -> MethodSetting -> ShowS # show :: MethodSetting -> String # showList :: [MethodSetting] -> ShowS #
Generic MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Associated Types type Rep MethodSetting :: Type -> Type # Methods from :: MethodSetting -> Rep MethodSetting x # to :: Rep MethodSetting x -> MethodSetting #
NFData MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Methods rnf :: MethodSetting -> () #
Hashable MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Methods hashWithSalt :: Int -> MethodSetting -> Int # hash :: MethodSetting -> Int #
FromJSON MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Methods parseJSON :: Value -> Parser MethodSetting # parseJSONList :: Value -> Parser [MethodSetting] #
type Rep MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting type Rep MethodSetting = D1 ('MetaData "MethodSetting" "Amazonka.APIGateway.Types.MethodSetting" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "MethodSetting'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheTtlInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "dataTraceEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "throttlingBurstLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "cacheDataEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "loggingLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "requireAuthorizationForCacheControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "cachingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "metricsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "throttlingRateLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "unauthorizedCacheControlHeaderStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UnauthorizedCacheControlHeaderStrategy)))))))

newMethodSetting :: MethodSetting Source #

Create a value of MethodSetting with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cacheTtlInSeconds:MethodSetting', methodSetting_cacheTtlInSeconds - 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.

$sel:dataTraceEnabled:MethodSetting', methodSetting_dataTraceEnabled - 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.

$sel:throttlingBurstLimit:MethodSetting', methodSetting_throttlingBurstLimit - Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

$sel:cacheDataEncrypted:MethodSetting', methodSetting_cacheDataEncrypted - 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.

$sel:loggingLevel:MethodSetting', methodSetting_loggingLevel - 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.

$sel:requireAuthorizationForCacheControl:MethodSetting', methodSetting_requireAuthorizationForCacheControl - 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.

$sel:cachingEnabled:MethodSetting', methodSetting_cachingEnabled - 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.

$sel:metricsEnabled:MethodSetting', methodSetting_metricsEnabled - 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.

$sel:throttlingRateLimit:MethodSetting', methodSetting_throttlingRateLimit - Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

$sel:unauthorizedCacheControlHeaderStrategy:MethodSetting', methodSetting_unauthorizedCacheControlHeaderStrategy - 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.

methodSetting_cacheTtlInSeconds :: Lens' MethodSetting (Maybe Int) Source #

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.

methodSetting_dataTraceEnabled :: Lens' MethodSetting (Maybe Bool) Source #

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.

methodSetting_throttlingBurstLimit :: Lens' MethodSetting (Maybe Int) Source #

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

methodSetting_cacheDataEncrypted :: Lens' MethodSetting (Maybe Bool) Source #

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.

methodSetting_loggingLevel :: Lens' MethodSetting (Maybe Text) Source #

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.

methodSetting_requireAuthorizationForCacheControl :: Lens' MethodSetting (Maybe Bool) Source #

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.

methodSetting_cachingEnabled :: Lens' MethodSetting (Maybe Bool) Source #

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.

methodSetting_metricsEnabled :: Lens' MethodSetting (Maybe Bool) Source #

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.

methodSetting_throttlingRateLimit :: Lens' MethodSetting (Maybe Double) Source #

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

methodSetting_unauthorizedCacheControlHeaderStrategy :: Lens' MethodSetting (Maybe UnauthorizedCacheControlHeaderStrategy) Source #

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.