pulumi-aws-native-kotlin/com.pulumi.awsnative.apigateway.kotlin.outputs/StageMethodSetting

StageMethodSetting

data class StageMethodSetting(val cacheDataEncrypted: Boolean? = null, val cacheTtlInSeconds: Int? = null, val cachingEnabled: Boolean? = null, val dataTraceEnabled: Boolean? = null, val httpMethod: String? = null, val loggingLevel: String? = null, val metricsEnabled: Boolean? = null, val resourcePath: String? = null, val throttlingBurstLimit: Int? = null, val throttlingRateLimit: Double? = null)

The `MethodSetting` property type configures settings for all methods in a stage. The `MethodSettings` property of the `AWS::ApiGateway::Stage` resource contains a list of `MethodSetting` property types.

Constructors

StageMethodSetting

fun StageMethodSetting(cacheDataEncrypted: Boolean? = null, cacheTtlInSeconds: Int? = null, cachingEnabled: Boolean? = null, dataTraceEnabled: Boolean? = null, httpMethod: String? = null, loggingLevel: String? = null, metricsEnabled: Boolean? = null, resourcePath: String? = null, throttlingBurstLimit: Int? = null, throttlingRateLimit: Double? = null)

Types

Companion

object Companion

Properties

cacheDataEncrypted

val cacheDataEncrypted: Boolean? = null

Specifies whether the cached responses are encrypted.

cacheTtlInSeconds

val cacheTtlInSeconds: Int? = null

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

cachingEnabled

val cachingEnabled: Boolean? = null

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

dataTraceEnabled

val dataTraceEnabled: Boolean? = null

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.

httpMethod

val httpMethod: String? = null

The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (`*`) for the `HttpMethod` and `/*` for the `ResourcePath`. This parameter is required when you specify a `MethodSetting`.

loggingLevel

val loggingLevel: String? = null

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.

metricsEnabled

val metricsEnabled: Boolean? = null

Specifies whether Amazon CloudWatch metrics are enabled for this method.

resourcePath

val resourcePath: String? = null

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 `/resource/subresource` must be encoded as `/~1resource~1subresource`. To specify the root path, use only a slash (`/`). To apply settings to multiple resources and methods, specify an asterisk (`*`) for the `HttpMethod` and `/*` for the `ResourcePath`. This parameter is required when you specify a `MethodSetting`.

throttlingBurstLimit

val throttlingBurstLimit: Int? = null

Specifies the throttling burst limit.

throttlingRateLimit

val throttlingRateLimit: Double? = null

Specifies the throttling rate limit. //