CreateStageRequest

import type { CreateStageRequest } from "https://aws-api.deno.dev/v0.3/services/apigateway.ts?docs=full";

Requests API Gateway to create a "Stage" resource.

interface CreateStageRequest {

cacheClusterEnabled?: boolean | null;

cacheClusterSize?: CacheClusterSize | null;

canarySettings?: CanarySettings | null;

deploymentId: string;

description?: string | null;

documentationVersion?: string | null;

restApiId: string;

stageName: string;

tags?: {

[key: string]: string | null | undefined;

} | null;

tracingEnabled?: boolean | null;

variables?: {

[key: string]: string | null | undefined;

} | null;

}

§Properties

cacheClusterEnabled?: boolean | null

[src]

Whether cache clustering is enabled for the stage.

cacheClusterSize?: CacheClusterSize | null

[src]

The stage's cache cluster size.

canarySettings?: CanarySettings | null

[src]

The canary deployment settings of this stage.

deploymentId: string

[src]

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

description?: string | null

[src]

The description of the "Stage" resource.

documentationVersion?: string | null

[src]

The version of the associated API documentation.

restApiId: string

[src]

[Required] The string identifier of the associated "RestApi".

stageName: string

[src]

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

tags?: {

[key: string]: string | null | undefined;

} | null

[src]

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.

tracingEnabled?: boolean | null

[src]

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

variables?: {

[key: string]: string | null | undefined;

} | null

[src]

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