CreateApiKeyRequest

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

Request to create an "ApiKey" resource.

interface CreateApiKeyRequest {

customerId?: string | null;

description?: string | null;

enabled?: boolean | null;

generateDistinctId?: boolean | null;

name?: string | null;

stageKeys?: StageKey[] | null;

tags?: {

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

} | null;

value?: string | null;

}

§Properties

customerId?: string | null

[src]

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

description?: string | null

[src]

The description of the "ApiKey".

enabled?: boolean | null

[src]

Specifies whether the "ApiKey" can be used by callers.

generateDistinctId?: boolean | null

[src]

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

name?: string | null

[src]

The name of the "ApiKey".

stageKeys?: StageKey[] | null

[src]

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

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.

value?: string | null

[src]

Specifies a value of the API key.