Add a Public Key to Your AWS CodeStar User Profile - AWS CodeStar
Manage Your Public Key (Console)Manage Your Public Key (AWS CLI)Connect to Amazon EC2 Instance with Your Private Key

On July 31, 2024, Amazon Web Services (AWS) will discontinue support for creating and viewing AWS CodeStar projects. After July 31, 2024, you will no longer be able to access the AWS CodeStar console or create new projects. However, the AWS resources created by AWS CodeStar, including your source repositories, pipelines, and builds, will be unaffected by this change and will continue to function. AWS CodeStar Connections and AWS CodeStar Notifications will not be impacted by this discontinuation.

 

If you wish to track work, develop code, and build, test, and deploy your applications, Amazon CodeCatalyst provides a streamlined getting started process and additional functionality to manage your software projects. Learn more about functionality and pricing of Amazon CodeCatalyst.

Add a Public Key to Your AWS CodeStar User Profile

You can upload a public SSH key as part of the public-private key pair you create and manage. You use this SSH public-private key pair to access Amazon EC2 instances running Linux. If a project owner has granted you remote access permission, you can access only those instances associated with the project. You can use the AWS CodeStar console or AWS CLI to manage your public key.

Important

An AWS CodeStar project owner can grant project owners, contributors, and viewers SSH access to Amazon EC2 instances for the project, but only the individual (owner, contributor, or viewer) can set the SSH key. To do this, the user must be signed in as the individual owner, contributor, or viewer.

AWS CodeStar does not manage SSH keys for AWS Cloud9 environments.

Manage Your Public Key (Console)

Although you cannot generate a public-private key pair in the console, you can create one locally and then add or manage it as part of your user profile through the AWS CodeStar console.

To manage your public SSH key

  1. From a terminal or Bash emulator window, run the ssh-keygen command to generate an SSH public-private key pair on your local computer. You can generate a key in any format allowed by Amazon EC2. For information about acceptable formats, see Importing Your Own Public Key to Amazon EC2. Ideally, generate a key that is SSH-2 RSA, in OpenSSH format, and contains 2048 bits. The public key is stored in a file with the .pub extension.

  2. Open the AWS CodeStar console at https://console.aws.amazon.com/codestar/.

    Choose a project where you are a team member.

  3. In the navigation pane, choose Team.

  4. On the Team members page, find the name of your IAM user, and then choose Edit.

  5. On the Edit team member page, under Remote access, enable Allow SSH access to project instances.

  6. In the SSH Public Key box, paste the public key, and then choose Edit team member.

    Note

    You can change your public key by deleting the old key in this field and pasting in a new one. You can delete a public key by deleting the contents of this field, and then choosing Edit team member.

    When you change or delete a public key, you are changing your user profile. It is not a per-project change. Because your key is associated with your profile, it changes (or is deleted) in all projects where you have been granted remote access.

    Deleting your public key removes your access to Amazon EC2 instances running Linux in all projects where you were granted remote access. However, it does not close any open SSH sessions using that key. Make sure that you close any open sessions.

Manage Your Public Key (AWS CLI)

You can use the AWS CLI to manage your SSH public key as part of your user profile.

To manage your public key

  1. From a terminal or Bash emulator window, run the ssh-keygen command to generate an SSH public-private key pair on your local computer. You can generate a key in any format allowed by Amazon EC2. For information about acceptable formats, see Importing Your Own Public Key to Amazon EC2. Ideally, generate a key that is SSH-2 RSA, in OpenSSH format, and contains 2048 bits. The public key is stored in a file with the .pub extension.

  2. To add or change your SSH public key in your AWS CodeStar user profile, run the update-user-profile command with the --ssh-public-key parameter. For example:

    aws codestar update-user-profile --user-arn arn:aws:iam:111111111111:user/Jane_Doe --ssh-key-id EXAMPLE1

    This command returns output similar to the following:

    {
	"createdTimestamp":1.491439687681E9,
	"displayName":"Jane Doe",
	"emailAddress":"jane.doe@example.com",
	"lastModifiedTimestamp":1.491442730598E9,
	"sshPublicKey":"EXAMPLE1",
	"userArn":"arn:aws:iam::111111111111:user/Jane_Doe"
}

Connect to Amazon EC2 Instance with Your Private Key

Make sure that you have created an Amazon EC2 key pair. Add your public key to your user profile in AWS CodeStar. To create a key pair, see Step 4: Create an Amazon EC2 Key Pair for AWS CodeStar Projects. To add your public key to your user profile, see the instructions earlier in this topic.

To connect to an Amazon EC2 Linux instance by using your private key

  1. With your project open in the AWS CodeStar console, in the navigation pane, choose Project.

  2. In Project Resources, choose the ARN link in the row where Type is Amazon EC2 and Name starts with instance.

  3. In the Amazon EC2 console, choose Connect.

  4. Follow the instructions in the Connect To Your Instance dialog box.

    For the user name, use ec2-user. If you use the wrong user name, you cannot connect to the instance.

For more information, see the following resources in the Amazon EC2 User Guide for Linux Instances.