logo
Expand description

CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the CodeBuild User Guide.

If you’re using the service, you’re probably looking for CodeBuildClient and CodeBuild.

Structs

Specifies restrictions for the batch build.

Information about a build.

Information about build output artifacts.

Contains information about a batch build.

Specifies filters when retrieving batch builds.

Contains information about a stage for a batch build.

Contains information about a batch build build group. Build groups are used to combine builds that can run in parallel, while still being able to set dependencies on other build groups.

Information about a build that could not be successfully deleted.

Information about a stage for a build.

Contains information that defines how the CodeBuild build project reports the build status to the source provider.

Contains summary information about a batch build group.

Information about CloudWatch Logs for a build project.

A client for the AWS CodeBuild API.

Contains code coverage report information.

Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.

Branch coverage determines if your tests cover every possible branch of a control structure, such as an if or case statement.

Contains a summary of a code coverage report.

Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.

Branch coverage determines if your tests cover every possible branch of a control structure, such as an if or case statement.

Contains information about the debug session for a build. For more information, see Viewing a running build in Session Manager.

Information about a Docker image that is managed by CodeBuild.

A set of Docker images that are related by programming language and are managed by CodeBuild.

A set of Docker images that are related by platform and are managed by CodeBuild.

Information about an environment variable for a build project or a build.

Contains information about an exported environment variable.

Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.

During a build, the value of a variable is available starting with the install phase. It can be updated between the start of the install phase and the end of the postbuild phase. After the postbuild phase ends, the value of exported variables cannot change.

Information about the Git submodules configuration for an CodeBuild build project.

Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both.

Information about build logs in CloudWatch Logs.

Describes a network interface.

Additional information about a build phase that has an error. You can use this information for troubleshooting.

Information about a build project.

Information about the build output artifacts for the build project.

Information about the build badge for the build project.

Contains configuration information about a batch build project.

Information about the cache for the build project.

Information about the build environment of the build project.

Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?

Information about the build input source code for the build project.

A source identifier and its corresponding version.

Information about credentials that provide access to a private Docker registry. When this is set:

  • imagePullCredentialsType must be set to SERVICE_ROLE.

  • images cannot be curated or an Amazon ECR image.

For more information, see Private Registry with Secrets Manager Sample for CodeBuild.

Information about the results from running a series of test cases during the run of a build project. The test cases are specified in the buildspec for the build project using one or more paths to the test case files. You can specify any type of tests you want, such as unit tests, integration tests, and functional tests.

Information about the location where the run of a report is exported.

A filter used to return reports with the status specified by the input status parameter.

A series of reports. Each report contains information about the results from running a series of test cases. You specify the test cases for a report group in the buildspec for a build project using one or more paths to the test case files.

Contains trend statistics for a set of reports. The actual values depend on the type of trend being collected. For more information, see .

Contains the unmodified data for the report. For more information, see .

Represents a resolved build artifact. A resolve artifact is an artifact that is built and deployed to the destination, such as Amazon S3.

Information about S3 logs for a build project.

Information about the S3 bucket where the raw data of a report are exported.

Information about the authorization settings for CodeBuild to access the source code to be built.

This information is for the CodeBuild console's use only. Your code should not get or set this information directly.

Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository.

A tag, consisting of a key and a value.

This tag is available for use by Amazon Web Services services that support tags in CodeBuild.

Information about a test case created using a framework such as NUnit or Cucumber. A test case might be a unit test or a configuration test.

A filter used to return specific types of test cases. In order to pass the filter, the report must meet all of the filter properties.

Information about a test report.

Information about the VPC configuration that CodeBuild accesses.

Information about a webhook that connects repository events to a build project in CodeBuild.

A filter used to determine which webhooks trigger a build.

Enums

Errors returned by BatchDeleteBuilds

Errors returned by BatchGetBuildBatches

Errors returned by BatchGetBuilds

Errors returned by BatchGetProjects

Errors returned by BatchGetReportGroups

Errors returned by BatchGetReports

Errors returned by CreateProject

Errors returned by CreateReportGroup

Errors returned by CreateWebhook

Errors returned by DeleteBuildBatch

Errors returned by DeleteProject

Errors returned by DeleteReport

Errors returned by DeleteReportGroup

Errors returned by DeleteResourcePolicy

Errors returned by DeleteSourceCredentials

Errors returned by DeleteWebhook

Errors returned by DescribeCodeCoverages

Errors returned by DescribeTestCases

Errors returned by GetReportGroupTrend

Errors returned by GetResourcePolicy

Errors returned by ImportSourceCredentials

Errors returned by InvalidateProjectCache

Errors returned by ListBuildBatches

Errors returned by ListBuildBatchesForProject

Errors returned by ListBuilds

Errors returned by ListBuildsForProject

Errors returned by ListCuratedEnvironmentImages

Errors returned by ListProjects

Errors returned by ListReportGroups

Errors returned by ListReports

Errors returned by ListReportsForReportGroup

Errors returned by ListSharedProjects

Errors returned by ListSharedReportGroups

Errors returned by ListSourceCredentials

Errors returned by PutResourcePolicy

Errors returned by RetryBuildBatch

Errors returned by RetryBuild

Errors returned by StartBuildBatch

Errors returned by StartBuild

Errors returned by StopBuildBatch

Errors returned by StopBuild

Errors returned by UpdateProject

Errors returned by UpdateReportGroup

Errors returned by UpdateWebhook

Traits

Trait representing the capabilities of the AWS CodeBuild API. AWS CodeBuild clients implement this trait.