class Amazonite::ApiGateway::ApiKey

• Amazonite::ApiGateway::ApiKey
• Reference
• Object

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.

Included Modules

• JSON::Serializable

Defined in:

api_gateway/api_key.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(id : String | Nil = nil, value : String | Nil = nil, name : String | Nil = nil, customer_id : String | Nil = nil, description : String | Nil = nil, enabled : Bool | Nil = nil, created_date : Time | Nil = nil, last_updated_date : Time | Nil = nil, stage_keys : Array(String) | Nil = nil, tags : Hash(String, String) | Nil = nil)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #created_date : Time | Nil

  The timestamp when the API Key was created.

• #created_date=(created_date : Time | Nil)

  The timestamp when the API Key was created.

• #customer_id : String | Nil

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

• #customer_id=(customer_id : String | Nil)

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

• #description : String | Nil

  The description of the API Key.

• #description=(description : String | Nil)

  The description of the API Key.

• #enabled : Bool | Nil

  Specifies whether the API Key can be used by callers.

• #enabled=(enabled : Bool | Nil)

  Specifies whether the API Key can be used by callers.

• #hash(hasher)

  See Object#hash(hasher)

• #id : String | Nil

  The identifier of the API Key.

• #id=(id : String | Nil)

  The identifier of the API Key.

• #last_updated_date : Time | Nil

  The timestamp when the API Key was last updated.

• #last_updated_date=(last_updated_date : Time | Nil)

  The timestamp when the API Key was last updated.

• #name : String | Nil

  The name of the API Key.

• #name=(name : String | Nil)

  The name of the API Key.

• #stage_keys : Array(String) | Nil

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

• #stage_keys=(stage_keys : Array(String) | Nil)

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

• #tags : Hash(String, String) | Nil

  The collection of tags.

• #tags=(tags : Hash(String, String) | Nil)

  The collection of tags.

• #validate! : Nil
• #value : String | Nil

  The value of the API Key.

• #value=(value : String | Nil)

  The value of the API Key.

Constructor Detail

Instance Method Detail