Getting started with CodePipeline
If you are new to CodePipeline, you can follow the tutorials in this guide after following the steps in this chapter to get set up.
The CodePipeline console includes helpful information in a collapsible panel that you can open from
the information icon or any Info link on the page. (
). You can close this panel at any time.
The CodePipeline console also provides a way to quickly search for your resources, such as
repositories, build projects, deployment applications, and pipelines. Choose Go to
resource or press the / key, and then type the name of the resource.
Any matches appear in the list. Searches are case insensitive. You only see resources that you
have permissions to view. For more information, see Viewing resources in the console.
Before you can use AWS CodePipeline for the first time, you must create your AWS account and create your first administrative user.
Topics
Step 1: Create an AWS account and administrative user
Sign up for an AWS account
To get started with AWS, you need an AWS account. For information about creating an AWS account, see Getting started with an AWS account in the AWS Account Management Reference Guide.
Step 2: Apply a managed policy for administrative access to CodePipeline
You must grant permissions to interact with CodePipeline. The quickest way to do this is to apply
the AWSCodePipeline_FullAccess managed policy to the administrative user.
Note
The AWSCodePipeline_FullAccess policy includes permissions that allow the console user to pass an
IAM role to CodePipeline or other AWS services. This allows the service to assume the role and
perform actions on your behalf. When you attach the policy to a user, role, or group, the
iam:PassRole permissions are applied. Make sure the policy is only applied to
trusted users. When users with these permissions use the console to create or edit a
pipeline, the following choices are available:
-
Create a CodePipeline service role or choose an existing one and pass the role to CodePipeline
-
Might choose to create a CloudWatch Events rule for change detection and pass the CloudWatch Events service role to CloudWatch Events
For more information, see Granting a user permissions to pass a role to an AWS service.
Note
The AWSCodePipeline_FullAccess policy provides access to all CodePipeline actions and resources that the
IAM user has access to, as well as all possible actions when creating stages in a
pipeline, such as creating stages that include CodeDeploy, Elastic Beanstalk, or Amazon S3. As a best practice,
you should grant individuals only the permissions they need to perform their duties. For
more information about how to restrict IAM users to a limited set of CodePipeline actions and
resources, see Remove permissions from the CodePipeline service role.
To provide access, add permissions to your users, groups, or roles:
-
Users and groups in AWS IAM Identity Center:
Create a permission set. Follow the instructions in Create a permission set in the AWS IAM Identity Center User Guide.
-
Users managed in IAM through an identity provider:
Create a role for identity federation. Follow the instructions in Create a role for a third-party identity provider (federation) in the IAM User Guide.
-
IAM users:
-
Create a role that your user can assume. Follow the instructions in Create a role for an IAM user in the IAM User Guide.
-
(Not recommended) Attach a policy directly to a user or add a user to a user group. Follow the instructions in Adding permissions to a user (console) in the IAM User Guide.
-
Step 3: Install the AWS CLI
To call CodePipeline commands from the AWS CLI on a local development machine, you must install the AWS CLI. This step is optional if you intend to get started using only the steps in this guide for the CodePipeline console.
To install and configure the AWS CLI
-
On your local machine, download and install the AWS CLI. This will enable you to interact with CodePipeline from the command line. For more information, see Getting Set Up with the AWS Command Line Interface.
Note
CodePipeline works only with AWS CLI versions 1.7.38 and later. To determine which version of the AWS CLI that you may have installed, run the command aws --version. To upgrade an older version of the AWS CLI to the latest version, follow the instructions in Uninstalling the AWS CLI, and then follow the instructions in Installing the AWS Command Line Interface.
-
Configure the AWS CLI with the configure command, as follows:
aws configureWhen prompted, specify the AWS access key and AWS secret access key of the IAM user that you will use with CodePipeline. When prompted for the default region name, specify the region where you will create the pipeline, such as
us-east-2. When prompted for the default output format, specifyjson. 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]:Typeus-east-2here, and then press EnterDefault output format [None]:Typejsonhere, and then press EnterNote
For more information about IAM, access keys, and secret keys, see Managing Access Keys for IAM Users and How Do I Get Credentials?.
For more information about the Regions and endpoints available for CodePipeline, see AWS CodePipeline endpoints and quotas.
Step 4: Open the console for CodePipeline
Sign in to the AWS Management Console and open the CodePipeline console at http://console.aws.amazon.com/codesuite/codepipeline/home
.
Next steps
You have completed the prerequisites. You can begin using CodePipeline. To start working with CodePipeline, see the CodePipeline tutorials.
