Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Stage

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

Represents a unique identifier for a version of a deployed "RestApi" that is callable by users.

See also: Deploy an API

interface Stage {
accessLogSettings?: AccessLogSettings | null;
cacheClusterEnabled?: boolean | null;
cacheClusterSize?: CacheClusterSize | null;
cacheClusterStatus?: CacheClusterStatus | null;
canarySettings?: CanarySettings | null;
clientCertificateId?: string | null;
createdDate?: Date | number | null;
deploymentId?: string | null;
description?: string | null;
documentationVersion?: string | null;
lastUpdatedDate?: Date | number | null;
methodSettings?: {
[key: string]: MethodSetting | null | undefined;
} | null;
stageName?: string | null;
tags?: {
[key: string]: string | null | undefined;
} | null;
tracingEnabled?: boolean | null;
variables?: {
[key: string]: string | null | undefined;
} | null;
webAclArn?: string | null;
}

§Properties

§
accessLogSettings?: AccessLogSettings | null
[src]

Settings for logging access in this stage.

§
cacheClusterEnabled?: boolean | null
[src]

Specifies whether a cache cluster is enabled for the stage.

§
cacheClusterSize?: CacheClusterSize | null
[src]

The size of the cache cluster for the stage, if enabled.

§
cacheClusterStatus?: CacheClusterStatus | null
[src]

The status of the cache cluster for the stage, if enabled.

§
canarySettings?: CanarySettings | null
[src]

Settings for the canary deployment in this stage.

§
clientCertificateId?: string | null
[src]

The identifier of a client certificate for an API stage.

§
createdDate?: Date | number | null
[src]

The timestamp when the stage was created.

§
deploymentId?: string | null
[src]

The identifier of the "Deployment" that the stage points to.

§
description?: string | null
[src]

The stage's description.

§
documentationVersion?: string | null
[src]

The version of the associated API documentation.

§
lastUpdatedDate?: Date | number | null
[src]

The timestamp when the stage last updated.

§
methodSettings?: {
[key: string]: MethodSetting | null | undefined;
} | null
[src]

A map that defines the method settings for a "Stage" resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*\/\* for overriding all methods in the stage.

§
stageName?: string | null
[src]

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

§
tags?: {
[key: string]: string | null | undefined;
} | null
[src]

The collection of tags. Each tag element is associated with a given resource.

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

§
webAclArn?: string | null
[src]

The ARN of the WebAcl associated with the "Stage".