ビルドプロジェクトの作成 (AWS CLI)

AWS CLI でを使用する方法の詳細については CodeBuild、「」を参照してくださいコマンドラインリファレンス。

を使用して CodeBuild ビルドプロジェクトを作成するには AWS CLI、JSON 形式のプロジェクト構造を作成し、構造を入力し、 create-project コマンドを呼び出してプロジェクトを作成します。

JSON ファイルの作成

--generate-cli-skeleton オプションを使用して、create-project コマンドでスケルトン JSON ファイルを作成します。


aws codebuild create-project --generate-cli-skeleton > <json-file>

これにより、<json-file> で指定されるパスとファイル名で JSON ファイルが作成されます。

JSON ファイルを入力します。

JSON データを次のように変更して、結果を保存します。


{
  "name": "<project-name>",
  "description": "<description>",
  "source": {
    "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "GITLAB" | "GITLAB_SELF_MANAGED" | "BITBUCKET" | "S3" | "NO_SOURCE",
    "location": "<source-location>",
    "gitCloneDepth": "<git-clone-depth>",
    "buildspec": "<buildspec>",
    "InsecureSsl": "<insecure-ssl>",
    "reportBuildStatus": "<report-build-status>",
    "buildStatusConfig": {
      "context": "<context>",
      "targetUrl": "<target-url>"
    },
    "gitSubmodulesConfig": {
      "fetchSubmodules": "<fetch-submodules>"
    },
    "auth": {
      "type": "<auth-type>",
      "resource": "<auth-resource>"
    },
    "sourceIdentifier": "<source-identifier>"
  },
  "secondarySources": [
    {
        "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "GITLAB" | "GITLAB_SELF_MANAGED" | "BITBUCKET" | "S3" | "NO_SOURCE",
        "location": "<source-location>",
        "gitCloneDepth": "<git-clone-depth>",
        "buildspec": "<buildspec>",
        "InsecureSsl": "<insecure-ssl>",
        "reportBuildStatus": "<report-build-status>",
        "auth": {
          "type": "<auth-type>",
          "resource": "<auth-resource>"
        },
        "sourceIdentifier": "<source-identifier>"
    }
  ],
  "secondarySourceVersions": [
    {
      "sourceIdentifier": "<secondary-source-identifier>",
      "sourceVersion": "<secondary-source-version>"
    }
  ],
  "sourceVersion": "<source-version>",
  "artifacts": {
    "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS",
    "location": "<artifacts-location>",
    "path": "<artifacts-path>",
    "namespaceType": "<artifacts-namespacetype>",
    "name": "<artifacts-name>",
    "overrideArtifactName": "<override-artifact-name>",
    "packaging": "<artifacts-packaging>"
  },
  "secondaryArtifacts": [
    {
      "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS",
      "location": "<secondary-artifact-location>",
      "path": "<secondary-artifact-path>",
      "namespaceType": "<secondary-artifact-namespaceType>",
      "name": "<secondary-artifact-name>",
      "packaging": "<secondary-artifact-packaging>",
      "artifactIdentifier": "<secondary-artifact-identifier>"
    }
  ],
  "cache": {
    "type": "<cache-type>",
    "location": "<cache-location>",
    "mode": [
      "<cache-mode>"
    ]
  },
  "environment": {
    "type": "LINUX_CONTAINER" | "LINUX_GPU_CONTAINER" | "ARM_CONTAINER" | "WINDOWS_SERVER_2019_CONTAINER" | "WINDOWS_SERVER_2022_CONTAINER",
    "image": "<image>",
    "computeType": "BUILD_GENERAL1_SMALL" | "BUILD_GENERAL1_MEDIUM" | "BUILD_GENERAL1_LARGE" | "BUILD_GENERAL1_2XLARGE",
    "certificate": "<certificate>",
    "environmentVariables": [
      {
        "name": "<environmentVariable-name>",
        "value": "<environmentVariable-value>",
        "type": "<environmentVariable-type>"
      }
    ],
    "registryCredential": [
      {
        "credential": "<credential-arn-or-name>",
        "credentialProvider": "<credential-provider>"
      }
    ],
    "imagePullCredentialsType": "CODEBUILD" | "SERVICE_ROLE",
    "privilegedMode": "<privileged-mode>"
  },
  "serviceRole": "<service-role>",
  "timeoutInMinutes": <timeout>,
  "queuedTimeoutInMinutes": <queued-timeout>,
  "encryptionKey": "<encryption-key>",
  "tags": [
    {
      "key": "<tag-key>",
      "value": "<tag-value>"
    }
  ],
  "vpcConfig": {
    "securityGroupIds": [
         "<security-group-id>"
    ],
    "subnets": [
         "<subnet-id>"
    ],
    "vpcId": "<vpc-id>"
  },
  "badgeEnabled": "<badge-enabled>",
  "logsConfig": {
    "cloudWatchLogs": {
      "status": "<cloudwatch-logs-status>",
      "groupName": "<group-name>",
      "streamName": "<stream-name>"
    },
    "s3Logs": {
      "status": "<s3-logs-status>",
      "location": "<s3-logs-location>",
      "encryptionDisabled": "<s3-logs-encryption-disabled>"
    }
  },
  "fileSystemLocations": [
    {
      "type": "EFS",
      "location": "<EFS-DNS-name-1>:/<directory-path>",
      "mountPoint": "<mount-point>",
      "identifier": "<efs-identifier>",
      "mountOptions": "<efs-mount-options>"
    }
  ],
  "buildBatchConfig": {
    "serviceRole": "<batch-service-role>",
    "combineArtifacts": <combine-artifacts>,
    "restrictions": {
      "maximumBuildsAllowed": <max-builds>,
      "computeTypesAllowed": [
        "<compute-type>"
      ]
    },
    "timeoutInMins": <batch-timeout>,
    "batchReportMode": "REPORT_AGGREGATED_BATCH" | "REPORT_INDIVIDUAL_BUILDS"
  },
  "concurrentBuildLimit": <concurrent-build-limit>
}

以下に置き換えます。

name

必須。このビルドプロジェクトの名前。この名前は、 AWS アカウント内のすべてのビルドプロジェクトで一意である必要があります。

[ Description] ( 説明)

オプション。このビルドの説明。

source

必須。このビルドプロジェクトのソースコード設定に関する情報を含む ProjectSource オブジェクト。source オブジェクトを追加したら、secondarySources を使用して最大 12 個のソースを追加できます。これらの設定には以下が含まれます。

source/type

必須。ビルドするソースコードを含むリポジトリのタイプ。有効な値を次に示します。

CODECOMMIT
CODEPIPELINE
GITHUB
GITHUB_ENTERPRISE
GITLAB
GITLAB_SELF_MANAGED
BITBUCKET
S3
NO_SOURCE

NO_SOURCE を使用すると、プロジェクトにはソースがないため、buildspec をファイルとして使用できません。代わりに、buildspec 属性を使用して buildspec に YAML 形式の文字列を指定する必要があります。詳細については、「ソースサンプルがないプロジェクト」を参照してください。

source/location

<source-type> を CODEPIPELINE に設定しない場合は必須です。指定されたリポジトリタイプのソースコードの場所。

の場合 CodeCommit、ソースコードと buildspec ファイルを含むリポジトリへの HTTPS クローン URL (例: https://git-codecommit.<region-id>.amazonaws.com/v1/repos/<repo-name>）。
Amazon S3 では、ビルド入力バケット名の後に、ソースコードと buildspec を含む ZIP ファイルのパスと名前が続きます。次に例を示します。
- 入力バケットのルートにある ZIP ファイルの場合:　<bucket-name>/<object-name>.zip。
- 入力バケットのサブフォルダーにある ZIP ファイルの場合: <bucket-name>/<subfoler-path>/<object-name>.zip。
の場合 GitHub、ソースコードと buildspec ファイルを含むリポジトリへの HTTPS クローン URL。URL には github.com が含まれている必要があります。 AWS アカウントを GitHub アカウントに接続する必要があります。これを行うには、 CodeBuild コンソールを使用してビルドプロジェクトを作成します。
- [Authorize application] を選択します。( GitHub アカウントに接続したら、ビルドプロジェクトの作成を完了する必要はありません。 CodeBuild コンソールを閉じることができます）。
GitHub Enterprise Server の場合、ソースコードと buildspec ファイルを含むリポジトリへの HTTP または HTTPS クローン URL。また、 AWS アカウントを GitHub Enterprise Server アカウントに接続する必要があります。これを行うには、 CodeBuild コンソールを使用してビルドプロジェクトを作成します。
1. GitHub Enterprise Server で個人用アクセストークンを作成します。
2. このトークンをクリップボードにコピーして、 CodeBuild プロジェクトの作成時に使用できます。詳細については、ヘルプウェブサイトの「コマンドライン用の個人用アクセストークンの作成」を参照してください。 GitHub
3. コンソールを使用して CodeBuild プロジェクトを作成する場合は、ソース でソースプロバイダー にGitHubエンタープライズ を選択します。
4. [個人用アクセストークン] には、クリップボードにコピーしたトークンを貼り付けます。[トークンの保存] を選択します。これで、 CodeBuild アカウントが GitHub Enterprise Server アカウントに接続されました。
GitLab および GitLab セルフマネージド型の場合、ソースコードと buildspec ファイルを含むリポジトリへの HTTPS クローン URL。を使用する場合 GitLab、URL には gitlab.com が含まれている必要があります。 GitLab セルフマネージドを使用する場合、URL に gitlab.com を含める必要はありません。 AWS アカウントをまたは GitLab 自己管理型 GitLabアカウントに接続する必要があります。これを行うには、 CodeBuildコンソールを使用してビルドプロジェクトを作成します。
- デベロッパーツールナビゲーションペインで、設定、接続を選択し、接続を作成します。このページで、 GitLab または GitLab セルフマネージド型の接続を作成し、Connect to GitLabを選択します。
Bitbucket の場合は、ソースコードと buildspec ファイルが格納されているリポジトリへの HTTPS クローン URL。URL には bitbucket.org が含まれている必要があります。また、 AWS アカウントを Bitbucket アカウントに接続する必要があります。これを行うには、 CodeBuild コンソールを使用してビルドプロジェクトを作成します。
1. コンソールを使用して Bitbucket に接続 (または再接続) する場合は、Bitbucket の [Confirm access to your account] ページで、[Grant access] を選択します (Bitbucket アカウントに接続したら、ビルドプロジェクトの作成を完了する必要はありません。 CodeBuild コンソールを閉じることができます）。
では AWS CodePipeline、 locationの値を指定しないでくださいsource。 CodePipeline でパイプラインを作成するときは CodePipeline、パイプラインのソースステージでソースコードの場所を指定するためです。

ソース/gitCloneDepth

オプション。ダウンロードする履歴の深さ。最小値は 0 です。この値が 0、あるいは 25 より大きいか指定されていない場合、完全な履歴が各ビルドプロジェクトと共にダウンロードされます。ソースタイプが Amazon S3 である場合、この値はサポートされません。

source/buildspec

オプション。使用するビルド仕様定義またはファイル。この値が指定されていない場合や、空の文字列に設定されている場合、ソースコードのルートディレクトリに buildspec.yml ファイルが含まれている必要があります。この値が設定されている場合は、インラインのビルド仕様定義か、プライマリソースのルートディレクトリからの相対的な代替 buildspec ファイルへのパス、S3 バケットへのパスになります。バケットは、ビルドプロジェクトと同じ AWS リージョンに存在する必要があります。ARN を使用して buildspec ファイルを指定します（例: arn:aws:s3:::<my-codebuild-sample2>/buildspec.yml）。詳細については、「buildspec ファイル名とストレージの場所」を参照してください。

source/auth

使用しません。このオブジェクトは CodeBuild コンソールでのみ使用されます。

ソース/reportBuildStatus

ビルドの開始と完了のステータスをソースプロバイダーに送信するかどうかを指定します。これを GitHub、 GitHub Enterprise Server、または Bitbucket 以外のソースプロバイダーで設定すると、 invalidInputExceptionがスローされます。

ソースプロバイダにビルド状態を報告できるようにするには、ソースプロバイダに関連付けられたユーザーがリポジトリへの書き込みアクセス権を持っている必要があります。ユーザーが書き込みアクセス権を持っていない場合、ビルドのステータスは更新できません。詳細については、「ソースプロバイダーのアクセス」を参照してください。

ソース/buildStatusConfig

CodeBuild ビルドプロジェクトがソースプロバイダーにビルドステータスを報告する方法を定義する情報が含まれています。このオプションは、ソースタイプが GITHUB、GITHUB_ENTERPRISE、または BITBUCKET の場合にのみ使用されます。

source/buildStatusConfig/context

Bitbucket リソースでは、このパラメータは、Bitbucket コミットステータスの name パラメータに使用されます。 GitHub ソースの場合、このパラメータは GitHub コミットステータスの contextパラメータに使用されます。

例えば、に環境変数を使用して CodeBuildビルド番号とウェブフックトリガーcontextを含めることができます。


AWS CodeBuild sample-project Build #$CODEBUILD_BUILD_NUMBER - $CODEBUILD_WEBHOOK_TRIGGER

これにより、webhook プルリクエストイベントによってトリガーされた build #24 では、コンテキストは次のようになります。


AWS CodeBuild sample-project Build #24 - pr/8

source/buildStatusConfig/targetUrl

Bitbucket リソースでは、このパラメータは、Bitbucket コミットステータスの url パラメータに使用されます。 GitHub ソースの場合、このパラメータは GitHub コミットステータスの target_urlパラメータに使用されます。

たとえば、「targetUrl」と「https://aws.amazon.com/codebuild/<path to build>」とコミットステータスをこのURLにリンクします。

に CodeBuild 環境変数を含めてtargetUrl、URL に情報を追加することもできます。例えば、ビルド領域を URL に追加するには、targetUrl を以下に設定します:


"targetUrl": "https://aws.amazon.com/codebuild/<path to build>?region=$AWS_REGION"

ビルド領域が us-east-2 の場合、これは次のように展開されます。


https://aws.amazon.com/codebuild/<path to build>?region=us-east-2

ソース/gitSubmodulesConfig

オプション。Git サブモジュール設定に関する情報。 CodeCommit、 GitHub Enterprise Server GitHub、Bitbucket でのみ使用されます。

source/gitSubmodulesConfig/fetchSubmodules: リポジトリに Git サブモジュールを含める場合は、fetchSubmodules を true に設定します。含まれている Git サブモジュールは HTTPS として設定する必要があります。

ソース/InsecureSsl

オプション。 GitHub Enterprise Server でのみ使用されます。Enterprise Server プロジェクトリポジトリへの接続中に TLS 警告を無視trueするには、この値を GitHub に設定します。デフォルト値は false です。InsecureSsl は、テスト目的でのみ使用してください。本番環境では使用しないでください。

source/sourceIdentifier

プロジェクトソースのユーザー定義識別子。プライマリソースの場合、省略可能です。セカンダリソースでは必須です。

secondarySources

オプション。ビルドプロジェクトのセカンダリソースに関する情報を含む ProjectSource オブジェクトの配列。最大 12 個のセカンダリソースを追加できます。secondarySources オブジェクトは、source オブジェクトで使用されるのと同じプロパティを使用します。セカンダリソースオブジェクトでは、sourceIdentifier は必須です。

secondarySourceVersions

オプション。ProjectSourceVersion オブジェクトの配列。secondarySourceVersions をビルドレベルで指定すると、これよりも優先されます。

sourceVersion

オプション。このプロジェクト用に構築するビルド入力のバージョン。指定しない場合、最新のバージョンが使用されます。指定した場合、次のいずれかであることが必要です。

の場合 CodeCommit、使用するコミット ID、ブランチ、または Git タグ。
の場合 GitHub、ビルドするソースコードのバージョンに対応するコミット ID、プルリクエスト ID、ブランチ名、またはタグ名。プルリクエスト ID を指定する場合、pr/pull-request-ID (例: pr/25) 形式を使用する必要があります。ブランチ名を指定すると、ブランチの HEAD コミット ID が使用されます。指定しない場合は、デフォルトブランチの HEAD コミット ID が使用されます。
の場合 GitLab、コミット ID、プルリクエスト ID、ブランチ名、タグ名、またはリファレンスとコミット ID。詳細については、「のソースバージョンサンプル AWS CodeBuild」を参照してください。
Bitbucket の場合、ビルドするソースコードのバージョンに対応するコミット ID、ブランチ名、またはタグ名。ブランチ名を指定すると、ブランチの HEAD コミット ID が使用されます。指定しない場合は、デフォルトブランチの HEAD コミット ID が使用されます。
Amazon S3 の場合、使用するビルド入力 ZIP ファイルを表すオブジェクトのバージョン ID。

sourceVersion をビルドレベルで指定した場合、そのバージョンはこの (プロジェクトレベルの) sourceVersion より優先されます。詳細については、「のソースバージョンサンプル AWS CodeBuild」を参照してください。

artifacts

必須。このビルドプロジェクトの出力アーティファクト設定に関する情報を含む ProjectArtifacts オブジェクト。artifacts オブジェクトを追加したら、secondaryArtifacts を使用して最大 12 個のアーティファクトを追加できます。これらの設定には以下が含まれます。

artifacts/type

必須。ビルド出力アーティファクトのタイプ。有効な値は次のとおりです。

CODEPIPELINE
NO_ARTIFACTS
S3

artifacts/location