翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS AppSync での環境変数の使用
環境変数を使用すると、コードを更新せずに AWS AppSync リゾルバーと関数の動作を調整できます。環境変数は、実行時にリゾルバーと関数が活用できる、API 設定に保存されている文字列のペアです。これらは、初期設定時にのみ使用できる設定データを参照する必要がありますが、実行時にリゾルバーと関数で使用する必要がある状況で特に便利です。環境変数はコード内の設定データを公開するため、これらの値をハードコードする必要性が軽減されます。
**注記**
データベースのセキュリティを強化するには、環境変数の代わりに [Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) または [AWS Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html) を使用して認証情報や機密情報を保存することをお勧めします。この機能を活用するには、「[AWS AppSync HTTP データソースを使用した AWS サービスの呼び出し](https://docs.aws.amazon.com/appsync/latest/devguide/tutorial-http-resolvers-js.html#invoking-aws-services-js)」を参照してください。
環境変数が適切に機能するには、いくつかの動作とルールに従う必要があります。
+ JavaScript リゾルバー/関数と VTL テンプレートの両方が環境変数をサポートしています。
+ 環境変数は、関数の呼び出しの前には評価されません。
+ 環境変数は文字列値**のみ**をサポートします。
+ 環境変数で定義した値は文字列リテラルとみなされ、展開されません。
+ 変数評価は、理想的には関数コードで実行する必要があります。
## 環境変数の設定 (コンソール)
AWS AppSync GraphQL API の環境変数を設定するには、変数を作成し、キーと値のペアを定義します。リゾルバーと関数は、環境変数のキー名を使用して、実行時に値を取得します。AWS AppSync コンソールで環境変数を設定するには
1. AWS マネジメントコンソール にサインインして、[AppSync コンソール](https://console.aws.amazon.com/appsync/)を開きます。
1. **API**] ページで、GraphQL API の名前を選択します。
1. API のホームページのナビゲーションペインで、**[設定]** を選択します。
1. **[環境変数]** の下で、**[環境変数を追加]** を選択します。
1. **[環境変数の追加]** を選択します。
1. キーと値を入力します。
1. 必要に応じて、ステップ 5 と 6 を繰り返してキー値を追加します。キー値を削除する必要がある場合は、**[削除]** オプションと削除するキー (複数可) を選択します。
1. [**Submit**] を選択してください。
**ヒント**
キーと値を作成するときは、いくつかのルールに従う必要があります。
キーの先頭は文字を使用する必要があります。
キーは 2 文字以上にする必要があります。
キーには、文字、数字、およびアンダースコア (\$1) のみを含めることができます。
値には最大 512 文字を使用できます。
GraphQL API では、最大 50 個のキーと値のペアを設定できます。
## 環境変数の設定 (API)
API を使用して環境変数を設定するには、`PutGraphqlApiEnvironmentVariables` を使用できます。対応する CLI コマンドは `put-graphql-api-environment-variables` です。
API を使用して環境変数を取得するには、`GetGraphqlApiEnvironmentVariables` を使用できます。対応する CLI コマンドは `get-graphql-api-environment-variables` です。
コマンドには、API ID と環境変数のリストが含まれている必要があります。
```
aws appsync put-graphql-api-environment-variables \
--api-id "" \
--environment-variables '{"key1":"value1","key2":"value2", …}'
```
次の例では、`put-graphql-api-environment-variables` コマンドを使用する ID `abcdefghijklmnopqrstuvwxyz` を持つ API に 2 つの環境変数を設定します。
```
aws appsync put-graphql-api-environment-variables \
--api-id "abcdefghijklmnopqrstuvwxyz" \
--environment-variables '{"USER_TABLE":"users_prod","DEBUG":"true"}'
```
`put-graphql-api-environment-variables` コマンドで環境変数を適用すると、環境変数の構造の内容が上書きされることに注意してください。これは、既存の環境変数が失われることを意味します。新しい環境変数を追加するときに、既存の環境変数を保持するには、リクエストに新しい環境変数と一緒に、**すべての既存のキーと値のペアを含め**ます。上記の例を使用して、`"EMPTY":""` を追加する場合は、以下を実行できます。
```
aws appsync put-graphql-api-environment-variables \
--api-id "abcdefghijklmnopqrstuvwxyz" \
--environment-variables '{"USER_TABLE":"users_prod","DEBUG":"true", "EMPTY":""}'
```
現在の設定を取得するには、`get-graphql-api-environment-variables` コマンドを使用します。
```
aws appsync get-graphql-api-environment-variables --api-id ""
```
上記の例を使用して、次のコマンドを使用できます。
```
aws appsync get-graphql-api-environment-variables --api-id "abcdefghijklmnopqrstuvwxyz"
```
結果には、環境変数のリストとそのキー値が表示されます。
```
{
"environmentVariables": {
"USER_TABLE": "users_prod",
"DEBUG": "true",
"EMPTY": ""
}
}
```
## 環境変数の設定 (CFN)
以下のテンプレートを使用して環境変数を作成できます。
```
AWSTemplateFormatVersion: 2010-09-09
Resources:
GraphQLApiWithEnvVariables:
Type: "AWS::AppSync::GraphQLApi"
Properties:
Name: "MyApiWithEnvVars"
AuthenticationType: "AWS_IAM"
EnvironmentVariables:
EnvKey1: "non-empty"
EnvKey2: ""
```
## 環境変数とマージ済みの API
ソース API で定義されている環境変数は、マージ済みの API でも利用できます。マージ済みの API 環境変数は読み取り専用であり、更新できません。マージを成功させるには、環境変数キーがすべてのソース API で一意である必要があります。キーが重複すると、マージは常に失敗します。
## 環境変数の取得
関数コードの環境変数を取得するには、リゾルバーと関数の `ctx.env` オブジェクトから値を取得します。以下に、実際に実行されている例をいくつか示します。
------
#### [ Publishing to Amazon SNS ]
この例では、HTTP リゾルバーは Amazon SNS トピックにメッセージを送信します。トピックの ARN は、GraphQL API とトピックを定義するスタックがデプロイされた後にのみ認識されます。
```
/**
* Sends a publish request to the SNS topic
*/
export function request(ctx) {
const TOPIC_ARN = ctx.env.TOPIC_ARN;
const { input: values } = ctx.args;
// this custom function sends values to the SNS topic
return publishToSNSRequest(TOPIC_ARN, values);
}
```
------
#### [ Transactions with DynamoDB ]
この例では、API がステージング用にデプロイされている場合、または既に本番環境にある場合、DynamoDB テーブルの名前は異なります。リゾルバーコードを変更する必要はありません。環境変数の値は、API がデプロイされる場所に基づいて更新されます。
```
import { util } from '@aws-appsync/utils';
export function request(ctx) {
const { authorId, postId } = ctx.args;
return {
operation: 'TransactWriteItems',
transactItems: [
{
table: ctx.env.POST_TABLE,
operation: 'PutItem',
key: util.dynamodb.toMapValues({ postId }),
// rest of the configuration
},
{
table: ctx.env.AUTHOR_TABLE,
operation: 'UpdateItem',
key: util.dynamodb.toMapValues({ authorId }),
// rest of the configuration
},
],
};
}
```
------