Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateDeploymentCommandInput

Hierarchy

Index

Properties

Optional cacheClusterEnabled

cacheClusterEnabled: undefined | false | true

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

Optional cacheClusterSize

cacheClusterSize: CacheClusterSize | string

Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

Optional canarySettings

canarySettings: DeploymentCanarySettings

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

Optional description

description: undefined | string

The description for the Deployment resource to create.

restApiId

restApiId: string | undefined

[Required] The string identifier of the associated RestApi.

Optional stageDescription

stageDescription: undefined | string

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

Optional stageName

stageName: undefined | string

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

Optional tracingEnabled

tracingEnabled: undefined | false | true

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

Optional variables

variables: undefined | {}

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-._~:/?#&=,]+.