Setup Steps for HTTPS Connections to AWS CodeCommit Repositories on Linux, OS X, or Unix
Before you can connect to AWS CodeCommit for the first time, you must complete the initial configuration steps. This topic walks you through the steps to set up your computer and AWS profile, connect to an AWS CodeCommit repository, and clone that repository to your computer, also known as creating a local repo. If you're new to Git, you might also want to review the information in Where Can I Learn More About Git?.
Step 1: Initial Configuration for AWS CodeCommit
Follow these steps to set up an AWS account, create and configure an IAM user, and install the AWS CLI.
To create and configure an IAM user for accessing AWS CodeCommit
Create an AWS account by going to http://aws.amazon.com and choosing Sign Up.
Create an IAM user, or use an existing one, in your AWS 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 AWS Account.
AWS CodeCommit requires AWS 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 AWS KMS actions required by AWS CodeCommit. For more information, see Encryption.
Sign in to the Identity and Access Management (IAM) console at https://console.aws.amazon.com/iam/.
In the IAM console, in the navigation pane, choose Users, and then choose the IAM user you want to configure for AWS CodeCommit access.
On the Permissions tab, in Grant permissions, choose Attach existing policies directly to user.
Select AWSCodeCommitFullAccess from the list of policies, or another managed policy for AWS CodeCommit access. For more information about managed policies for AWS CodeCommit, see Managed Policies for AWS CodeCommit.
If you want to use SSH to connect to AWS CodeCommit, also select the IAMUserSSHKeys and IAMReadOnlyAccess managed policies.
After you have selected the policies you want to attach, choose Next: Review to review the list of policies that will be attached to the IAM user. If the list is correct, choose Add permissions.
To install and configure the AWS CLI
On your local machine, download and install the AWS CLI. This is a prerequisite for interacting with AWS CodeCommit from the command line. For more information, see Getting Set Up with the AWS Command Line Interface.
AWS CodeCommit works only with AWS CLI versions 1.7.38 and later. To determine which version of the AWS CLI you have installed, run the
Run this command to verify the AWS CodeCommit commands for the AWS CLI are installed:
aws codecommit help
This command should return a list of AWS CodeCommit commands.
Configure the AWS CLI with the configure command, as follows:
When prompted, specify the AWS access key and AWS secret access key of the IAM user you will use with AWS CodeCommit. Also, be sure to specify the region where the repository exists, such as
us-east-2. When prompted for the default output format, specify
json. For example:
AWS Access Key ID [None]:
Type your target AWS access key ID here, and then press EnterAWS Secret Access Key [None]:
Type your target AWS secret access key here, and then press EnterDefault region name [None]:
Type a supported region for AWS CodeCommit here, and then press EnterDefault output format [None]:
here, and then press Enter
To connect to a repository or a resource in another region, you must re-configure the AWS CLI with the default region name for that region. Supported default region names for AWS CodeCommit include:
For more information about AWS CodeCommit and regions, 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.
Step 2: Install Git
To work with files, commits, and other information in AWS CodeCommit repositories, you must install Git on your local machine. AWS CodeCommit supports Git versions 1.7.9 and later.
To install Git, we recommend websites such as Git Downloads.
Git is an evolving, regularly updated platform. Occasionally, a feature change might affect the way it works with AWS CodeCommit. If you encounter issues with a specific version of Git and AWS CodeCommit, review the information in Troubleshooting.
Step 3: Set Up the Credential Helper
From the terminal, use Git to run git config, specifying the use of the Git credential helper with the AWS 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
The credential helper will use the default AWS credential profile or the Amazon EC2 instance role. You can specify a profile to use, such as
CodeCommitProfile, if you have created a specific AWS credential profile to use with AWS CodeCommit:
git config --global credential.helper '!aws --profile
CodeCommitProfilecodecommit 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
The Git credential helper writes the following value to
[credential] helper = !aws --profile CodeCommitProfile codecommit credential-helper $@ UseHttpPath = true
If you want to use a different IAM user on the same local machine for AWS CodeCommit, you must run the git config command again and specify a different AWS credential profile.
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 may 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 AWS CodeCommit.
If you are using macOS, use the following steps to ensure the credential helper is configured correctly.
If you are using macOS, use HTTPS to connect to an AWS CodeCommit repository. After you connect to an AWS CodeCommit repository with HTTPS for the first time, subsequent access will fail after about fifteen 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 AWS CodeCommit repository is temporary, so the credentials stored in the keychain will 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 AWS CodeCommit repositories.
Open the Keychain Access utility. (You can use Finder to locate it.)
git-codecommit.us-east-2.amazonaws.com. Highlight the row, open the context menu or right-click it, and then choose Get Info.
Choose the Access Control tab.
In Confirm before allowing access, choose
git-credential-osxkeychain, and then choose the minus sign to remove it from the list.
git-credential-osxkeychainfrom the list, you will see a pop-up dialog whenever you run a Git command. Choose Deny to continue. If you find the pop-ups too disruptive, here are some alternate options:
Connect to AWS 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 will prevent the pop-ups, but the credentials will eventually expire (on average, this takes about 15 minutes) and you will see a 403 error message. When this happens, you must delete the keychain item in order to restore functionality.
Install a version of Git that does not use the keychain by default.
Step 4: Connect to the AWS CodeCommit Console and Clone the Repository
If an administrator has already sent you the name and connection details for the AWS CodeCommit repository, you can skip this step and clone the repository directly.
Open the AWS CodeCommit console at https://console.aws.amazon.com/codecommit.
In the region selector, choose the region where the repository was created. Repositories are specific to an AWS region. For more information, see Regions and Git Connection Endpoints.
Choose the repository you want to connect to from the list. This opens the Code page for that repository.
Copy the HTTPS URL to use when connecting to the repository.
Open a terminal and from the /tmp directory, use the URL to clone the repository with the git clone command. For example, to clone a repository named
MyDemoRepoto a local repo named
my-demo-repoin the US East (Ohio) region:
git clone https://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo my-demo-repo
For more information about how to connect to repositories, see Connect to the AWS CodeCommit Repository by Cloning the Repository.
You have completed the prerequisites. Follow the steps in AWS CodeCommit Tutorial to start using AWS CodeCommit.