ApiKeys - Amazon Serverless Application Model
语法属性
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

ApiKeys

创建可用于执行需要 API 密钥的 GraphQL 操作的唯一密钥。

语法

要在您的 Amazon Serverless Application Model (Amazon SAM) 模板中声明此实体，请使用以下语法。

YAML

LogicalId:
  ApiKeyId: String
  Description: String
  ExpiresOn: Double

属性

ApiKeyId

您的 API 密钥的唯一名称。指定以覆盖 LogicalId 值。

类型：字符串

必需：是

Amazon CloudFormation 兼容性：此属性直接传递给 AWS::AppSync::ApiKey 资源的 ApiKeyId 属性。

Description

您的 API 键的描述。

类型：字符串

必需：否

Amazon CloudFormation 兼容性：此属性直接传递给 AWS::AppSync::ApiKey 资源的 Description 属性。

ExpiresOn

API 密钥到期的时间。日期表示为自纪元以来的秒数，向下舍入到最接近的小时。

类型：双精度

必需：否

Amazon CloudFormation 兼容性：此属性直接传递给 AWS::AppSync::ApiKey 资源的 Expires 属性。

LogicalId

您的 API 密钥的唯一名称。

类型：字符串

必需：是

Amazon CloudFormation 兼容性：此属性直接传递给 AWS::AppSync::ApiKey 资源的 ApiKeyId 属性。