ApiKeys - AWS Serverless Application Model
語法屬性

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

ApiKeys

建立唯一金鑰，可用來執行需要 API 金鑰GraphQL的操作。

語法

若要在 AWS Serverless Application Model (AWS SAM) 範本中宣告此實體，請使用下列語法。

YAML

LogicalId:
  ApiKeyId: String
  Description: String
  ExpiresOn: Double

屬性

ApiKeyId

API 金鑰的唯一名稱。指定 以覆寫 LogicalId值。

類型：字串

必要：是

CloudFormation 相容性：此屬性會直接傳遞至 AWS::AppSync::ApiKey 資源的 ApiKeyId 屬性。

Description

API 金鑰的說明。

類型：字串

必要：否

CloudFormation 相容性：此屬性會直接傳遞至 AWS::AppSync::ApiKey 資源的 Description 屬性。

ExpiresOn

API 金鑰的到期時間。日期以自 epoch 以來的秒數表示，四捨五入至最接近的整點。

類型：Double

必要：否

CloudFormation 相容性：此屬性會直接傳遞至 AWS::AppSync::ApiKey 資源的 Expires 屬性。

LogicalId

API 金鑰的唯一名稱。

類型：字串

必要：是

CloudFormation 相容性：此屬性會直接傳遞至 AWS::AppSync::ApiKey 資源的 ApiKeyId 屬性。