class Aws::APIGateway::Types::ApiKey

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.

<div class=“seeAlso” markdown=“1”>

Use API Keys][1

</div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html

@!attribute [rw] id

The identifier of the API Key.
@return [String]

@!attribute [rw] value

The value of the API Key.
@return [String]

@!attribute [rw] name

The name of the API Key.
@return [String]

@!attribute [rw] customer_id

An AWS Marketplace customer identifier , when integrating with the
AWS SaaS Marketplace.
@return [String]

@!attribute [rw] description

The description of the API Key.
@return [String]

@!attribute [rw] enabled

Specifies whether the API Key can be used by callers.
@return [Boolean]

@!attribute [rw] created_date

The timestamp when the API Key was created.
@return [Time]

@!attribute [rw] last_updated_date

The timestamp when the API Key was last updated.
@return [Time]

@!attribute [rw] stage_keys

A list of Stage resources that are associated with the ApiKey
resource.
@return [Array<String>]

@!attribute [rw] tags

The collection of tags. Each tag element is associated with a given
resource.
@return [Hash<String,String>]

Constants

SENSITIVE