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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_dateTime

The timestamp when the API Key was created.

Returns:

  • (Time)


112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 112

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_idString

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

Returns:

  • (String)


112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 112

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

#descriptionString

The description of the API Key.

Returns:

  • (String)


112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 112

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

#enabledBoolean

Specifies whether the API Key can be used by callers.

Returns:

  • (Boolean)


112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 112

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

#idString

The identifier of the API Key.

Returns:

  • (String)


112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 112

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_dateTime

The timestamp when the API Key was last updated.

Returns:

  • (Time)


112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 112

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

#nameString

The name of the API Key.

Returns:

  • (String)


112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 112

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_keysArray<String>

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

Returns:

  • (Array<String>)


112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 112

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

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 112

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

#valueString

The value of the API Key.

Returns:

  • (String)


112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 112

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