AWS CodeCommit 認証情報ヘルパーを使用して Windows で AWS CLI リポジトリへの HTTPS 接続をセットアップする手順 - AWS CodeCommit

AWS CodeCommit 認証情報ヘルパーを使用して Windows で AWS CLI リポジトリへの HTTPS 接続をセットアップする手順

AWS CodeCommit に初めて接続する前に、最初の設定手順を完了する必要があります。ほとんどのユーザーにとっては、これは Git 認証情報を使用した HTTPS ユーザーのセットアップ の手順に従って簡単に行うことができます。ただし、ルートアカウント、フェデレーテッドアクセス、または一時的な認証情報を使用して CodeCommit に接続する場合は、AWS CLI に含まれている認証情報ヘルパーを使用できます。

注記

認証情報ヘルパーは、フェデレーティッドアクセス、ID プロバイダー、または一時的な認証情報を使用して CodeCommit に接続するためにサポートされている方法ですが、git-remote-codecommit ユーティリティをインストールして使用する方法が推奨されます。詳細については、「git-remote-codecommit を使用して AWS CodeCommit への HTTPS 接続をセットアップする手順」を参照してください。

このトピックでは、AWS CLI をインストールし、コンピュータと AWS プロファイルを設定し、CodeCommit リポジトリに接続し、そのリポジトリをコンピュータにクローンする手順 (ローカルリポジトリの作成) について説明します。Git を初めて利用する場合は、 でも情報を確認できますGit の詳細情報

ステップ 1: CodeCommit の初期設定

アマゾン ウェブ サービスアカウントをセットアップし、IAM ユーザーを作成および設定し、AWS CLI をインストールするには、次の手順を実行します。AWS CLI には、CodeCommit リポジトリへの HTTPS 接続を設定する認証情報ヘルパーが組み込まれています。

