ApiKey

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

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

interface ApiKey {

createdDate?: Date | number | null;

customerId?: string | null;

description?: string | null;

enabled?: boolean | null;

id?: string | null;

lastUpdatedDate?: Date | number | null;

name?: string | null;

stageKeys?: string[] | null;

tags?: {

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

} | null;

value?: string | null;

}

§Properties

createdDate?: Date | number | null

[src]

The timestamp when the API Key was created.

customerId?: string | null

[src]

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

description?: string | null

[src]

The description of the API Key.

enabled?: boolean | null

[src]

Specifies whether the API Key can be used by callers.

id?: string | null

[src]

The identifier of the API Key.

lastUpdatedDate?: Date | number | null

[src]

The timestamp when the API Key was last updated.

name?: string | null

[src]

The name of the API Key.

stageKeys?: string[] | null

[src]

A list of Stage resources that are associated with the ApiKey resource.

tags?: {

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

} | null

[src]

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

value?: string | null

[src]

The value of the API Key.