ApiKeys - Amazon Serverless Application Model
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ApiKeys

Create a unique key that can be used to perform GraphQL operations requiring an API key.

Syntax

To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.

YAML

LogicalId:
  ApiKeyId: String
  Description: String
  ExpiresOn: Double

Properties

ApiKeyId

The unique name of your API key. Specify to override the LogicalId value.

Type: String

Required: Yes

Amazon CloudFormation compatibility: This property is passed directly to the ApiKeyId property of an AWS::AppSync::ApiKey resource.

Description

Description of your API key.

Type: String

Required: No

Amazon CloudFormation compatibility: This property is passed directly to the Description property of an AWS::AppSync::ApiKey resource.

ExpiresOn

The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

Type: Double

Required: No

Amazon CloudFormation compatibility: This property is passed directly to the Expires property of an AWS::AppSync::ApiKey resource.

LogicalId

The unique name of your API key.

Type: String

Required: Yes

Amazon CloudFormation compatibility: This property is passed directly to the ApiKeyId property of an AWS::AppSync::ApiKey resource.