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 キーが失効してからの時間。日付は、エポックからの秒数で表され、最も近い時間に丸められます。

タイプ: ダブル

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::AppSync::ApiKey リソースの Expires プロパティに直接渡されます。

LogicalId

API キーの一意の名前です。

タイプ: 文字列

必須: はい

CloudFormation との互換性: このプロパティは、AWS::AppSync::ApiKey リソースの ApiKeyId プロパティに直接渡されます。