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

Class: Aws::AppSync::Types::ApiKey

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

Describes an API key.

Customers invoke AWS AppSync GraphQL APIs with API keys as an identity mechanism. There are two key versions:

da1: This version was introduced at launch in November 2017. These keys always expire after 7 days. Key expiration is managed by DynamoDB TTL. The keys will cease to be valid after Feb 21, 2018 and should not be used after that date.

  • ListApiKeys returns the expiration time in milliseconds.

  • CreateApiKey returns the expiration time in milliseconds.

  • UpdateApiKey is not available for this key version.

  • DeleteApiKey deletes the item from the table.

  • Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we will delete these keys from the table after Feb 21, 2018.

da2: This version was introduced in February 2018 when AppSync added support to extend key expiration.

  • ListApiKeys returns the expiration time in seconds.

  • CreateApiKey returns the expiration time in seconds and accepts a user-provided expiration time in seconds.

  • UpdateApiKey returns the expiration time in seconds and accepts a user-provided expiration time in seconds. Key expiration can only be updated while the key has not expired.

  • DeleteApiKey deletes the item from the table.

  • Expiration is stored in DynamoDB as seconds.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the purpose of the API key.

Returns:

  • (String)


65
66
67
68
69
70
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 65

class ApiKey < Struct.new(
  :id,
  :description,
  :expires)
  include Aws::Structure
end

#expiresInteger

The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

Returns:

  • (Integer)


65
66
67
68
69
70
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 65

class ApiKey < Struct.new(
  :id,
  :description,
  :expires)
  include Aws::Structure
end

#idString

The API key ID.

Returns:

  • (String)


65
66
67
68
69
70
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 65

class ApiKey < Struct.new(
  :id,
  :description,
  :expires)
  include Aws::Structure
end