でソースプロバイダーにアクセスする CodeBuild - AWS CodeBuild
GitHub および GitHub Enterprise Server アクセストークンGitHub OAuth アプリBitbucket アプリのパスワードまたはアクセストークンBitbucket OAuth アプリ

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

でソースプロバイダーにアクセスする CodeBuild

GitHub または GitHub Enterprise Server では、個人用アクセストークンまたは OAuth アプリを使用してソースプロバイダーにアクセスします。Bitbucket では、アクセストークン、アプリパスワード、または OAuth アプリのいずれかを使用して、ソースプロバイダーにアクセスします。

注記

GitLab およびセルフマネージド型の GitLab ソースプロバイダーには、 CodeBuild から直接アクセスされるのではなく、 を通じて直接アクセスされます AWS CodeConnections。

GitHub および GitHub Enterprise Server アクセストークン

アクセストークンの前提条件

開始する前に、 GitHub アクセストークンに適切なアクセス許可スコープを追加する必要があります。

の場合 GitHub、個人用アクセストークンには次のスコープが必要です。

  • repo: プライベートリポジトリのフルコントロールを許可します。

  • repo:status: パブリックおよびプライベートリポジトリのコミットステータスへの読み取り/書き込みアクセスを許可します。

  • admin:repo_hook: リポジトリフックのフルコントロールを許可します。このスコープは、トークンに repo スコープがある場合は必要ありません。

詳細については、 GitHub ウェブサイトの「OAuth アプリのスコープを理解する」を参照してください。

きめ細かな個人用アクセストークンを使用している場合、ユースケースによっては、個人用アクセストークンに次のアクセス許可が必要になる場合があります。

  • コンテンツ: 読み取り専用 : プライベートリポジトリへのアクセスを許可します。このアクセス許可は、プライベートリポジトリをソースとして使用している場合に必要です。

  • コミットステータス: 読み取りおよび書き込み: コミットステータスを作成するアクセス許可を付与します。このアクセス許可は、プロジェクトでウェブフックがセットアップされている場合、またはビルドステータスレポート機能が有効になっている場合に必要です。

  • ウェブフック: 読み取りと書き込み: ウェブフックを管理するアクセス許可を付与します。このアクセス許可は、プロジェクトにウェブフックが設定されている場合に必要です。

  • プルリクエスト: 読み取り専用 : プルリクエストにアクセスするためのアクセス許可を付与します。このアクセス許可は、ウェブフックにプルリクエストイベントに対するFILE_PATHフィルターがある場合に必要です。

  • 管理: 読み取りと書き込み: このアクセス許可は、 でセルフホスト GitHub アクションランナー機能を使用している場合に必要です CodeBuild。詳細については、「リポジトリの登録トークンを作成する」および「」を参照してくださいでセルフホスト GitHub アクションランナーを設定する AWS CodeBuild。

注記

組織リポジトリにアクセスする場合は、アクセストークンのリソース所有者として組織を指定してください。

詳細については、 GitHub ウェブサイトの「きめ細かな個人用アクセストークンに必要なアクセス許可」を参照してください。

