Class: Aws::AppSync::Types::CreateApiKeyRequest

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

Overview

Note:

When making an API call, you may pass CreateApiKeyRequest data as a hash:

{
  api_id: "String", # required
  description: "String",
  expires: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

The ID for your GraphQL API.

Returns:

  • (String)


660
661
662
663
664
665
666
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 660

class CreateApiKeyRequest < Struct.new(
  :api_id,
  :description,
  :expires)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the purpose of the API key.

Returns:

  • (String)


660
661
662
663
664
665
666
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 660

class CreateApiKeyRequest < Struct.new(
  :api_id,
  :description,
  :expires)
  SENSITIVE = []
  include Aws::Structure
end

#expiresInteger

From the creation time, the time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .

Returns:

  • (Integer)


660
661
662
663
664
665
666
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 660

class CreateApiKeyRequest < Struct.new(
  :api_id,
  :description,
  :expires)
  SENSITIVE = []
  include Aws::Structure
end