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.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the purpose of the API key.

Returns:

  • (String)


28
29
30
31
32
33
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 28

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)


28
29
30
31
32
33
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 28

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

#idString

The API key ID.

Returns:

  • (String)


28
29
30
31
32
33
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 28

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