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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateApiKeyRequest as input to an Aws::Client method, you can use a vanilla 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)

    The ID for your GraphQL API.

#descriptionString

A description of the purpose of the API key.

Returns:

  • (String)

    A description of the purpose of the API key.

#expiresInteger

The time from creation 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)

    The time from creation time after which the API key expires.