ビルド環境の環境変数 - AWS CodeBuild

ビルド環境の環境変数

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

AWS_DEFAULT_REGION

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

AWS_REGION

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

CODEBUILD_BATCH_BUILD_IDENTIFIER

バッチビルドのビルドの識別子。これは、バッチの buildspec で指定されます。詳細については、「バッチビルド仕様リファレンス」を参照してください。

CODEBUILD_BUILD_ARN

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

CODEBUILD_BUILD_ID

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

CODEBUILD_BUILD_IMAGE

ビルドイメージ識別子 (例: CodeBuild)。aws/codebuild/standard:2.0

CODEBUILD_BUILD_NUMBER

プロジェクトの現在のビルド番号。

CODEBUILD_BUILD_SUCCEEDING

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

CODEBUILD_INITITOR

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

CODEBUILD_KMS_KEY_ID

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

CODEBUILD_LOG_PATH

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

CODEBUILD_RESOLVED_SOURCE_VERSION

ビルドのソースコードのバージョン識別子。コンテンツはソースコードリポジトリによって異なります。

CodeCommit 、GitHub、GitHub Enterprise Server、および Bitbucket

この変数には、コミット ID が含まれます。

CodePipeline

この変数には、CodePipeline により提供されるソースリビジョンが含まれています。

がソースリビジョンを解決できない場合 (ソースがバージョニングが有効になっていない CodePipeline バケットである場合など)、この環境変数は設定されません。Amazon S3

Amazon S3

この変数は設定されていません。

該当する場合は、CODEBUILD_RESOLVED_SOURCE_VERSION 変数は DOWNLOAD_SOURCE フェーズ後にのみ使用できます。

CODEBUILD_SOURCE_REPO_URL

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

セカンダリソースの場合、セカンダリソースリポジトリ URL の環境変数は CODEBUILD_SOURCE_REPO_URL_<sourceIdentifier> です。ここで、<sourceIdentifier> は作成したソース識別子です。

CODEBUILD_SOURCE_VERSION

値の形式は、ソースリポジトリによって異なります。

  • Amazon S3 では、入力アーティファクトに関連付けられたバージョン ID です。

  • CodeCommit では、ビルドするソースコードのバージョンに関連付けられたコミット ID またはブランチ名です。

  • 、GitHub Enterprise Server、および Bitbucket の場合、ビルドするソースコードのバージョンに関連付けられたコミット ID、ブランチ名、またはタグ名です。GitHub

    注記

    Webhook プルリクエストイベントによってトリガーされた GitHub または GitHub Enterprise Server ビルドの場合、pr/pull-request-number です。

セカンダリソースの場合、セカンダリソースバージョンの環境変数は CODEBUILD_SOURCE_VERSION_<sourceIdentifier> です。ここで、<sourceIdentifier> は、作成するソース識別子です。詳細については、「複数の入力ソースと出力アーティファクトのサンプル」を参照してください。

CODEBUILD_SRC_DIR

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

セカンダリソースの場合、セカンダリソースディレクトリパスの環境変数は CODEBUILD_SRC_DIR_<sourceIdentifier> です。ここで、<sourceIdentifier> は、作成したソース識別子です。詳細については、「複数の入力ソースと出力アーティファクトのサンプル」を参照してください。

CODEBUILD_START_TIME

Unix タイムスタンプとして指定されたビルドの開始時間 (ミリ秒単位)。

CODEBUILD_WEBHOOK_ACTOR_ACCOUNT_ID

Webhook イベントをトリガーしたユーザーのアカウント ID。

CODEBUILD_WEBHOOK_BASE_REF

現在のビルドをトリガーする Webhook イベントの基本参照名。プルリクエストでは、ブランチ参照を表します。

CODEBUILD_WEBHOOK_EVENT

現在のビルドをトリガーする Webhook イベント。

CODEBUILD_WEBHOOK_MERGE_COMMIT

ビルドに使用されるマージコミットの識別子。この変数は、Bitbucket プルリクエストがスカッシュ戦略とマージされ、プルリクエストブランチがクローズされたときに設定されます。この場合、元のプルリクエストコミットは存在しなくなったため、この環境変数には、スカッシュされたマージコミットの識別子が含まれています。

CODEBUILD_WEBHOOK_PREV_COMMIT

現在のビルドをトリガーする Webhook プッシュイベントの前の最新のコミットの ID。

CODEBUILD_WEBHOOK_HEAD_REF

現在のビルドをトリガーする Webhook イベントのヘッド参照名。ブランチ参照またはタグ参照を表します。

CODEBUILD_WEBHOOK_TRIGGER

ビルドをトリガーした Webhook イベントを表示します。この変数は、Webhook によってトリガーされるビルドにのみ使用できます。値は、CodeBuild、GitHub Enterprise Server、または Bitbucket によって GitHub に送信されたペイロードから解析されます。値の形式は、ビルドをトリガーしたイベントのタイプによって異なります。

  • プルリクエストによってトリガーされたビルドの場合、pr/pull-request-number です。

  • 新しいブランチを作成するか、ブランチにコミットをプッシュすることでトリガーされたビルドの場合、branch/branch-name です。

  • タグをリポジトリにプッシュすることでトリガーされたビルドの場合、tag/tag-name です。

ホーム

この環境変数は常に /root に設定されています。

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

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

重要

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

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