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

CreateApiKeyResponse

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.

Types

Builder

class Builder

Companion

object Companion

Properties

createdDate

val createdDate: Instant?

The timestamp when the API Key was created.

customerId

val customerId: String?

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

description

val description: String?

The description of the API Key.

enabled

val enabled: Boolean

Specifies whether the API Key can be used by callers.

val id: String?

The identifier of the API Key.

lastUpdatedDate

val lastUpdatedDate: Instant?

The timestamp when the API Key was last updated.

name

val name: String?

The name of the API Key.

stageKeys

val stageKeys: List<String>?

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

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String