CreateApiResponse

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

interface CreateApiResponse {

ApiEndpoint?: string | null;

ApiGatewayManaged?: boolean | null;

ApiId?: string | null;

ApiKeySelectionExpression?: string | null;

CorsConfiguration?: Cors | null;

CreatedDate?: Date | number | null;

Description?: string | null;

DisableExecuteApiEndpoint?: boolean | null;

DisableSchemaValidation?: boolean | null;

ImportInfo?: string[] | null;

Name?: string | null;

ProtocolType?: ProtocolType | null;

RouteSelectionExpression?: string | null;

Tags?: {

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

} | null;

Version?: string | null;

Warnings?: string[] | null;

}

§Properties

ApiEndpoint?: string | null

[src]

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

ApiGatewayManaged?: boolean | null

[src]

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

ApiId?: string | null

[src]

The API ID.

ApiKeySelectionExpression?: string | null

[src]

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

CorsConfiguration?: Cors | null

[src]

A CORS configuration. Supported only for HTTP APIs.

CreatedDate?: Date | number | null

[src]

The timestamp when the API was created.

Description?: string | null

[src]

The description of the API.

DisableExecuteApiEndpoint?: boolean | null

[src]

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

DisableSchemaValidation?: boolean | null

[src]

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

ImportInfo?: string[] | null

[src]

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

Name?: string | null

[src]

The name of the API.

ProtocolType?: ProtocolType | null

[src]

The API protocol.

RouteSelectionExpression?: string | null

[src]

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Tags?: {

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

} | null

[src]

A collection of tags associated with the API.

Version?: string | null

[src]

A version identifier for the API.

Warnings?: string[] | null

[src]

The warning messages reported when failonwarnings is turned on during API import.