• Public
  • Public/Protected
  • All

Namespace CreateStageRequest

Requests API Gateway to create a Stage resource.




Optional cacheClusterEnabled

cacheClusterEnabled: undefined | false | true

Whether cache clustering is enabled for the stage.

Optional cacheClusterSize

cacheClusterSize: CacheClusterSize | string

The stage's cache cluster size.

Optional canarySettings

canarySettings: CanarySettings

The canary deployment settings of this stage.


deploymentId: string | undefined

[Required] The identifier of the Deployment resource for the Stage resource.

Optional description

description: undefined | string

The description of the Stage resource.

Optional documentationVersion

documentationVersion: undefined | string

The version of the associated API documentation.


restApiId: string | undefined

[Required] The string identifier of the associated RestApi.


stageName: string | undefined

[Required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Optional tags

tags: undefined | {}

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

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 new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.