Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

The ID for your GraphQL API.

Returns:

  • (String)

1045
1046
1047
1048
1049
1050
1051
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1045

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)

1045
1046
1047
1048
1049
1050
1051
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1045

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)

1045
1046
1047
1048
1049
1050
1051
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1045

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