You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::ApiKey

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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.

Use API Keys

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#created_date ⇒ Time

The timestamp when the API Key was created.

Returns:

  • (Time) —

    The timestamp when the API Key was created.

#customer_id ⇒ String

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

Returns:

  • (String) —

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

#description ⇒ String

The description of the API Key.

Returns:

  • (String) —

    The description of the API Key.

#enabled ⇒ Boolean

Specifies whether the API Key can be used by callers.

Returns:

  • (Boolean) —

    Specifies whether the API Key can be used by callers.

#id ⇒ String

The identifier of the API Key.

Returns:

  • (String) —

    The identifier of the API Key.

#last_updated_date ⇒ Time

The timestamp when the API Key was last updated.

Returns:

  • (Time) —

    The timestamp when the API Key was last updated.

#name ⇒ String

The name of the API Key.

Returns:

  • (String) —

    The name of the API Key.

#stage_keys ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#tags ⇒ Hash<String,String>

The collection of tags. Each tag element is associated with a given resource.

Returns:

  • (Hash<String,String>) —

    The collection of tags.

#value ⇒ String

The value of the API Key.

Returns:

  • (String) —

    The value of the API Key.