Menu
AWS CodeBuild
API Reference (API Version 2016-10-06)

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

cache

Information about the cache for the build project.

Type: ProjectCache object

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 (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the format alias/alias-name ).

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

lastModified

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

Type: Timestamp

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

serviceRole

The ARN of the AWS Identity and Access Management (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

tags

The tags for 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

If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.

Type: VpcConfig object

Required: No

webhook

Information about a webhook in GitHub 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:

On this page: