Setup steps for HTTPS connections to Amazon CodeCommit repositories on Linux, OS X, or Unix with the Amazon CLI credential helper

To create and configure an IAM user for accessing CodeCommit

1. Create an Amazon Web Services account by going to http://www.amazonaws.cn and choosing Sign Up.

2. Create an IAM user, or use an existing one, in your Amazon Web Services account. Make sure you have an access key ID and a secret access key associated with that IAM user. For more information, see Creating an IAM User in Your Amazon Web Services account.

   Note

   CodeCommit requires Amazon Key Management Service. If you are using an existing IAM user, make sure there are no policies attached to the user that expressly deny the Amazon KMS actions required by CodeCommit. For more information, see Amazon KMS and encryption.

3. Sign in to the Amazon Web Services Management Console and open the IAM console at https://console.amazonaws.cn/iam/.

4. In the IAM console, in the navigation pane, choose Users, and then choose the IAM user you want to configure for CodeCommit access.

5. On the Permissions tab, choose Add Permissions.

6. In Grant permissions, choose Attach existing policies directly.

7. From the list of policies, select AWSCodeCommitPowerUser or another managed policy for CodeCommit access. For more information, see Amazon managed policies for CodeCommit.

   After you have selected the policy you want to attach, choose Next: Review to review the list of policies to attach to the IAM user. If the list is correct, choose Add permissions.

   For more information about CodeCommit managed policies and sharing access to repositories with other groups and users, see Share a repository and Authentication and access control for Amazon CodeCommit.

To install and configure the Amazon CLI

1. On your local machine, download and install the Amazon CLI. This is a prerequisite for interacting with CodeCommit from the command line. We recommend that you install Amazon CLI version 2. It is the most recent major version of the Amazon CLI and supports all of the latest features. It is the only version of the Amazon CLI that supports using a root account, federated access, or temporary credentials with git-remote-codecommit.

   For more information, see Getting Set Up with the Amazon Command Line Interface.

   Note

   CodeCommit works only with Amazon CLI versions 1.7.38 and later. As a best practice, install or upgrade the Amazon CLI to the latest version available. To determine which version of the Amazon CLI you have installed, run the aws --version command.

   To upgrade an older version of the Amazon CLI to the latest version, see Installing the Amazon Command Line Interface.

2. Run this command to verify that the CodeCommit commands for the Amazon CLI are installed.

   aws codecommit help

   This command returns a list of CodeCommit commands.

3. Configure the Amazon CLI with a profile by using the configure command, as follows:.

   aws configure

   When prompted, specify the Amazon access key and Amazon secret access key of the IAM user to use with CodeCommit. Also, be sure to specify the Amazon Web Services Region where the repository exists, such as us-east-2. When prompted for the default output format, specify json. For example, if you are configuring a profile for an IAM user:

   AWS Access Key ID [None]: Type your IAM user Amazon access key ID here, and then press Enter
   AWS Secret Access Key [None]: Type your IAM user Amazon 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

   For more information about creating and configuring profiles to use with the Amazon CLI, see the following:

   • Named Profiles

   • Using an IAM Role in the Amazon CLI

   • Set command

   • Connecting to Amazon CodeCommit repositories with rotating credentials

   To connect to a repository or a resource in another Amazon Web Services Region, you must reconfigure the Amazon CLI with the default Region name. Supported default Region names for CodeCommit include:

   • us-east-2

   • us-east-1

   • eu-west-1

   • us-west-2

   • ap-northeast-1

   • ap-southeast-1

   • ap-southeast-2

   • ap-southeast-3

   • me-central-1

   • eu-central-1

   • ap-northeast-2

   • sa-east-1

   • us-west-1

   • eu-west-2

   • ap-south-1

   • 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

   • il-central-1

   For more information about CodeCommit and Amazon Web Services Region, see Regions and Git connection endpoints. For more information about IAM, access keys, and secret keys, see How Do I Get Credentials? and Managing Access Keys for IAM Users. For more information about the Amazon CLI and profiles, see Named Profiles.

1. From the terminal, use Git to run git config, specifying the use of the Git credential helper with the Amazon credential profile, and enabling the Git credential helper to send the path to repositories:

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

   Tip

   The credential helper uses the default Amazon credential profile or the Amazon EC2 instance role. You can specify a profile to use, such as CodeCommitProfile, if you have created an Amazon credential profile to use with CodeCommit:

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

   If your profile name contains spaces, make sure you enclose the name in quotation marks (").

   You can configure profiles per repository instead of globally by using --local instead of --global.

   The Git credential helper writes the following value to ~/.gitconfig:

   [credential]    
       helper = !aws --profile CodeCommitProfile codecommit credential-helper $@
       UseHttpPath = true

   Important

   If you want to use a different IAM user on the same local machine for CodeCommit, you must run the git config command again and specify a different Amazon credential profile.

2. Run git config --global --edit to verify the preceding value has been written to ~/.gitconfig. If successful, you should see the preceding value (in addition to values that might already exist in the Git global configuration file). To exit, typically you would type :q, and then press Enter.

   If you experience problems after you configure your credential helper, see Troubleshooting.

   Important

   If you are using macOS, use the following steps to ensure the credential helper is configured correctly.

3. If you are using macOS, use HTTPS to connect to a CodeCommit repository. After you connect to a CodeCommit repository with HTTPS for the first time, subsequent access fails after about 15 minutes. The default Git version on macOS uses the Keychain Access utility to store credentials. For security measures, the password generated for access to your CodeCommit repository is temporary, so the credentials stored in the keychain stop working after about 15 minutes. To prevent these expired credentials from being used, you must either:

   • Install a version of Git that does not use the keychain by default.

   • Configure the Keychain Access utility to not provide credentials for CodeCommit repositories.

   1. Open the Keychain Access utility. (You can use Finder to locate it.)

   2. Search for git-codecommit.us-east-2.amazonaws.com. Highlight the row, open the context menu or right-click it, and then choose Get Info.

   3. Choose the Access Control tab.

   4. In Confirm before allowing access, choose git-credential-osxkeychain, and then choose the minus sign to remove it from the list.

      Note

      After you remove git-credential-osxkeychain from the list, you see a pop-up message whenever you run a Git command. Choose Deny to continue. If you find the pop-ups too disruptive, here are some other options:

      • Connect to CodeCommit using SSH instead of HTTPS. For more information, see For SSH connections on Linux, OS X, or Unix.

      • In the Keychain Access utility, on the Access Control tab for git-codecommit.us-east-2.amazonaws.com, choose the Allow all applications to access this item (access to this item is not restricted) option. This prevents the pop-ups, but the credentials eventually expire (on average, in about 15 minutes) and you see a 403 error message. When this happens, you must delete the keychain item to restore functionality.

      • For more information, see Git for macOS: I configured the credential helper successfully, but now I am denied access to my repository (403).

To connect to a CodeCommit repository

1. Open the CodeCommit console at https://console.www.amazonaws.cn/codesuite/codecommit/home.

2. In the region selector, choose the Amazon Web Services Region where the repository was created. Repositories are specific to an Amazon Web Services Region. For more information, see Regions and Git connection endpoints.

3. Find the repository you want to connect to from the list and choose it. Choose Clone URL, and then choose the protocol you want to use when cloning or connecting to the repository. This copies the clone URL.

   • Copy the HTTPS URL if you are using either Git credentials with your IAM user or the credential helper included with the Amazon CLI.

   • Copy the HTTPS (GRC) URL if you are using the git-remote-codecommit command on your local computer.

   • Copy the SSH URL if you are using an SSH public/private key pair with your IAM user.

   Note

   If you see a Welcome page instead of a list of repositories, there are no repositories associated with your Amazon account in the Amazon Web Services Region where you are signed in. To create a repository, see Create an Amazon CodeCommit repository or follow the steps in the Getting started with Git and CodeCommit tutorial.

4. Open a terminal and run the git clone command with the HTTPS URL you copied. For example, to clone a repository named MyDemoRepo to a local repo named my-demo-repo in the China (Beijing) Region:

   git clone https://git-codecommit.cn-north-1.amazonaws.com.cn/v1/repos/MyDemoRepo my-demo-repo