RestApi
import type { RestApi } from "https://aws-api.deno.dev/v0.3/services/apigateway.ts?docs=full";
Represents a REST API.
See also: Create an API
§Properties
The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer.
The list of binary media types supported by the "RestApi". By default, the "RestApi" supports only UTF-8-encoded text payloads.
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.
The endpoint configuration of this "RestApi" showing the endpoint types of the API.
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
A stringified JSON policy document that applies to this RestApi regardless of the caller and "Method" configuration.