CreateDeploymentRequest

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

Requests API Gateway to create a "Deployment" resource.

interface CreateDeploymentRequest {

cacheClusterEnabled?: boolean | null;

cacheClusterSize?: CacheClusterSize | null;

canarySettings?: DeploymentCanarySettings | null;

description?: string | null;

restApiId: string;

stageDescription?: string | null;

stageName?: string | null;

tracingEnabled?: boolean | null;

variables?: {

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

} | null;

}

§Properties

cacheClusterEnabled?: boolean | null

[src]

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

cacheClusterSize?: CacheClusterSize | null

[src]

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

canarySettings?: DeploymentCanarySettings | null

[src]

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

description?: string | null

[src]

The description for the "Deployment" resource to create.

restApiId: string

[src]

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

stageDescription?: string | null

[src]

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

stageName?: string | null

[src]

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

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