AWS CodeBuild
User Guide (API Version 2016-10-06)

AWS CodeBuild Concepts

The following concepts are important for understanding how CodeBuild works.

How CodeBuild Works

The following diagram shows what happens when you run a build with CodeBuild:

  1. As input, you must provide CodeBuild with a build project. A build project defines how CodeBuild runs a build. It includes information such as where to get the source code, the build environment to use, the build commands to run, and where to store the build output. A build environment represents a combination of operating system, programming language runtime, and tools that CodeBuild uses to run a build. For more information, see:

  2. CodeBuild uses the build project to create the build environment.

  3. CodeBuild downloads the source code into the build environment and then uses the build specification (build spec), as defined in the build project or included directly in the source code. A build spec is a collection of build commands and related settings, in YAML format, that CodeBuild uses to run a build. For more information, see the Build Spec Reference.

  4. If there is any build output, the build environment uploads its output to an Amazon S3 bucket. The build environment can also perform tasks that you specify in the build spec (for example, sending build notifications to an Amazon SNS topic). For an example, see Build Notifications Sample.

  5. While the build is running, the build environment sends information to CodeBuild and Amazon CloudWatch Logs.

  6. While the build is running, you can use the CodeBuild console, AWS CLI, or AWS SDKs, to get summarized build information from CodeBuild and detailed build information from Amazon CloudWatch Logs. If you use AWS CodePipeline to run builds, you can get limited build information from CodePipeline.

Next Steps

Now that you know more about AWS CodeBuild, we recommend that you complete the following steps:

  1. Experiment with CodeBuild in an example scenario by following the instructions in Getting Started.

  2. Use CodeBuild in your own scenarios by following the instructions in Plan a Build.