CreateRestApiRequest

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

The POST Request to add a new "RestApi" resource to your collection.

interface CreateRestApiRequest {

apiKeySource?: ApiKeySourceType | null;

binaryMediaTypes?: string[] | null;

cloneFrom?: string | null;

description?: string | null;

disableExecuteApiEndpoint?: boolean | null;

endpointConfiguration?: EndpointConfiguration | null;

minimumCompressionSize?: number | null;

name: string;

policy?: string | null;

tags?: {

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

} | null;

version?: string | null;

}

§Properties

apiKeySource?: ApiKeySourceType | null

[src]

The source of the API key for metering requests according to a usage plan. Valid values are:

HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

binaryMediaTypes?: string[] | null

[src]

The list of binary media types supported by the "RestApi". By default, the "RestApi" supports only UTF-8-encoded text payloads.

cloneFrom?: string | null

[src]

The ID of the "RestApi" that you want to clone from.

description?: string | null

[src]

The description of the "RestApi".

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.

endpointConfiguration?: EndpointConfiguration | null

[src]

The endpoint configuration of this "RestApi" showing the endpoint types of the API.

minimumCompressionSize?: number | null

[src]

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.

name: string

[src]

[Required] The name of the "RestApi".

policy?: string | null

[src]

TODO: Failed to render documentation: unhandled top level doc tag a

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.

version?: string | null

[src]

A version identifier for the API.