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§
- Batch
Delete Builds Input - Batch
Delete Builds Output - Batch
GetBuild Batches Input - Batch
GetBuild Batches Output - Batch
GetBuilds Input - Batch
GetBuilds Output - Batch
GetProjects Input - Batch
GetProjects Output - Batch
GetReport Groups Input - Batch
GetReport Groups Output - Batch
GetReports Input - Batch
GetReports Output - Batch
Restrictions Specifies restrictions for the batch build.
- Build
Information about a build.
- Build
Artifacts Information about build output artifacts.
- Build
Batch Contains information about a batch build.
- Build
Batch Filter Specifies filters when retrieving batch builds.
- Build
Batch Phase Contains information about a stage for a batch build.
- Build
Group 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.
- Build
NotDeleted Information about a build that could not be successfully deleted.
- Build
Phase Information about a stage for a build.
- Build
Status Config Contains information that defines how the CodeBuild build project reports the build status to the source provider.
- Build
Summary Contains summary information about a batch build group.
- Cloud
Watch Logs Config Information about CloudWatch Logs for a build project.
- Code
Build Client - A client for the AWS CodeBuild API.
- Code
Coverage 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
iforcasestatement.- Code
Coverage Report Summary 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
iforcasestatement.- Create
Project Input - Create
Project Output - Create
Report Group Input - Create
Report Group Output - Create
Webhook Input - Create
Webhook Output - Debug
Session Contains information about the debug session for a build. For more information, see Viewing a running build in Session Manager.
- Delete
Build Batch Input - Delete
Build Batch Output - Delete
Project Input - Delete
Project Output - Delete
Report Group Input - Delete
Report Group Output - Delete
Report Input - Delete
Report Output - Delete
Resource Policy Input - Delete
Resource Policy Output - Delete
Source Credentials Input - Delete
Source Credentials Output - Delete
Webhook Input - Delete
Webhook Output - Describe
Code Coverages Input - Describe
Code Coverages Output - Describe
Test Cases Input - Describe
Test Cases Output - Environment
Image Information about a Docker image that is managed by CodeBuild.
- Environment
Language A set of Docker images that are related by programming language and are managed by CodeBuild.
- Environment
Platform A set of Docker images that are related by platform and are managed by CodeBuild.
- Environment
Variable Information about an environment variable for a build project or a build.
- Exported
Environment Variable 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
installphase. It can be updated between the start of theinstallphase and the end of thepostbuildphase. After thepostbuildphase ends, the value of exported variables cannot change.- GetReport
Group Trend Input - GetReport
Group Trend Output - GetResource
Policy Input - GetResource
Policy Output - GitSubmodules
Config Information about the Git submodules configuration for an CodeBuild build project.
- Import
Source Credentials Input - Import
Source Credentials Output - Invalidate
Project Cache Input - Invalidate
Project Cache Output - List
Build Batches ForProject Input - List
Build Batches ForProject Output - List
Build Batches Input - List
Build Batches Output - List
Builds ForProject Input - List
Builds ForProject Output - List
Builds Input - List
Builds Output - List
Curated Environment Images Input - List
Curated Environment Images Output - List
Projects Input - List
Projects Output - List
Report Groups Input - List
Report Groups Output - List
Reports ForReport Group Input - List
Reports ForReport Group Output - List
Reports Input - List
Reports Output - List
Shared Projects Input - List
Shared Projects Output - List
Shared Report Groups Input - List
Shared Report Groups Output - List
Source Credentials Input - List
Source Credentials Output - Logs
Config Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both.
- Logs
Location Information about build logs in CloudWatch Logs.
- Network
Interface Describes a network interface.
- Phase
Context Additional information about a build phase that has an error. You can use this information for troubleshooting.
- Project
Information about a build project.
- Project
Artifacts Information about the build output artifacts for the build project.
- Project
Badge Information about the build badge for the build project.
- Project
Build Batch Config Contains configuration information about a batch build project.
- Project
Cache Information about the cache for the build project.
- Project
Environment Information about the build environment of the build project.
- Project
File System Location Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
- Project
Source Information about the build input source code for the build project.
- Project
Source Version A source identifier and its corresponding version.
- PutResource
Policy Input - PutResource
Policy Output - Registry
Credential Information about credentials that provide access to a private Docker registry. When this is set:
-
imagePullCredentialsTypemust be set toSERVICE_ROLE. -
images cannot be curated or an Amazon ECR image.
For more information, see Private Registry with Secrets Manager Sample for CodeBuild.
-
- Report
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.
- Report
Export Config Information about the location where the run of a report is exported.
- Report
Filter A filter used to return reports with the status specified by the input
statusparameter.- Report
Group 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.
- Report
Group Trend Stats Contains trend statistics for a set of reports. The actual values depend on the type of trend being collected. For more information, see .
- Report
With RawData Contains the unmodified data for the report. For more information, see .
- Resolved
Artifact Represents a resolved build artifact. A resolve artifact is an artifact that is built and deployed to the destination, such as Amazon S3.
- Retry
Build Batch Input - Retry
Build Batch Output - Retry
Build Input - Retry
Build Output - S3Logs
Config Information about S3 logs for a build project.
- S3Report
Export Config Information about the S3 bucket where the raw data of a report are exported.
- Source
Auth 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.
- Source
Credentials Info Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository.
- Start
Build Batch Input - Start
Build Batch Output - Start
Build Input - Start
Build Output - Stop
Build Batch Input - Stop
Build Batch Output - Stop
Build Input - Stop
Build Output - Tag
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.
- Test
Case 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.
- Test
Case Filter 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.
- Test
Report Summary Information about a test report.
- Update
Project Input - Update
Project Output - Update
Report Group Input - Update
Report Group Output - Update
Webhook Input - Update
Webhook Output - VpcConfig
Information about the VPC configuration that CodeBuild accesses.
- Webhook
Information about a webhook that connects repository events to a build project in CodeBuild.
- Webhook
Filter A filter used to determine which webhooks trigger a build.
Enums§
- Batch
Delete Builds Error - Errors returned by BatchDeleteBuilds
- Batch
GetBuild Batches Error - Errors returned by BatchGetBuildBatches
- Batch
GetBuilds Error - Errors returned by BatchGetBuilds
- Batch
GetProjects Error - Errors returned by BatchGetProjects
- Batch
GetReport Groups Error - Errors returned by BatchGetReportGroups
- Batch
GetReports Error - Errors returned by BatchGetReports
- Create
Project Error - Errors returned by CreateProject
- Create
Report Group Error - Errors returned by CreateReportGroup
- Create
Webhook Error - Errors returned by CreateWebhook
- Delete
Build Batch Error - Errors returned by DeleteBuildBatch
- Delete
Project Error - Errors returned by DeleteProject
- Delete
Report Error - Errors returned by DeleteReport
- Delete
Report Group Error - Errors returned by DeleteReportGroup
- Delete
Resource Policy Error - Errors returned by DeleteResourcePolicy
- Delete
Source Credentials Error - Errors returned by DeleteSourceCredentials
- Delete
Webhook Error - Errors returned by DeleteWebhook
- Describe
Code Coverages Error - Errors returned by DescribeCodeCoverages
- Describe
Test Cases Error - Errors returned by DescribeTestCases
- GetReport
Group Trend Error - Errors returned by GetReportGroupTrend
- GetResource
Policy Error - Errors returned by GetResourcePolicy
- Import
Source Credentials Error - Errors returned by ImportSourceCredentials
- Invalidate
Project Cache Error - Errors returned by InvalidateProjectCache
- List
Build Batches Error - Errors returned by ListBuildBatches
- List
Build Batches ForProject Error - Errors returned by ListBuildBatchesForProject
- List
Builds Error - Errors returned by ListBuilds
- List
Builds ForProject Error - Errors returned by ListBuildsForProject
- List
Curated Environment Images Error - Errors returned by ListCuratedEnvironmentImages
- List
Projects Error - Errors returned by ListProjects
- List
Report Groups Error - Errors returned by ListReportGroups
- List
Reports Error - Errors returned by ListReports
- List
Reports ForReport Group Error - Errors returned by ListReportsForReportGroup
- List
Shared Projects Error - Errors returned by ListSharedProjects
- List
Shared Report Groups Error - Errors returned by ListSharedReportGroups
- List
Source Credentials Error - Errors returned by ListSourceCredentials
- PutResource
Policy Error - Errors returned by PutResourcePolicy
- Retry
Build Batch Error - Errors returned by RetryBuildBatch
- Retry
Build Error - Errors returned by RetryBuild
- Start
Build Batch Error - Errors returned by StartBuildBatch
- Start
Build Error - Errors returned by StartBuild
- Stop
Build Batch Error - Errors returned by StopBuildBatch
- Stop
Build Error - Errors returned by StopBuild
- Update
Project Error - Errors returned by UpdateProject
- Update
Report Group Error - Errors returned by UpdateReportGroup
- Update
Webhook Error - Errors returned by UpdateWebhook
Traits§
- Code
Build - Trait representing the capabilities of the AWS CodeBuild API. AWS CodeBuild clients implement this trait.