ビルドの実行 (AWS CLI)

次のいずれかの方法で start-build コマンドを実行します。

aws codebuild start-build --project-name <project-name>

ビルド入力アーティファクトの最新バージョンとビルドプロジェクトの既存の設定を使用するビルドを実行する場合は、これを使用します。

aws codebuild start-build --generate-cli-skeleton

以前のバージョンのビルド入力アーティファクトを使用してビルドを実行する場合、またはビルド出力アーティファクト、環境変数、ビルド仕様、またはデフォルトのビルドタイムアウト期間の設定をオーバーライドする場合は、これを使用します。

--project-name オプションを指定して start-build コマンドを実行する場合は、<project-name> をビルドプロジェクトの名前に置き換えて、この手順のステップ 6 に進みます。ビルドプロジェクトのリストを表示するには、「ビルドプロジェクト名を表示する」を参照してください。

--idempotency-token オプションを指定して start-build コマンドを実行すると、大文字と小文字を区別する一意の識別子 (トークン) が start-build リクエストに含まれます。このトークンは、 リクエスト後 5 分間有効です。同じトークンで start-build リクエストを繰り返し行い、パラメータを変更すると、CodeBuild はパラメータの不一致エラーを返します。

start-build オプションを指定して --generate-cli-skeleton コマンドを実行すると、出力に JSON 形式のデータが表示されます。start-build.json がインストールされているローカルコンピュータまたはインスタンス上の場所にあるファイル (例: AWS CLI) にデータをコピーします。コピーしたデータを次の形式に変更して、結果を保存します。

{
  "projectName": "projectName",
  "sourceVersion": "sourceVersion",
  "artifactsOverride": {
    "type": "type",
    "location": "location",
    "path": "path",
    "namespaceType": "namespaceType",
    "name": "artifactsOverride-name",
    "packaging": "packaging"
  },
  "buildspecOverride": "buildspecOverride",
  "cacheOverride": {
    "location": "cacheOverride-location",
    "type": "cacheOverride-type"
  },
  "certificateOverride": "certificateOverride",
  "computeTypeOverride": "computeTypeOverride",
  "environmentTypeOverride": "environmentTypeOverride",
  "environmentVariablesOverride": {
    "name": "environmentVariablesOverride-name",
    "value": "environmentVariablesValue",
    "type": "environmentVariablesOverride-type"
  },
  "gitCloneDepthOverride": "gitCloneDepthOverride",
  "imageOverride": "imageOverride",
  "idempotencyToken": "idempotencyToken",
  "insecureSslOverride": "insecureSslOverride",
  "privilegedModeOverride": "privilegedModeOverride",
  "queuedTimeoutInMinutesOverride": "queuedTimeoutInMinutesOverride",
  "reportBuildStatusOverride": "reportBuildStatusOverride",
  "timeoutInMinutesOverride": "timeoutInMinutesOverride",
  "sourceAuthOverride": "sourceAuthOverride",
  "sourceLocationOverride": "sourceLocationOverride",
  "serviceRoleOverride": "serviceRoleOverride",
  "sourceTypeOverride": "sourceTypeOverride"
}

次のプレースホルダーを置き換えます。

AWS アクセスキー ID、AWS シークレットアクセスキー、パスワードなどの機密値を持つ環境変数は、パラメータとして Amazon EC2 Systems Manager Parameter Store に保存することをお勧めします。CodeBuild では、Amazon EC2 Systems Manager パラメータストアに保存されているパラメータは、そのパラメータの名前が /CodeBuild/ (例: /CodeBuild/dockerLoginPassword) で始まる場合にのみ使用できます。CodeBuild コンソールを使用して、Amazon EC2 Systems Manager にパラメータを作成することができます。[Create a parameter (パラメータの作成)] を選択し、手順に従います。(ダイアログボックスでは、[KMS キー] の場合、オプションでアカウントの AWS KMS キーの ARN を指定できます。Amazon EC2 Systems Manager では、このキーを使用して、保存中にパラメータの値を暗号化し、取得中に復号化します。) CodeBuild コンソールを使用してパラメータを作成した場合、コンソールは保存されている /CodeBuild/ パラメータを開始します。ただし、Amazon EC2 Systems Manager パラメータストアコンソールを使用してパラメータを作成する場合、パラメータの名前を /CodeBuild/ で開始する必要があり、[タイプ] を [Secure String (安全な文字列)] に設定する必要があります。詳細については、「Amazon EC2 Systems Manager ユーザーガイド」の「AWS Systems Manager パラメータストア」および「チュートリアル: String パラメータの作成とテスト (コンソール)」を参照してください。

ビルドプロジェクトが Amazon EC2 Systems Manager パラメータストアに保存されているパラメータを参照する場合、ビルドプロジェクトのサービスロールで ssm:GetParameters アクションを許可する必要があります。以前に [アカウントに新しいサービスロールを作成する] を選択している場合、CodeBuild は、このアクションをビルドプロジェクトのデフォルトのサービスロールに自動的に含めます。ただし [Choose an existing service role from your account] を選択した場合は、このアクションをサービスロールに個別に含める必要があります。

既存の環境変数は、設定した環境変数により置き換えられます。たとえば、Docker イメージに my_value の値を持つ MY_VAR という名前の環境変数が既に含まれていて、other_value の値を持つ MY_VAR という名前の環境変数を設定した場合、my_value が other_value に置き換えられます。同様に、Docker イメージに /usr/local/sbin:/usr/local/bin の値を持つ PATH という名前の環境変数が既に含まれていて、$PATH:/usr/share/ant/bin の値を持つ PATH という名前の環境変数を設定した場合、/usr/local/sbin:/usr/local/bin はリテラル値 $PATH:/usr/share/ant/bin に置き換えられます。

CODEBUILD_ で始まる名前の環境変数は設定しないでください。このプレフィックスは内部使用のために予約されています。

同じ名前の環境変数が複数の場所で定義されている場合、環境変数の値は次のように決定されます。

これらのプレースホルダの有効な値の詳細については、「ビルドプロジェクトの作成 (AWS CLI)」を参照してください。ビルドプロジェクトの最新の設定の一覧については、「ビルドプロジェクトの詳細を表示する」を参照してください。

保存したばかりのファイルがあるディレクトリに移動し、start-build コマンドをもう一度実行します。

aws codebuild start-build --cli-input-json file://start-build.json

成功した場合は、「ビルドを実行するには」の手順で説明されているのと同様のデータが出力に表示されます。