アクセストークン GitHub で接続する (コンソール）

コンソールを使用してアクセストークン GitHub を使用してプロジェクトを に接続するには、プロジェクトを作成するときに次の操作を行います。詳細については、「ビルドプロジェクトの作成 (コンソール)」を参照してください。

  1. ソースプロバイダー で、 を選択しますGitHub。

  2. リポジトリ で、 GitHub 個人用アクセストークン で接続 を選択します。

  3. GitHub 個人用アクセストークン に GitHub、個人用アクセストークンを入力します。

  4. [トークンの保存] を選択します。

アクセストークン GitHub で接続する (CLI)

を使用して、アクセストークン GitHub を使用してプロジェクトを AWS CLI に接続するには、次の手順に従います。 AWS CLI で を使用する方法については AWS CodeBuild、「」を参照してくださいコマンドラインリファレンス。

  1. import-source-credentials コマンドを実行します。

    aws codebuild import-source-credentials --generate-cli-skeleton

    JSON 形式のデータが出力に表示されます。 AWS CLI がインストールされているローカルコンピュータまたはインスタンス上の場所にあるファイル ( などimport-source-credentials.json) にデータをコピーします。コピーされたデータを次のように変更して、結果を保存します。

    {
  "serverType": "server-type",
  "authType": "auth-type",
  "shouldOverwrite": "should-overwrite",
  "token": "token",
  "username": "username"
}

    以下に置き換えます。

    • server-type: 必須値。この認証情報に使用されるソースプロバイダー。有効な値は GITHUB あるいは GITHUB_ENTERPRISE です。

    • auth-type: 必須値。 GitHub または GitHub Enterprise Server リポジトリへの接続に使用される認証のタイプ。有効な値は、PERSONAL_ACCESS_TOKEN と BASIC_AUTH です。 CodeBuild API を使用して OAUTH 接続を作成することはできません。代わりに CodeBuild コンソールを使用する必要があります。

    • should-overwrite: オプションの値。リポジトリソースの認証情報が上書きされないようにするには、false に設定します。リポジトリソースの認証情報を上書きするには、true に設定します。デフォルト値は true です。

    • token: 必須値。 GitHub または GitHub Enterprise Server の場合、これは個人用アクセストークンです。

    • username: オプションの値。このパラメータは、 GitHub および GitHub Enterprise Server ソースプロバイダーでは無視されます。

  2. アカウントをアクセストークンに接続するには、ステップ 1 で保存した import-source-credentials.json ファイルが含まれるディレクトリに切り替え、もう一度 import-source-credentials コマンドを実行します。

    aws codebuild import-source-credentials --cli-input-json file://import-source-credentials.json

    JSON 形式のデータが、Amazon リソースネーム (ARN) を持つ出力に表示されます。

    {
  "arn": "arn:aws:codebuild:region:account-id:token/server-type"
}
    注記

    同じサーバータイプと認証タイプを持つ import-source-credentials コマンドを 2 回目に実行した場合、保存されたアクセストークンが更新されます。

    アカウントがアクセストークンに接続されたら、 create-project を使用して CodeBuild プロジェクトを作成できます。詳細については、「ビルドプロジェクトの作成 (AWS CLI)」を参照してください。

  3. 接続されたアクセストークンを表示するには、list-source-credentials コマンドを実行します。

    aws codebuild list-source-credentials

    JSON 形式 sourceCredentialsInfos オブジェクトが出力に表示されます。

    {
    "sourceCredentialsInfos": [
        {
            "authType": "auth-type",
            "serverType": "server-type", 
            "arn": "arn"
        }
    ]
}

    sourceCredentialsObject には、接続されたソース認証情報のリストが含まれています。

    • authType は、認証情報により使用される認証のタイプです。これは、OAUTH、BASIC_AUTH、または PERSONAL_ACCESS_TOKEN です。

    • serverType は、ソースプロバイダーのタイプです。これは、GITHUB、GITHUB_ENTERPRISE、または BITBUCKET です。

    • arn は、トークンの ARN です。

  4. ソースプロバイダーから切断してそのアクセストークンを削除するには、その ARN を使用して delete-source-credentials コマンドを実行します。

    aws codebuild delete-source-credentials --arn arn-of-your-credentials

    削除された認証情報の ARN とともに JSON 形式のデータが返されます。

    {
  "arn": "arn:aws:codebuild:region:account-id:token/server-type"
}

GitHub OAuth アプリ

OAuth GitHub を使用して接続する (コンソール）

コンソールを使用して OAuth アプリ GitHub を使用してプロジェクトを に接続するには、プロジェクトを作成するときに次の操作を行います。詳細については、「ビルドプロジェクトの作成 (コンソール)」を参照してください。

  1. ソースプロバイダー で、 を選択しますGitHub。

  2. リポジトリ で、OAuth を使用して接続 を選択します。

  3. への接続 GitHub、ログイン、アカウントの承認を選択します。

  4. 確認 を選択して GitHub アカウント CodeBuild に接続します。

  5. GitHub リポジトリ に GitHubリポジトリリンクを入力します。

認可された OAuth アプリケーションを確認するには、 のアプリケーションに移動し GitHub、aws-code Suite AWS CodeBuild (region)が所有する という名前のアプリケーションがリストされていることを確認します。

Bitbucket アプリのパスワードまたはアクセストークン

前提条件

開始する前に、Bitbucket アプリのパスワードまたはアクセストークンに適切なアクセス許可スコープを追加する必要があります。

Bitbucket の場合、アプリパスワードまたはアクセストークンには次のスコープが必要です。

  • repository:read: 承認側ユーザーがアクセスできるすべてのリポジトリへの読み取りアクセスを許可します。

  • pullrequest:read: プルリクエストの読み取りアクセスを許可します。プロジェクトに Bitbucket ウェブフックがある場合、アプリパスワードまたはアクセストークンにはこのスコープが必要です。

  • webhook: Webhook へのアクセスを許可します。プロジェクトにウェブフックオペレーションがある場合、アプリパスワードまたはアクセストークンにはこのスコープが必要です。

詳細については、Bitbucket ウェブサイトの「Scopes for Bitbucket Cloud REST API」と「OAuth on Bitbucket Cloud」を参照してください。

アプリケーションパスワードで Bitbucket へ接続する（コンソール）

コンソールを使用し、アクセストークンを使用してプロジェクトを Bitbucket に接続するには、プロジェクトを作成するときに以下の操作を実行します。詳細については、ビルドプロジェクトの作成 (コンソール) を参照してください。

  1. [ソースプロバイダー] で、[Bitbucket] を選択します。

    注記

    CodeBuild は Bitbucket サーバーをサポートしていません。

  2. [リポジトリ] で、[Connect with a Bitbucket app password (Bitbucket アプリパスワードで接続する)] を選択します。

  3. [Bitbucket username (Bitbucket ユーザー名)] に、Bitbucket ユーザー名を入力します。

  4. [Bitbucket app password (Bitbucket のアプリパスワード)] に、Bitbucket アプリパスワードを入力します。

  5. [Save Bitbucket credentials (Bitbucket 認証情報の保存)] を選択します。

Bitbucket をアクセストークンに接続する (コンソール）

コンソールを使用してアクセストークンを使用してプロジェクトを Bitbucket に接続するには、プロジェクトを作成するときに次の操作を行います。詳細については、ビルドプロジェクトの作成 (コンソール) を参照してください。

  1. [ソースプロバイダー] で、[Bitbucket] を選択します。

    注記

    CodeBuild は Bitbucket サーバーをサポートしていません。

  2. リポジトリ で、Bitbucket アクセストークン で接続 を選択します。

  3. Bitbucket アクセストークン で、Bitbucket アクセストークンを入力します。

  4. [トークンの保存] を選択します。

Bitbucket をアプリパスワードまたはアクセストークンに接続する (CLI)

を使用して、アプリパスワードまたはアクセストークンを使用してプロジェクトを Bitbucket AWS CLI に接続するには、次の手順に従います。 AWS CLI で を使用する方法については AWS CodeBuild、「」を参照してくださいコマンドラインリファレンス。

  1. import-source-credentials コマンドを実行します。

    aws codebuild import-source-credentials --generate-cli-skeleton

    JSON 形式のデータが出力に表示されます。 AWS CLI がインストールされているローカルコンピュータまたはインスタンス上の場所にあるファイル ( などimport-source-credentials.json) にデータをコピーします。コピーされたデータを次のように変更して、結果を保存します。

    {
  "serverType": "BITBUCKET",
  "authType": "auth-type",
  "shouldOverwrite": "should-overwrite",
  "token": "token",
  "username": "username"
}

    以下に置き換えます。

    • auth-type: 必須値。Bitbucket リポジトリに接続するために使用される認証のタイプ。有効な値は、PERSONAL_ACCESS_TOKEN と BASIC_AUTH です。 CodeBuild API を使用して OAUTH 接続を作成することはできません。代わりに CodeBuild コンソールを使用する必要があります。

    • should-overwrite: オプションの値。リポジトリソースの認証情報が上書きされないようにするには、false に設定します。リポジトリソースの認証情報を上書きするには、true に設定します。デフォルト値は true です。

    • token: 必須値。Bitbucket の場合、これはアクセストークンまたはアプリパスワードのいずれかです。

    • username: オプションの値。authType が BASIC_AUTH の場合の Bitbucket ユーザー名。その他のタイプのソースプロバイダーまたは接続では、このパラメータは無視されます。

  2. アカウントをアプリパスワードまたはアクセストークンに接続するには、ステップ 1 で保存したimport-source-credentials.jsonファイルを含むディレクトリに切り替えて、 import-source-credentials コマンドを再度実行します。

    aws codebuild import-source-credentials --cli-input-json file://import-source-credentials.json

    JSON 形式のデータが、Amazon リソースネーム (ARN) を持つ出力に表示されます。

    {
  "arn": "arn:aws:codebuild:region:account-id:token/server-type"
}
    注記

    同じサーバータイプと認証タイプを持つ import-source-credentials コマンドを 2 回目に実行した場合、保存されたアクセストークンが更新されます。

    アカウントがアプリパスワードに接続されたら、 create-project を使用して CodeBuild プロジェクトを作成できます。詳細については、「ビルドプロジェクトの作成 (AWS CLI)」を参照してください。

  3. 接続されているアプリのパスワードまたはアクセストークンを表示するには、 list-source-credentials コマンドを実行します。

    aws codebuild list-source-credentials

    JSON 形式 sourceCredentialsInfos オブジェクトが出力に表示されます。

    {
    "sourceCredentialsInfos": [
        {
            "authType": "auth-type",
            "serverType": "BITBUCKET", 
            "arn": "arn"
        }
    ]
}

    sourceCredentialsObject には、接続されたソース認証情報のリストが含まれています。

    • authType は、認証情報により使用される認証のタイプです。これは、OAUTH、BASIC_AUTH、または PERSONAL_ACCESS_TOKEN です。

    • arn は、トークンの ARN です。

  4. ソースプロバイダーから切断し、アプリパスワードまたはアクセストークンを削除するには、その ARN を指定して delete-source-credentials コマンドを実行します。

    aws codebuild delete-source-credentials --arn arn-of-your-credentials

    削除された認証情報の ARN とともに JSON 形式のデータが返されます。

    {
  "arn": "arn:aws:codebuild:region:account-id:token/server-type"
}

Bitbucket OAuth アプリ

OAuth を使用して Bitbucket を接続する (コンソール）

コンソールを使用して OAuth アプリを使用してプロジェクトを Bitbucket に接続するには、プロジェクトを作成するときに次の操作を行います。詳細については、ビルドプロジェクトの作成 (コンソール) を参照してください。

  1. [ソースプロバイダー] で、[Bitbucket] を選択します。

  2. リポジトリ で、OAuth を使用して接続 を選択します。

  3. 「Bitbucket への接続」、「ログイン」、「 アカウントの承認」を選択します。

  4. 確認 を選択して Bitbucket アカウント CodeBuild に接続します。

  5. Bitbucket リポジトリ に、Bitbucket リポジトリリンクを入力します。

認可された OAuth アプリを確認するには、Bitbucket のアプリケーション認可に移動し、 という名前のアプリケーションAWS CodeBuild (region)がリストされていることを確認します。