AwsApiGatewayRestApiDetails

import type { AwsApiGatewayRestApiDetails } from "https://aws-api.deno.dev/v0.4/services/securityhub.ts?docs=full";

Contains information about a REST API in version 1 of Amazon API Gateway.

interface AwsApiGatewayRestApiDetails {

ApiKeySource?: string | null;

BinaryMediaTypes?: string[] | null;

CreatedDate?: string | null;

Description?: string | null;

EndpointConfiguration?: AwsApiGatewayEndpointConfiguration | null;

Id?: string | null;

MinimumCompressionSize?: number | null;

Name?: string | null;

Version?: string | null;

}

§Properties

ApiKeySource?: string | null

[src]

The source of the API key for metering requests according to a usage plan.

HEADER indicates whether to read the API key from the X-API-Key header of a request.

AUTHORIZER indicates whether 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 REST API.

CreatedDate?: string | null

[src]

Indicates when the API was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

Description?: string | null

[src]

A description of the REST API.

EndpointConfiguration?: AwsApiGatewayEndpointConfiguration | null

[src]

The endpoint configuration of the REST API.

Id?: string | null

[src]

The identifier of the REST API.

MinimumCompressionSize?: number | null

[src]

The minimum size in bytes of a payload before compression is enabled.

If null, then compression is disabled.

If 0, then all payloads are compressed.

Name?: string | null

[src]

The name of the REST API.

Version?: string | null

[src]

The version identifier for the REST API.