AWS CodeBuild
ユーザーガイド (API バージョン 2016-10-06)

ビルド環境の環境変数

AWS CodeBuild には、ビルドコマンドで使用できるいくつかの環境変数が用意されています。

  • AWS_DEFAULT_REGION: ビルドが実行されている AWS リージョン (例:us-east-1)。この環境変数は、AWS CLI で主に使用されます。

  • AWS_REGION: ビルドが実行されている AWS リージョン (例:us-east-1)。この環境変数は、AWS SDK で主に使用されます。

  • CODEBUILD_BUILD_ARN: ビルドの Amazon リソースネーム (ARN) (例:arn:aws:codebuild:region-ID:account-ID:build/codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE)。

  • CODEBUILD_BUILD_ID: ビルドの AWS CodeBuild ID (例:codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE)。

  • CODEBUILD_BUILD_IMAGE: AWS CodeBuild ビルドイメージ識別子 (例:aws/codebuild/java:openjdk-8)。

  • CODEBUILD_BUILD_SUCCEEDING: 現在のビルドが成功かどうか。ビルドが失敗の場合は 0 に設定され、成功の場合は 1 に設定されます。

  • CODEBUILD_INITIATOR: ビルドを開始したエンティティ。AWS CodePipeline がビルドを開始した場合、これはパイプラインの名前です (例:codepipeline/my-demo-pipeline)。IAM ユーザーがビルドを開始した場合は、これはユーザーの名前です (例:MyUserName)。AWS CodeBuild の Jenkins プラグインがビルドを開始した場合、これは文字列 CodeBuild-Jenkins-Plugin です。

  • CODEBUILD_KMS_KEY_ID: AWS CodeBuild がビルド出力アーティファクトを暗号化するために使用している AWS KMS キーの識別子 (例:arn:aws:kms:region-ID:account-ID:key/key-ID または alias/key-alias)。

  • CODEBUILD_LOG_PATH: CloudWatch Logs でのビルドのログストリーム名。

  • CODEBUILD_RESOLVED_SOURCE_VERSION: AWS CodePipeline によって実行されるビルドの場合、ビルドするソースコードのコミット ID または Amazon S3 バージョン ID。この値は、パイプラインの関連するソースアクションが Amazon S3、AWS CodeCommit、または GitHub リポジトリに基づいている場合にのみ使用できます。

    注記

    CODEBUILD_RESOLVED_SOURCE_VERSION 環境変数は常に使用できるとは限りません。

  • CODEBUILD_SOURCE_REPO_URL: 入力アーティファクトまたはソースコードリポジトリの URL。Amazon S3 では、これは s3:// の後にバケット名と入力アーティファクトへのパスが続きます。AWS CodeCommit および GitHub の場合、これはリポジトリのクローン URL です。AWS CodePipeline から生成されたビルドの場合、これは空の場合があります。

  • CODEBUILD_SOURCE_VERSION: Amazon S3 の場合、入力アーティファクトに関連付けられたバージョン ID。AWS CodeCommit の場合、ビルドするソースコードのバージョンに関連付けられたコミット ID またはブランチ名。CODEBUILD_RESOLVED_SOURCE_VERSIONGitHub の場合、ビルドするソースコードのバージョンに関連付けられたコミット ID、ブランチ名、またはタグ名。

  • CODEBUILD_SRC_DIR: AWS CodeBuild がビルドに使用するディレクトリパス (例:/tmp/src123456789/src)。

  • CODEBUILD_START_TIME: ビルドの開始時間。

  • HOME: この環境変数は常に /root に設定されます。

独自の環境変数を持つビルド環境を提供することもできます。詳細については、次のトピックを参照してください。

ビルド環境で使用できる環境変数を一覧表示するには、構築時に printenv コマンド (Linux ベースのビルド環境) または "Get-ChildItem Env:" (Windows ベースのビルド環境) を実行できます。前述のものを除いて、CODEBUILD_ で始まる環境変数は、AWS CodeBuild の内部使用のためのものです。それらはビルドコマンドで使用できません。

重要

機密情報、特に AWS アクセスキー ID とシークレットアクセスキーを格納する場合には、環境変数を使用しないことを強くお勧めします。環境変数は、AWS CodeBuild コンソールや AWS CLI などのツールを使用してプレーンテキストで表示できます。

重要な値は Amazon EC2 Systems Manager パラメータストアに保存し、ビルド仕様から取得することをお勧めします。重要な値を保存するには、Amazon EC2 Systems Manager ユーザーガイドの「Systems Manager パラメータストア」および「Systems Manager パラメータストア チュートリアル」を参照してください。重要な値を取得するには、「ビルド仕様の構文」で parameter-store マッピングを参照してください。