CodeBuild Project

An AWS CodeBuild Project is a configuration that defines how source code is built and tested in a fully managed build service. It specifies details such as the source repository, build environment, runtime settings, and output artifacts. Each project runs builds in isolated containers, scales automatically, and integrates with other AWS services like CodePipeline, S3, and CloudWatch.

aws.codebuild_project

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
arncorestringThe Amazon Resource Name (ARN) of the build project.
artifactscorejsonInformation about the build output artifacts for the build project.
badgecorejsonInformation about the build badge for the build project.
build_batch_configcorejsonA ProjectBuildBatchConfig object that defines the batch build options for the project.
cachecorejsonInformation about the cache for the build project.
concurrent_build_limitcoreint64The maximum number of concurrent builds that are allowed for this project. New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
createdcoretimestampWhen the build project was created, expressed in Unix time format.
descriptioncorestringA description that makes the build project easy to identify.
environmentcorejsonInformation about the build environment for this build project.
file_system_locationscorejsonAn array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
last_modifiedcoretimestampWhen the build project's settings were last modified, expressed in Unix time format.
logs_configcorejsonInformation about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
namecorestringThe name of the build project.
project_sourcecorejsonInformation about the build input source code for this build project.
project_visibilitycorestringSpecifies the visibility of the project's builds. Possible values are: PUBLIC_READ The project builds are visible to the public. PRIVATE The project builds are not visible to the public.
public_project_aliascorestringContains the project identifier used with the public build APIs.
queued_timeout_in_minutescoreint64The number of minutes a build is allowed to be queued before it times out.
resource_access_rolecorestringThe ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
secondary_artifactscorejsonAn array of ProjectArtifacts objects.
secondary_source_versionscorejsonAn array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
secondary_sourcescorejsonAn array of ProjectSource objects.
service_rolecorestringThe ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
source_versioncorestringA version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: For CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For GitLab: the commit ID, branch, or Git tag to use. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon S3: the version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level). For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
tagscorehstore
timeout_in_minutescoreint64How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
vpc_configcorejsonInformation about the VPC configuration that CodeBuild accesses.
webhookcorejsonInformation about a webhook that connects repository events to a build project in CodeBuild.