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

ビルド環境の環境変数

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

AWS_DEFAULT_REGION

は AWS ビルドが実行中の領域(たとえば、 us-east-1)。この環境変数は、AWS CLI で主に使用されます。

AWS_REGION

は AWS ビルドが実行中の領域(たとえば、 us-east-1)。この環境変数は、AWS SDK で主に使用されます。

CODEBUILD_BATCH_BUILD_IDENTIFIER(IDIDID)

バッチビルド内のビルドの識別子。これは、バッチビルドスペックで指定されます。詳細については、バッチビルド仕様参照 を参照してください。

CODEBUILD_BUILD_ARN コードビルド_ビルド

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

コードビルドビルドID

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

CODEBUILD_BUILD_IMAGE(コードビルドビルド)

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

CODEBUILD_BUILD_数字

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

CODEBUILD_BUILD_SUCCEEDING(建設済み_建設済み_建設中)

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

CODEBUILD_INITIATOR(コードビルド イニシエータ)

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

コードビルドKMSキー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 です。これらのリポジトリの場合、CODEBUILD_RESOLVED_SOURCE_VERSIONDOWNLOAD_SOURCE フェーズ後にのみ使用できます。

  • CodePipeline では、ソースリビジョンは CodePipeline により提供されます。CodePipeline では、CODEBUILD_RESOLVED_SOURCE_VERSION 環境変数が常に使用できるとは限りません。

  • Amazon S3 では、これは当てはまりません。

CODEBUILD_SOURCE_REPO_URL(コード作成ソース_レポ_URL)

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

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

CODEBUILD_SOURCE_VERSION(コードビルドソースバージョン)

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

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

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

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

    注記

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

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

コードビルド_SRC_DIR

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

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

CODEBUILD_START_時間

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

CODEBUILD_WEBHOOK_ACTOR_アカウント_ID

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

CODEBUILD_WEBHOOK_BASE_REF(コードビルドWEBフック_ベース_リファレンス)

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

CODEBUILD_WEBHOOK_EVENT(WEBHOOK_イベント)

: 現在のビルドをトリガーした Webhook イベント。

CODEBUILD_WEBHOOK_PREV_COMMIT(コードビルドWEBHOOK_PREV_COMMIT)

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

CODEBUILD_WEBHOOK_HEAD_REF(コードビルドWEBフックヘッド_参照)

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

CODEBUILD_WEBHOOK_トリガー

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

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

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

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

ホーム

この環境変数は常に /root.

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

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

重要

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

機密値は Amazon EC2 Systems Manager パラメータストアに保存後、ビルド仕様から取得することをお勧めします。センシティブ値を保存するには、以下を参照してください。 システムマネージャパラメータストア および ウォークスルー: 文字列パラメータ(コンソール)の作成とテストAmazon EC2 Systems Manager ユーザーガイド. これらを取得するには、「buildspec の構文」の parameter-store マッピングを参照してください。