IAM ユーザーを作成および設定して CodeCommit にアクセスするには

  1. アマゾン ウェブ サービスアカウントを作成するには、http://aws.amazon.com にアクセスし、[Sign Up] (サインアップ) を選択します。

  2. IAM ユーザーを作成するか、アマゾン ウェブ サービスアカウントに関連付けられた既存のユーザーを使用します。アクセスキー ID およびシークレットアクセスキーがその IAM ユーザーに関連付けられていることを確認します。詳細については、アマゾン ウェブ サービスアカウントの IAM ユーザーの作成を参照してください。

    注記

    CodeCommit は が必要ですAWS Key Management Service 既存の IAM ユーザーを使用している場合は、CodeCommit で必要な AWS KMS アクションを明示的に拒否するユーザーにポリシーがアタッチされていないことを確認します。詳細については、「AWS KMS および暗号化」を参照してください。

  3. AWS Management Console にサインインして、IAM コンソール (https://console.aws.amazon.com/iam/) を開きます。

  4. IAM コンソールのナビゲーションペインで、[Users] (ユーザー) を選択し、続いて、CodeCommit へアクセスするために設定する IAM ユーザーを選択します。

  5. [Permissions (アクセス許可)] タブで、[Add Permissions (アクセス許可の追加)] を選択します。

  6. [Grant permissions (アクセス許可の付与)] で、[Attach existing policies directly (既存のポリシーを直接アタッチする)] を選択します。

  7. ポリシーの一覧から、[AWSCodeCommitPowerUser] または CodeCommit アクセスの別の管理ポリシーを選択します。詳細については、「CodeCommit の AWS 管理ポリシー」を参照してください。

    アタッチするポリシーを選択したら、[Next: Review] (次へ: 確認) を選択して、IAM ユーザーにアタッチするポリシーのリストを表示します。リストが正しい場合は、[Add permissions (アクセス許可の追加)] を選択します。

    CodeCommit 管理ポリシーや、その他のグループおよびユーザーを含むリポジトリへのアクセス共有の詳細については、リポジトリの共有 および の認証とアクセスコントロールAWS CodeCommit を参照してください。

AWS CLI をインストールして設定するには

  1. ローカルマシンで、AWS CLI をダウンロードしてインストールします。これは、コマンドラインから CodeCommit とやり取りするための前提条件です。AWS CLI バージョン 2 のインストールが推奨されます。AWS CLI の最新のメジャーバージョンであり、最新の機能をすべてサポートしています。これは、AWS CLI でルートアカウント、フェデレーションアクセス、または一時的な認証情報の使用をサポートする、git-remote-codecommit の唯一のバージョンです。

    詳細については、「AWS コマンドラインインターフェイスの設定」を参照してください。

    注記

    CodeCommit は、AWS CLI バージョン 1.7.38 以降でのみ動作します。ベストプラクティスとして、AWS CLI をインストールするか、利用可能な最新バージョンにアップグレードしてください。インストールした AWS CLI のバージョンを確認するには、aws --version コマンドを実行します。

    以前のバージョンの AWS CLI を最新バージョンにアップグレードするには、「AWS Command Line Interface のインストール」を参照してください。

  2. このコマンドを使用して、AWS CLI の CodeCommit コマンドがインストールされていることを確認します。

    aws codecommit help

    このコマンドは、CodeCommit コマンドのリストを返します。

  3. 次のように AWS CLI コマンドを使用して、プロファイルを使用して configure を設定します。

    aws configure

    プロンプトが表示されたら、CodeCommit で使用する IAM ユーザーの AWS アクセスキーと AWS シークレットアクセスキーを指定します。また、リポジトリが存在する AWS リージョン (us-east-2 など) を指定します。デフォルトの出力形式の入力を求められたら、json を指定します。例えば、IAM ユーザーのプロファイルを設定する場合は、次のようにします。

    AWS Access Key ID [None]: Type your IAM user AWS access key ID here, and then press Enter AWS Secret Access Key [None]: Type your IAM user AWS secret access key here, and then press Enter Default region name [None]: Type a supported region for CodeCommit here, and then press Enter Default output format [None]: Type json here, and then press Enter

    AWS CLI で使用するプロファイルの作成および設定の詳細については、以下を参照してください。

    別の AWS リージョン に存在するリポジトリまたはリソースに接続するには、そのリージョンのデフォルトのリージョン名を使用して AWS CLI を再設定する必要があります。CodeCommit でサポートされるデフォルトのリージョン名は以下のとおりです。

    • us-east-2

    • us-east-1

    • eu-west-1

    • us-west-2

    • ap-northeast-1

    • ap-southeast-1

    • ap-southeast-2

    • eu-central-1

    • ap-northeast-2

    • sa-east-1

    • us-west-1

    • eu-west-2

    • ap-south-1

    • ca-central-1

    • us-gov-west-1

    • us-gov-east-1

    • eu-north-1

    • ap-east-1

    • me-south-1

    • cn-north-1

    • cn-northwest-1

    • eu-south-1

    • ap-northeast-3

    • af-south-1

    CodeCommit および AWS リージョン の詳細については、リージョンと Git 接続エンドポイント を参照してください。IAM、アクセスキー、シークレットキーに関する詳細については、認証情報を取得する方法および IAM ユーザーのアクセスキーの管理を参照してください。AWS CLI とプロファイルの詳細については、「名前付きプロファイル」を参照してください。

ステップ 2: Git をインストールする

CodeCommit リポジトリのファイル、コミット、およびその他の情報を使用するには、ローカルマシンに Git をインストールする必要があります。CodeCommit は Git バージョン 1.7.9 以降をサポートしています。Git バージョン 2.28 は、初期コミットのブランチ名の設定をサポートしています。最新バージョンの Git を使用することをお勧めします。

Git をインストールするには、Git for Windows などのウェブサイトをお勧めします。このリンクを使用して Git をインストールする場合、以下を除くすべてのインストールのデフォルト設定を使用できます。

  • [Adjusting your PATH environment (PATH 環境の調整)] ステップでプロンプトが表示されたら、[Use Git from the Windows Command Prompt (Windows コマンドプロンプトから Git を使用する)] オプションを選択します。

  • (オプション) CodeCommit 用の Git 認証情報を設定するのではなく、AWS CLI に含まれている認証情報ヘルパーで HTTPS を使用する予定の場合は、[Configuring extra options] (追加オプションの設定) ページで、[Enable Git Credential Manager] (Git 認証情報マネージャーを有効化) オプションがオフになっていることを確認します。Git 認証情報マネージャーは、IAM ユーザーが Git 認証情報を設定する場合のみ、CodeCommit と互換性があります。詳細については、「Git 認証情報を使用した HTTPS ユーザーのセットアップ」および「Git for Windows: Git for Windows をインストールしましたが、リポジトリへのアクセスが拒否されます (403)」を参照してください。

注記

Git は、定期的に更新されている、発展中のプラットフォームです。機能の変更により、CodeCommit での動作が影響を受ける場合があります。特定のバージョンの Git と CodeCommit で問題が発生した場合は、 の情報を確認してくださいトラブルシューティング

ステップ 3: 認証情報ヘルパーを設定する

AWS CLI には、CodeCommit で使用できる Git 認証情報ヘルパーが含まれています。Git 認証情報ヘルパーには、AWS 認証情報プロファイルが必要です。このプロファイルには、IAM ユーザーの AWS アクセスキー ID と AWS シークレットアクセスキー (デフォルトの AWS リージョン 名とデフォルトの出力形式) のコピーが保存されています。Git 認証情報ヘルパーはこの情報を使用して CodeCommit で自動的に認証するため、Git を使用して CodeCommit とやり取りするたびにこの情報を入力する必要はありません。

  1. コマンドプロンプトを開き、Git を使って git config を実行し、Git 認証情報ヘルパーが AWS 認証情報プロファイルで Git 認証情報ヘルパーを使用するように指定すると、Git 認証情報ヘルパーがリポジトリにパスを送信できるようになります。

    git config --global credential.helper "!aws codecommit credential-helper $@" git config --global credential.UseHttpPath true

    Git 認証情報ヘルパーは、.gitconfig ファイルに次の情報を書き込みます。

    [credential] helper = !aws codecommit credential-helper $@ UseHttpPath = true
    重要
    • Windows のコマンドラインではなく Bash エミュレーターを使用している場合は、二重引用符ではなく単一引用符を使用する必要があります。

    • 認証情報ヘルパーは、デフォルトの AWS プロファイル、または Amazon EC2 インスタンスロールを使用します。CodeCommitProfile などの AWS 認証情報プロファイルを作成した場合は、次のようにコマンドを変更して代わりに使用できます。

      git config --global credential.helper "!aws codecommit credential-helper --profile CodeCommitProfile $@"

      これにより、.gitconfig ファイルに次のように書き込まれます。

      [credential] helper = !aws codecommit credential-helper --profile=CodeCommitProfile $@ UseHttpPath = true
    • プロファイル名にスペースが含まれる場合は、このコマンドを実行した後、.gitconfig ファイルを編集して単一引用符 (') で囲みます。そうしないと、認証情報ヘルパーは動作しません。

    • Git for Windows のインストールに Git 認証情報マネージャーユーティリティが含まれている場合、最初の数回の接続試行後に 認証情報マネージャーユーティリティに認証情報を提供するかどうかを確認する 403 エラーが表示されます。CodeCommit と互換性がないため、この問題を解決する最も確実な方法は、Git 認証情報マネージャーユーティリティのオプションを使用せずに Git for Windows をアンインストールしてから再インストールすることです。Git 認証情報マネージャーユーティリティを保持する場合は、CodeCommit に接続するときに AWS CodeCommit の認証情報ヘルパーの使用を指定するために .gitconfig ファイルを手動で変更することを含め、CodeCommit を使用する追加の設定ステップを実行する必要があります。認証情報マネージャーユーティリティから格納されている資格情報を削除します (このユーティリティはコントロールパネルにあります)。格納されている認証情報を削除した後、以下を .gitconfig ファイルに追加して保存し、新しいコマンドプロンプトウィンドウから再度接続してみてください。

      [credential "https://git-codecommit.us-east-2.amazonaws.com"] helper = !aws codecommit credential-helper $@ UseHttpPath = true [credential "https://git-codecommit.us-east-1.amazonaws.com"] helper = !aws codecommit credential-helper $@ UseHttpPath = true

      git config または --system の代わりに --global を指定して、--local 設定を再構成する必要がある場合もあります。

    • CodeCommit の同じローカルマシン上の異なる IAM ユーザーを使用する場合は、git config --global の代わりに git config --local を指定し、AWS 認証情報プロファイルごとに設定を実行する必要があります。

  2. git config --global --edit を実行して、前の値がユーザープロファイルの .gitconfig file (デフォルトでは %HOME%\.gitconfig または drive:\Users\UserName\.gitconfig) に書き込まれていることを検証します。成功した場合は (Git グローバルコンフィグレーションファイルにすでに存在する値に加えて) 以前の値が表示されます。終了するには、通常、:q と入力して [Enter] を押します。

ステップ 4: CodeCommit コンソールに接続し、リポジトリのクローンを作成する

管理者から CodeCommit リポジトリの名前と接続の詳細をすでに受け取っている場合は、このステップをスキップしてリポジトリを直接複製できます。

CodeCommit リポジトリに接続するには

  1. https://console.aws.amazon.com/codesuite/codecommit/home で CodeCommit コンソールを開きます。

  2. リージョンセレクタで、リポジトリが作成された AWS リージョン を選択します。リポジトリは、 AWS リージョン に固有のものです。詳細については、「リージョンと Git 接続エンドポイント」を参照してください。

  3. 接続するリポジトリをリストから見つけて選択します。[クローン URL] を選択してから、リポジトリのクローン作成やリポジトリへの接続時に使用するプロトコルを選択します。これにより、クローン URL が複製されます。

    • IAM ユーザー、または AWS CLI に含まれている認証情報ヘルパーで Git 認証情報を使用している場合は、HTTPS URL をコピーします。

    • ローカルコンピュータで git-remote-codecommit コマンドを使用している場合は、HTTPS (GRC) URL をコピーします。

    • IAM ユーザーで SSH パブリック/プライベートキーペアを使用している場合は、SSH URL をコピーします。

    注記

    リポジトリのリストではなく [ようこそ] ページが表示される場合、ログインしている AWS リージョン の AWS アカウントに関連付けられているリポジトリはありません。リポジトリを作成するには、「AWS CodeCommit リポジトリを作成する」を参照するか、「Git と CodeCommit の開始方法」チュートリアルのステップに従います。

  4. コマンドプロンプトを開き、コピーした HTTPS URL で git clone コマンドを実行します。ローカルリポジトリは、そのコマンドを実行したディレクトリのサブディレクトリに作成されます。For example, to clone a repository named MyDemoRepo to a local repo named my-demo-repo in the US East (Ohio) Region:

    git clone https://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo my-demo-repo

    Windows の一部のバージョンでは、ユーザー名とパスワードの入力を求めるポップアップメッセージが表示されることがあります。これは Windows 用の組み込みの認証情報管理システムですが、 の認証情報ヘルパーと互換性がありませんAWS CodeCommit [Cancel] を選択します。

次のステップ

前提条件を完了しました。CodeCommit の開始方法 のステップに従って、CodeCommit の使用を開始してください。