apigateway/aws.sdk.kotlin.services.apigateway.model/CreateDeploymentRequest

CreateDeploymentRequest

class CreateDeploymentRequest

Requests API Gateway to create a Deployment resource.

Types

object Companion

Properties

cacheClusterEnabled

val cacheClusterEnabled: Boolean?

Enables a cache cluster for the Stage resource specified in the input.

cacheClusterSize

val cacheClusterSize: CacheClusterSize?

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

val canarySettings: DeploymentCanarySettings?

The input configuration for the canary deployment when the deployment is a canary release deployment.

val description: String?

The description for the Deployment resource to create.

val restApiId: String?

The string identifier of the associated RestApi.

stageDescription

val stageDescription: String?

The description of the Stage resource for the Deployment resource to create.

val stageName: String?

The name of the Stage resource for the Deployment resource to create.

val tracingEnabled: Boolean?

Specifies whether active tracing with X-ray is enabled for the Stage.

val variables: Map<String, String>?

A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Functions

inline fun copy(block: CreateDeploymentRequest.Builder.() -> Unit = {}): CreateDeploymentRequest

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String