AWS CloudFormation
ユーザーガイド (API バージョン 2010-05-15)

AWS::AppSync::ApiKey

AWS::AppSync::ApiKey リソースを使用して、AWS AppSync で API キーが必要な GraphQL オペレーションを実行しているクライアントに配信できる一意のキーを作成します。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

{ "Type" : "AWS::AppSync::ApiKey", "Properties" : { "Description" : String, "Expires" : Number, "ApiId" : String } }

YAML

Type: "AWS::AppSync::ApiKey" Properties: Description: String Expires: Number ApiId: String

プロパティ

Description

API キーに関する一意の説明。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 中断はありません

Expires

API キーの有効期間 (UNIX エポック時刻形式: 秒)。最小 1 日間~最大 365 日間で表します。デフォルト値は 7 日です。

必須: いいえ

: 数値

更新に伴う要件: 中断はありません

ApiId

AWS AppSync で使用する、この API キーの一意の GraphQL API 識別子。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 置換

戻り値

参照番号

AWS::AppSync::ApiKey リソースの論理 ID を組み込み Ref 関数に渡すと、API キーの ARN (例: arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/apikey/apikeya1bzhi) が返ります。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

Fn::GetAtt

Fn::GetAtt は、このタイプの指定された属性の値を返します。以下には、利用可能な属性とサンプル戻り値のリストが示されます。

ApiKey

API キー。

Arn

API キーの Amazon リソースネーム (ARN) (例: arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/apikey/apikeya1bzhi)。

Fn::GetAtt の使用の詳細については、「Fn::GetAtt」を参照してください。

API キーの作成例

次の例では、API キーを作成して、GraphQL API ID をパラメータとして渡し、既存の GraphQL API と関連付けます。

JSON

{ "Parameters": { "graphQlApiId": { "Type": "String" }, "apiKeyDescription": { "Type": "String" }, "apiKeyExpires": { "Type": "Number" } }, "Resources": { "ApiKey": { "Type": "AWS::AppSync::ApiKey", "Properties": { "ApiId": { "Ref": "graphQlApiId" }, "Description": { "Ref": "apiKeyDescription" }, "Expires": { "Ref": "apiKeyExpires" } } } } }

YAML

Parameters: graphQlApiId: Type: String apiKeyDescription: Type: String apiKeyExpires: Type: Number Resources: ApiKey: Type: AWS::AppSync::ApiKey Properties: ApiId: Ref: graphQlApiId Description: Ref: apiKeyDescription Expires: Ref: apiKeyExpires

以下の資料も参照してください。

  • AWS AppSync API リファレンスCreateApiKey オペレーション。