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

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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

The ID for your GraphQL API.

Returns:

  • (String)


60
61
62
63
64
65
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 60

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

#descriptionString

A description of the purpose of the API key.

Returns:

  • (String)


60
61
62
63
64
65
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 60

class CreateApiKeyRequest < Struct.new(
  :api_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. The default value for this parameter is 7 days from creation time.

Returns:

  • (Integer)


60
61
62
63
64
65
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 60

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