ApiKey

class ApiKey : KotlinCustomResource

Resource Type definition for AWS::ApiGateway::ApiKey

Example Usage

No Java example available.

No Java example available.

A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

A description of the purpose of the API key.

val enabled: Output<Boolean>?

Indicates whether the API key can be used by clients.

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

val id: Output<String>

val name: Output<String>?

A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.

A list of stages to associate with this API key.