Stratosphere.ResourceProperties.ApiGatewayStageMethodSetting

MethodSetting is a property of the AWS::ApiGateway::Stage resource that configures settings for all methods in an Amazon API Gateway (API Gateway) stage.

Documentation

data ApiGatewayStageMethodSetting

Full data type definition for ApiGatewayStageMethodSetting. See apiGatewayStageMethodSetting for a more convenient constructor.

Constructors

ApiGatewayStageMethodSetting

Fields

• _apiGatewayStageMethodSettingCacheDataEncrypted :: Maybe (Val Bool')
• _apiGatewayStageMethodSettingCacheTtlInSeconds :: Maybe (Val Integer')
• _apiGatewayStageMethodSettingCachingEnabled :: Maybe (Val Bool')
• _apiGatewayStageMethodSettingDataTraceEnabled :: Maybe (Val Bool')
• _apiGatewayStageMethodSettingHttpMethod :: Val Text
• _apiGatewayStageMethodSettingLoggingLevel :: Maybe (Val Text)
• _apiGatewayStageMethodSettingMetricsEnabled :: Maybe (Val Bool')
• _apiGatewayStageMethodSettingResourcePath :: Val Text
• _apiGatewayStageMethodSettingThrottlingBurstLimit :: Maybe (Val Integer')
• _apiGatewayStageMethodSettingThrottlingRateLimit :: Maybe Double'

Instances

Show ApiGatewayStageMethodSetting

Methods

showsPrec :: Int -> ApiGatewayStageMethodSetting -> ShowS

show :: ApiGatewayStageMethodSetting -> String

showList :: [ApiGatewayStageMethodSetting] -> ShowS

Generic ApiGatewayStageMethodSetting

Associated Types

type Rep ApiGatewayStageMethodSetting :: * -> *

Methods

from :: ApiGatewayStageMethodSetting -> Rep ApiGatewayStageMethodSetting x

to :: Rep ApiGatewayStageMethodSetting x -> ApiGatewayStageMethodSetting

ToJSON ApiGatewayStageMethodSetting

Methods

toJSON :: ApiGatewayStageMethodSetting -> Value

toEncoding :: ApiGatewayStageMethodSetting -> Encoding

toJSONList :: [ApiGatewayStageMethodSetting] -> Value

toEncodingList :: [ApiGatewayStageMethodSetting] -> Encoding

FromJSON ApiGatewayStageMethodSetting

Methods

parseJSON :: Value -> Parser ApiGatewayStageMethodSetting

parseJSONList :: Value -> Parser [ApiGatewayStageMethodSetting]

type Rep ApiGatewayStageMethodSetting

type Rep ApiGatewayStageMethodSetting = D1 (MetaData "ApiGatewayStageMethodSetting" "Stratosphere.ResourceProperties.ApiGatewayStageMethodSetting" "stratosphere-0.2.0-B1WeL9cnxuQ3qer3csMa6f" False) (C1 (MetaCons "ApiGatewayStageMethodSetting" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayStageMethodSettingCacheDataEncrypted") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Bool')))) (S1 (MetaSel (Just Symbol "_apiGatewayStageMethodSettingCacheTtlInSeconds") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Integer'))))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayStageMethodSettingCachingEnabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Bool')))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayStageMethodSettingDataTraceEnabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Bool')))) (S1 (MetaSel (Just Symbol "_apiGatewayStageMethodSettingHttpMethod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayStageMethodSettingLoggingLevel") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_apiGatewayStageMethodSettingMetricsEnabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Bool'))))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayStageMethodSettingResourcePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayStageMethodSettingThrottlingBurstLimit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Integer')))) (S1 (MetaSel (Just Symbol "_apiGatewayStageMethodSettingThrottlingRateLimit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Double'))))))))

apiGatewayStageMethodSetting

Arguments

:: Val Text

agsmsHttpMethod

-> Val Text

agsmsResourcePath

-> ApiGatewayStageMethodSetting

Constructor for ApiGatewayStageMethodSetting containing required fields as arguments.

agsmsCacheDataEncrypted :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Bool'))

Indicates whether the cached responses are encrypted.

agsmsCacheTtlInSeconds :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Integer'))

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

agsmsCachingEnabled :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Bool'))

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.

agsmsDataTraceEnabled :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Bool'))

Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.

agsmsHttpMethod :: Lens' ApiGatewayStageMethodSetting (Val Text)

The HTTP method.

agsmsLoggingLevel :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Text))

The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.

agsmsMetricsEnabled :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Bool'))

Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

agsmsResourcePath :: Lens' ApiGatewayStageMethodSetting (Val Text)

The resource path for this method. Forward slashes (/) are encoded as ~1 and the initial slash must include a forward slash. For example, the path value resourcesubresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash (/).

agsmsThrottlingBurstLimit :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Integer'))

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.

agsmsThrottlingRateLimit :: Lens' ApiGatewayStageMethodSetting (Maybe Double')

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.