Safe Haskell | None |
---|---|
Language | Haskell2010 |
MethodSetting is a property of the AWS::ApiGateway::Stage resource that configures settings for all methods in an Amazon API Gateway (API Gateway) stage.
- data ApiGatewayStageMethodSetting = ApiGatewayStageMethodSetting {
- _apiGatewayStageMethodSettingCacheDataEncrypted :: Maybe (Val Bool')
- _apiGatewayStageMethodSettingCacheTtlInSeconds :: Maybe (Val Integer')
- _apiGatewayStageMethodSettingCachingEnabled :: Maybe (Val Bool')
- _apiGatewayStageMethodSettingDataTraceEnabled :: Maybe (Val Bool')
- _apiGatewayStageMethodSettingHttpMethod :: HttpMethod
- _apiGatewayStageMethodSettingLoggingLevel :: Maybe LoggingLevel
- _apiGatewayStageMethodSettingMetricsEnabled :: Maybe (Val Bool')
- _apiGatewayStageMethodSettingResourcePath :: Val Text
- _apiGatewayStageMethodSettingThrottlingBurstLimit :: Maybe (Val Integer')
- _apiGatewayStageMethodSettingThrottlingRateLimit :: Maybe Double'
- apiGatewayStageMethodSetting :: HttpMethod -> Val Text -> ApiGatewayStageMethodSetting
- agsmsCacheDataEncrypted :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Bool'))
- agsmsCacheTtlInSeconds :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Integer'))
- agsmsCachingEnabled :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Bool'))
- agsmsDataTraceEnabled :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Bool'))
- agsmsHttpMethod :: Lens' ApiGatewayStageMethodSetting HttpMethod
- agsmsLoggingLevel :: Lens' ApiGatewayStageMethodSetting (Maybe LoggingLevel)
- agsmsMetricsEnabled :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Bool'))
- agsmsResourcePath :: Lens' ApiGatewayStageMethodSetting (Val Text)
- agsmsThrottlingBurstLimit :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Integer'))
- agsmsThrottlingRateLimit :: Lens' ApiGatewayStageMethodSetting (Maybe Double')
Documentation
data ApiGatewayStageMethodSetting Source #
Full data type definition for ApiGatewayStageMethodSetting. See
apiGatewayStageMethodSetting
for a more convenient constructor.
apiGatewayStageMethodSetting Source #
Constructor for ApiGatewayStageMethodSetting
containing required fields
as arguments.
agsmsCacheDataEncrypted :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Bool')) Source #
Indicates whether the cached responses are encrypted.
agsmsCacheTtlInSeconds :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Integer')) Source #
The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
agsmsCachingEnabled :: Lens' ApiGatewayStageMethodSetting (Maybe (Val Bool')) Source #
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')) Source #
Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
agsmsHttpMethod :: Lens' ApiGatewayStageMethodSetting HttpMethod Source #
The HTTP method.
agsmsLoggingLevel :: Lens' ApiGatewayStageMethodSetting (Maybe LoggingLevel) Source #
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')) Source #
Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
agsmsResourcePath :: Lens' ApiGatewayStageMethodSetting (Val Text) Source #
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')) Source #
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') Source #
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.