AWS CodeBuild - User Guide

1 AWS CodeBuildUser GuideAPI Version 2016-10-06 AWS CodeBuild user GuideAWS CodeBuild : user GuideCopyright 2018 Amazon Web Services, Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored CodeBuild user GuideTable of ContentsWhat Is AWS CodeBuild ? .. 1 How to Run AWS CodeBuild .. 1 Pricing for AWS CodeBuild .

2 2 How Do I Get Started with AWS CodeBuild ? .. 2 Concepts .. 2 How AWS CodeBuild Works .. 3 Next Steps .. 3 Getting Started .. 4 Step 1: Create or Use Amazon S3 Buckets to Store the Build Input and Output .. 4 Step 2: Create the Source Code to Build .. 5 Step 3: Create the Build Spec .. 6 Step 4: Add the Source Code and the Build Spec to the Input Bucket .. 8 Step 5: Create the Build Project .. 9 Step 6: Run the Build.. 12 Step 7: View Summarized Build Information .. 14To view summarized build information (console) .. 14To view summarized build information (AWS CLI) .. 14 Step 8: View Detailed Build Information.

3 16 Step 9: Get the Build Output Artifact .. 18 Step 10: Clean Up.. 18 Next Steps .. 19 Samples.. 20 Windows Samples .. 21 Running the Samples.. 22 Directory Structure .. 23 Files.. 23 Use Case-Based Samples.. 39 Amazon ECR Sample .. 40 Docker Sample .. 42 GitHub Enterprise Sample.. 48 GitHub Pull Request Sample .. 53 Bitbucket Pull Request Sample .. 55 Use AWS Config with AWS CodeBuild Sample .. 58 Build Badges Sample.. 59 Build Notifications Sample.. 62 Docker in Custom Image Sample .. 79 Multiple Input Sources and Output Artifacts Sample .. 81 AWS CodePipeline Integration with AWS CodeBuild and Multiple Input Sources and OutputArtifacts Sample.

4 84 Using Semantic Versioning to Name Build Artifacts Sample .. 86 Host Build Output in an Amazon S3 Bucket .. 88 AWS CodeDeploy Sample .. 89 AWS Lambda Sample .. 92 Elastic Beanstalk Sample.. 93 Code-Based Samples.. 100C++ Sample.. 100Go Sample.. 102 Maven Sample .. Sample.. 107 Python Sample .. 109 Ruby Sample .. Core in Linux Sample .. 113 Plan a Build.. 116 Build Spec Reference .. 117 API Version 2016-10-06iiiAWS CodeBuild user GuideBuild Spec File Name and Storage Location.. 117 Build Spec Syntax .. 118 Build Spec Example.. 124 Build Spec Versions .. 126 Build Environment Reference .. 126 Docker Images Provided by AWS CodeBuild .

5 127 Build Environment Compute Types .. 132 Shells and Commands in Build Environments .. 133 Environment Variables in Build Environments .. 134 Background Tasks in Build Environments .. 135 Test and Debug Locally .. 136 Test and Debug on a Local Machine with the AWS CodeBuild Agent .. 136 Receive Notifications for New AWS CodeBuild Agent Versions .. 136 Run AWS CodeBuild Directly .. 138 Prerequisites .. 138 Run AWS CodeBuild Directly (Console) .. 138 Run AWS CodeBuild Directly (AWS CLI) .. 138 VPC Support .. 139 Use Cases.. 139 Enabling Amazon VPC Access in Your AWS CodeBuild Projects .. 139 Best Practices for VPCs.

6 140 Troubleshooting Your VPC Setup .. 141 Use VPC Endpoints.. 141 Before You Create VPC Endpoints .. 141 Creating VPC Endpoints for AWS CodeBuild .. 142 CloudFormation VPC Template .. 142 Use AWS CodePipeline with AWS CodeBuild .. 151 Prerequisites .. 152 Create a Pipeline that Uses AWS CodeBuild (AWS CodePipeline Console) .. 153 Create a Pipeline that Uses AWS CodeBuild (AWS CLI) .. 156 Add an AWS CodeBuild Build Action to a Pipeline (AWS CodePipeline Console) .. 160 Add an AWS CodeBuild Test Action to a Pipeline (AWS CodePipeline Console) .. 164 Monitoring AWS CodeBuild .. 168 AWS CodeBuild CloudWatch Metrics .. 168 AWS CodeBuild CloudWatch Dimensions.

7 169 AWS CodeBuild CloudWatch Alarms .. 169 AWS CodeBuild Metrics .. 169 Access Build Metrics (AWS CodeBuild Console) .. 169 Access Build Metrics (Amazon CloudWatch Console) .. 170 AWS CodeBuild Alarms .. 174 Use AWS CodeBuild with Jenkins .. 181 Setting Up Jenkins .. 181 Installing the Plugin.. 181 Using the Plugin.. 181 Working with Build Projects and Builds .. 183 Working with Build Projects .. 183 Create a Build Project .. 183 View a List of Build Project Names .. 201 View a Build Project's Details .. 202 Create Build Triggers .. 204 Edit Build Triggers .. 205 Change a Build Project's Settings.

8 207 Delete a Build Project .. 216 Working with Builds .. 217 Run a Build.. 217 View Build Details.. 225 View a List of Build IDs.. 227 API Version 2016-10-06ivAWS CodeBuild user GuideView a List of Build IDs for a Build Project .. 229 Stop a Build.. 230 Delete Builds.. 231 Advanced Topics .. 233 Advanced Setup .. 233 Add AWS CodeBuild Access Permissions to an IAM Group or IAM user .. 233 Create an AWS CodeBuild Service Role .. 237 Create and Configure an AWS KMS CMK for AWS CodeBuild .. 241 Install and Configure the AWS CLI .. 242 Command Line Reference .. 243 AWS SDKs and Tools Reference .. 244 Supported AWS SDKs and Tools for AWS CodeBuild .

9 244 Specify the Endpoint .. 244 Specify the AWS CodeBuild Endpoint (AWS CLI) .. 245 Specify the AWS CodeBuild Endpoint (AWS SDK) .. 245 Authentication and Access Control .. 246 Authentication.. 247 Access Control .. 248 Overview of Managing Access .. 248 Using Identity-Based Policies (IAM Policies) .. 251 AWS CodeBuild Permissions Reference .. 257 Logging AWS CodeBuild API Calls with AWS CloudTrail .. 259 AWS CodeBuild Information in CloudTrail .. 260 Understanding AWS CodeBuild Log File Entries .. 260 Troubleshooting .. 262 Error: " CodeBuild is not authorized to perform: sts:AssumeRole" When Creating or Updating a BuildProject.

10 262 Error: "The bucket you are attempting to access must be addressed using the specified "When Running a Build.. 263 Error: "Failed to upload artifacts: Invalid arn" When Running a Build .. 263 Error: "Unable to Locate Credentials" .. 263 Earlier Commands in Build Specs Are Not Recognized by Later Commands .. 264 Apache Maven Builds Reference Artifacts from the Wrong Repository .. 265 Build Commands Run as root by Default .. 266 The Bourne Shell (sh) Must Exist in Build Images.. 266 Error: "AWS CodeBuild is experiencing an issue" When Running a Build .. 266 Error: "BUILD_CONTAINER_UNABLE_TO_PULL_IMAGE" When Using a Custom Build Image.