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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

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.

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

Use API Keys][1

</div>

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_date ⇒ Time

The timestamp when the API Key was created.

Returns:

  • (Time) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-apigateway/types.rb', line 167

class ApiKey < Struct.new(
  :id,
  :value,
  :name,
  :customer_id,
  :description,
  :enabled,
  :created_date,
  :last_updated_date,
  :stage_keys,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#customer_id ⇒ String

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

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-apigateway/types.rb', line 167

class ApiKey < Struct.new(
  :id,
  :value,
  :name,
  :customer_id,
  :description,
  :enabled,
  :created_date,
  :last_updated_date,
  :stage_keys,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the API Key.

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-apigateway/types.rb', line 167

class ApiKey < Struct.new(
  :id,
  :value,
  :name,
  :customer_id,
  :description,
  :enabled,
  :created_date,
  :last_updated_date,
  :stage_keys,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ Boolean

Specifies whether the API Key can be used by callers.

Returns:

  • (Boolean) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-apigateway/types.rb', line 167

class ApiKey < Struct.new(
  :id,
  :value,
  :name,
  :customer_id,
  :description,
  :enabled,
  :created_date,
  :last_updated_date,
  :stage_keys,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The identifier of the API Key.

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-apigateway/types.rb', line 167

class ApiKey < Struct.new(
  :id,
  :value,
  :name,
  :customer_id,
  :description,
  :enabled,
  :created_date,
  :last_updated_date,
  :stage_keys,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date ⇒ Time

The timestamp when the API Key was last updated.

Returns:

  • (Time) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-apigateway/types.rb', line 167

class ApiKey < Struct.new(
  :id,
  :value,
  :name,
  :customer_id,
  :description,
  :enabled,
  :created_date,
  :last_updated_date,
  :stage_keys,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the API Key.

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-apigateway/types.rb', line 167

class ApiKey < Struct.new(
  :id,
  :value,
  :name,
  :customer_id,
  :description,
  :enabled,
  :created_date,
  :last_updated_date,
  :stage_keys,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stage_keys ⇒ Array<String>

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

Returns:

  • (Array<String>) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-apigateway/types.rb', line 167

class ApiKey < Struct.new(
  :id,
  :value,
  :name,
  :customer_id,
  :description,
  :enabled,
  :created_date,
  :last_updated_date,
  :stage_keys,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-apigateway/types.rb', line 167

class ApiKey < Struct.new(
  :id,
  :value,
  :name,
  :customer_id,
  :description,
  :enabled,
  :created_date,
  :last_updated_date,
  :stage_keys,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ String

The value of the API Key.

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-apigateway/types.rb', line 167

class ApiKey < Struct.new(
  :id,
  :value,
  :name,
  :customer_id,
  :description,
  :enabled,
  :created_date,
  :last_updated_date,
  :stage_keys,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end