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

DeploymentStageDescription

data class DeploymentStageDescription(val accessLogSetting: DeploymentAccessLogSetting? = null, val cacheClusterEnabled: Boolean? = null, val cacheClusterSize: String? = null, val cacheDataEncrypted: Boolean? = null, val cacheTtlInSeconds: Int? = null, val cachingEnabled: Boolean? = null, val canarySetting: DeploymentCanarySetting? = null, val clientCertificateId: String? = null, val dataTraceEnabled: Boolean? = null, val description: String? = null, val documentationVersion: String? = null, val loggingLevel: String? = null, val methodSettings: List<DeploymentMethodSetting>? = null, val metricsEnabled: Boolean? = null, val tags: List<DeploymentTag>? = null, val throttlingBurstLimit: Int? = null, val throttlingRateLimit: Double? = null, val tracingEnabled: Boolean? = null, val variables: Any? = null)

`StageDescription` is a property of the AWS::ApiGateway::Deployment resource that configures a deployment stage.

Constructors

Link copied to clipboard
fun DeploymentStageDescription(accessLogSetting: DeploymentAccessLogSetting? = null, cacheClusterEnabled: Boolean? = null, cacheClusterSize: String? = null, cacheDataEncrypted: Boolean? = null, cacheTtlInSeconds: Int? = null, cachingEnabled: Boolean? = null, canarySetting: DeploymentCanarySetting? = null, clientCertificateId: String? = null, dataTraceEnabled: Boolean? = null, description: String? = null, documentationVersion: String? = null, loggingLevel: String? = null, methodSettings: List<DeploymentMethodSetting>? = null, metricsEnabled: Boolean? = null, tags: List<DeploymentTag>? = null, throttlingBurstLimit: Int? = null, throttlingRateLimit: Double? = null, tracingEnabled: Boolean? = null, variables: Any? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val accessLogSetting: DeploymentAccessLogSetting? = null

Specifies settings for logging access in this stage.

Link copied to clipboard
val cacheClusterEnabled: Boolean? = null

Specifies whether a cache cluster is enabled for the stage.

Link copied to clipboard
val cacheClusterSize: String? = null

The size of the stage's cache cluster. For more information, see cacheClusterSize in the API Gateway API Reference.

Link copied to clipboard
val cacheDataEncrypted: Boolean? = null

Indicates whether the cached responses are encrypted.

Link copied to clipboard
val cacheTtlInSeconds: Int? = null

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

Link copied to clipboard
val cachingEnabled: Boolean? = null

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide.

Link copied to clipboard
val canarySetting: DeploymentCanarySetting? = null

Specifies settings for the canary deployment in this stage.

Link copied to clipboard
val clientCertificateId: String? = null

The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.

Link copied to clipboard
val dataTraceEnabled: Boolean? = null

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

Link copied to clipboard
val description: String? = null

A description of the purpose of the stage.

Link copied to clipboard
val documentationVersion: String? = null

The version identifier of the API documentation snapshot.

Link copied to clipboard
val loggingLevel: String? = null

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

Link copied to clipboard
val methodSettings: List<DeploymentMethodSetting>? = null

Configures settings for all of the stage's methods.

Link copied to clipboard
val metricsEnabled: Boolean? = null

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

Link copied to clipboard
val tags: List<DeploymentTag>? = null

An array of arbitrary tags (key-value pairs) to associate with the stage.

Link copied to clipboard
val throttlingBurstLimit: Int? = null

The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.

Link copied to clipboard
val throttlingRateLimit: Double? = null

The target request steady-state rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.

Link copied to clipboard
val tracingEnabled: Boolean? = null

Specifies whether active tracing with X-ray is enabled for this stage. For more information, see Trace API Gateway API Execution with X-Ray in the API Gateway Developer Guide.

Link copied to clipboard
val variables: Any? = null

A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: `[A-Za-z0-9-&#46;_~:/?#&=,]+`.