AWS Batch ジョブ環境変数

AWS Batch は、コンテナジョブで特定の環境変数を設定します。これらの環境変数は、ジョブ内のコンテナのイントロスペクションを行います。これらの変数の値は、アプリケーションのロジックで使用できます。 AWS Batch を設定するすべての変数はAWS_BATCH_、 プレフィックスで始まります。これは、保護された環境変数プレフィックスです。このプレフィックスは、ジョブ定義やオーバーライド内の独自の変数には使用できません。

ジョブコンテナでは、次の環境変数を使用できます。

AWS_BATCH_CE_NAME

この変数は、ジョブが配置されるコンピューティング環境の名前に設定されます。

AWS_BATCH_JOB_ARRAY_INDEX

この変数は、子配列ジョブでのみ設定されます。配列ジョブのインデックスは 0 から始まり、各子ジョブは一意のインデックス番号を受け取ります。たとえば、10 の子を持つ配列ジョブのインデックス値は 0 〜 9 です。このインデックス値を使用して、配列ジョブの子がどのように区別されるかを制御できます。詳細については、チュートリアル: 配列ジョブインデックスを使用したジョブの差別化の制御を参照してください。

AWS_BATCH_JOB_ARRAY_SIZE

この変数は、親配列ジョブのサイズに設定されます。親配列ジョブのサイズは、この変数の子配列ジョブに渡されます。

AWS_BATCH_JOB_ATTEMPT

この変数は、ジョブ試行番号に設定されます。最初の試行番号は 1 となります。詳細については、「ジョブの再試行の自動化」を参照してください。

AWS_BATCH_JOB_ID

この変数は AWS Batch ジョブ ID に設定されます。

AWS_BATCH_JOB_KUBERNETES_NODE_UID

この変数は、ポッドが実行されている Kubernetes クラスターにあるノードオブジェクトの Kubernetes UID として設定されます。この変数は、Amazon EKS リソースで実行されるジョブにのみ設定されます。 の詳細については、Kubernetes ドキュメンテーションのを参照してください。

AWS_BATCH_JOB_MAIN_NODE_INDEX

この変数は複数ノード並列ジョブの子ノードでのみ設定されます。この変数は、ジョブの主要なノードのインデックス番号に設定されます。アプリケーションコードは、AWS_BATCH_JOB_MAIN_NODE_INDEX と AWS_BATCH_JOB_NODE_INDEX を単一ノードで比較して、これが主要なノードであるかを確認できます。

AWS_BATCH_JOB_MAIN_NODE_PRIVATE_IPV4_ADDRESS

この変数は複数ノード並列ジョブの子ノードでのみ設定されます。この変数はメインノードには存在しないが、ジョブのメインノードのプライベートIPv4アドレスに設定されます。子ノードのアプリケーションコードは、このアドレスを使用して主要なノードと通信できます。

AWS_BATCH_JOB_NODE_INDEX

この変数は複数ノード並列ジョブの子ノードでのみ設定されます。この変数は、ノードのノードインデックス番号に設定されます。ノードインデックスは 0 で始まり、各ノードは一意のインデックス番号を受け取ります。たとえば、10 の子を持つマルチノードの並列ジョブのインデックス値は 0 〜 9 です。

AWS_BATCH_JOB_NUM_NODES

この変数は複数ノード並列ジョブの子ノードでのみ設定されます。この変数は、マルチノードの並列ジョブにリクエストしたノードの数に設定されます。

AWS_BATCH_JQ_NAME

この変数は、ジョブが送信されたジョブキューの名前に設定されます。