apigateway/aws.sdk.kotlin.services.apigateway.model/CreateApiKeyRequest

CreateApiKeyRequest

class CreateApiKeyRequest

Request to create an ApiKey resource.

Types

object Companion

Properties

val customerId: String?

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

val description: String?

The description of the ApiKey.

val enabled: Boolean?

Specifies whether the ApiKey can be used by callers.

generateDistinctId

val generateDistinctId: Boolean?

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.

val name: String?

The name of the ApiKey.

val stageKeys: List<StageKey>?

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

val tags: Map<String, String>?

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.

val value: String?

Specifies a value of the API key.

Functions

inline fun copy(block: CreateApiKeyRequest.Builder.() -> Unit = {}): CreateApiKeyRequest

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String