pulumi-aws-native-kotlin/com.pulumi.awsnative.apigateway.kotlin.inputs/DeploymentStageDescriptionArgs

DeploymentStageDescriptionArgs

data class DeploymentStageDescriptionArgs(val accessLogSetting: Output<DeploymentAccessLogSettingArgs>? = null, val cacheClusterEnabled: Output<Boolean>? = null, val cacheClusterSize: Output<String>? = null, val cacheDataEncrypted: Output<Boolean>? = null, val cacheTtlInSeconds: Output<Int>? = null, val cachingEnabled: Output<Boolean>? = null, val canarySetting: Output<DeploymentCanarySettingArgs>? = null, val clientCertificateId: Output<String>? = null, val dataTraceEnabled: Output<Boolean>? = null, val description: Output<String>? = null, val documentationVersion: Output<String>? = null, val loggingLevel: Output<String>? = null, val methodSettings: Output<List<DeploymentMethodSettingArgs>>? = null, val metricsEnabled: Output<Boolean>? = null, val tags: Output<List<DeploymentTagArgs>>? = null, val throttlingBurstLimit: Output<Int>? = null, val throttlingRateLimit: Output<Double>? = null, val tracingEnabled: Output<Boolean>? = null, val variables: Output<Map<String, String>>? = null) : ConvertibleToJava<DeploymentStageDescriptionArgs>

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

Constructors

Link copied to clipboard
constructor(accessLogSetting: Output<DeploymentAccessLogSettingArgs>? = null, cacheClusterEnabled: Output<Boolean>? = null, cacheClusterSize: Output<String>? = null, cacheDataEncrypted: Output<Boolean>? = null, cacheTtlInSeconds: Output<Int>? = null, cachingEnabled: Output<Boolean>? = null, canarySetting: Output<DeploymentCanarySettingArgs>? = null, clientCertificateId: Output<String>? = null, dataTraceEnabled: Output<Boolean>? = null, description: Output<String>? = null, documentationVersion: Output<String>? = null, loggingLevel: Output<String>? = null, methodSettings: Output<List<DeploymentMethodSettingArgs>>? = null, metricsEnabled: Output<Boolean>? = null, tags: Output<List<DeploymentTagArgs>>? = null, throttlingBurstLimit: Output<Int>? = null, throttlingRateLimit: Output<Double>? = null, tracingEnabled: Output<Boolean>? = null, variables: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard
val accessLogSetting: Output<DeploymentAccessLogSettingArgs>? = null

Specifies settings for logging access in this stage.

Link copied to clipboard
val cacheClusterEnabled: Output<Boolean>? = null

Specifies whether a cache cluster is enabled for the stage.

Link copied to clipboard
val cacheClusterSize: Output<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: Output<Boolean>? = null

Indicates whether the cached responses are encrypted.

Link copied to clipboard
val cacheTtlInSeconds: Output<Int>? = null

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

Link copied to clipboard
val cachingEnabled: Output<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: Output<DeploymentCanarySettingArgs>? = null

Specifies settings for the canary deployment in this stage.

Link copied to clipboard
val clientCertificateId: Output<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: Output<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: Output<String>? = null

A description of the purpose of the stage.

Link copied to clipboard
val documentationVersion: Output<String>? = null

The version identifier of the API documentation snapshot.

Link copied to clipboard
val loggingLevel: Output<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: Output<List<DeploymentMethodSettingArgs>>? = null

Configures settings for all of the stage's methods.

Link copied to clipboard
val metricsEnabled: Output<Boolean>? = null

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

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

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

Link copied to clipboard
val throttlingBurstLimit: Output<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: Output<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: Output<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: Output<Map<String, String>>? = 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;_~:/?#&=,]+`.

Functions

Link copied to clipboard
open override fun toJava(): DeploymentStageDescriptionArgs