Project - AWS CodeBuild
ContentsSee Also

Project

Information about a build project.

Contents

Note

In the following list, the required parameters are described first.

arn

The Amazon Resource Name (ARN) of the build project.

Type: String

Required: No

artifacts

Information about the build output artifacts for the build project.

Type: ProjectArtifacts object

Required: No

badge

Information about the build badge for the build project.

Type: ProjectBadge object

Required: No

buildBatchConfig

A ProjectBuildBatchConfig object that defines the batch build options for the project.

Type: ProjectBuildBatchConfig object

Required: No

cache

Information about the cache for the build project.

Type: ProjectCache object

Required: No

concurrentBuildLimit

The 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.

Type: Integer

Required: No

created

When the build project was created, expressed in Unix time format.

Type: Timestamp

Required: No

description

A description that makes the build project easy to identify.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Required: No

encryptionKey

The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

Note

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).

Type: String

Length Constraints: Minimum length of 1.

Required: No

environment

Information about the build environment for this build project.

Type: ProjectEnvironment object

Required: No

fileSystemLocations

An 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.

Type: Array of ProjectFileSystemLocation objects

Required: No

lastModified

When the build project's settings were last modified, expressed in Unix time format.

Type: Timestamp

Required: No

logsConfig

Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.

Type: LogsConfig object

Required: No

name

The name of the build project.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 255.

Pattern: [A-Za-z0-9][A-Za-z0-9\-_]{1,254}

Required: No

projectVisibility

Specifies 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.

Type: String

Valid Values: PUBLIC_READ | PRIVATE

Required: No

publicProjectAlias

Contains the project identifier used with the public build APIs.

For more information, see Public build API.

Type: String

Length Constraints: Minimum length of 1.

Required: No

queuedTimeoutInMinutes

The number of minutes a build is allowed to be queued before it times out.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 480.

Required: No

resourceAccessRole

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

Type: String

Length Constraints: Minimum length of 1.

Required: No

secondaryArtifacts

An array of ProjectArtifacts objects.

Type: Array of ProjectArtifacts objects

Array Members: Minimum number of 0 items. Maximum number of 12 items.

Required: No

secondarySources

An array of ProjectSource objects.

Type: Array of ProjectSource objects

Array Members: Minimum number of 0 items. Maximum number of 12 items.

Required: No

secondarySourceVersions

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

Type: Array of ProjectSourceVersion objects

Array Members: Minimum number of 0 items. Maximum number of 12 items.

Required: No

serviceRole

The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

Type: String

Length Constraints: Minimum length of 1.

Required: No

source

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

Type: ProjectSource object

Required: No

sourceVersion

A 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 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 AWS CodeBuild User Guide.

Type: String

Required: No

tags

A list of tag key and value pairs associated with this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

timeoutInMinutes

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 480.

Required: No

vpcConfig

Information about the VPC configuration that AWS CodeBuild accesses.

Type: VpcConfig object

Required: No

webhook

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

Type: Webhook object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: