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

CreateProject

Creates a build project.

Request Syntax

{ "artifacts": { "artifactIdentifier": "string", "encryptionDisabled": boolean, "location": "string", "name": "string", "namespaceType": "string", "overrideArtifactName": boolean, "packaging": "string", "path": "string", "type": "string" }, "badgeEnabled": boolean, "cache": { "location": "string", "type": "string" }, "description": "string", "encryptionKey": "string", "environment": { "certificate": "string", "computeType": "string", "environmentVariables": [ { "name": "string", "type": "string", "value": "string" } ], "image": "string", "privilegedMode": boolean, "type": "string" }, "logsConfig": { "cloudWatchLogs": { "groupName": "string", "status": "string", "streamName": "string" }, "s3Logs": { "location": "string", "status": "string" } }, "name": "string", "queuedTimeoutInMinutes": number, "secondaryArtifacts": [ { "artifactIdentifier": "string", "encryptionDisabled": boolean, "location": "string", "name": "string", "namespaceType": "string", "overrideArtifactName": boolean, "packaging": "string", "path": "string", "type": "string" } ], "secondarySources": [ { "auth": { "resource": "string", "type": "string" }, "buildspec": "string", "gitCloneDepth": number, "insecureSsl": boolean, "location": "string", "reportBuildStatus": boolean, "sourceIdentifier": "string", "type": "string" } ], "serviceRole": "string", "source": { "auth": { "resource": "string", "type": "string" }, "buildspec": "string", "gitCloneDepth": number, "insecureSsl": boolean, "location": "string", "reportBuildStatus": boolean, "sourceIdentifier": "string", "type": "string" }, "tags": [ { "key": "string", "value": "string" } ], "timeoutInMinutes": number, "vpcConfig": { "securityGroupIds": [ "string" ], "subnets": [ "string" ], "vpcId": "string" } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

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

artifacts

Information about the build output artifacts for the build project.

Type: ProjectArtifacts object

Required: Yes

environment

Information about the build environment for the build project.

Type: ProjectEnvironment object

Required: Yes

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: Yes

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: Yes

source

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

Type: ProjectSource object

Required: Yes

badgeEnabled

Set this to true to generate a publicly accessible URL for your project's build badge.

Type: Boolean

Required: No

cache

Stores recently used information so that it can be quickly accessed at a later time.

Type: ProjectCache object

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.

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

Type: String

Length Constraints: Minimum length of 1.

Required: No

logsConfig

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

Type: LogsConfig object

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

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

tags

A set of 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 it times out any build that has not been marked as completed. The default is 60 minutes.

Type: Integer

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

Required: No

vpcConfig

VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.

Type: VpcConfig object

Required: No

Response Syntax

{ "project": { "arn": "string", "artifacts": { "artifactIdentifier": "string", "encryptionDisabled": boolean, "location": "string", "name": "string", "namespaceType": "string", "overrideArtifactName": boolean, "packaging": "string", "path": "string", "type": "string" }, "badge": { "badgeEnabled": boolean, "badgeRequestUrl": "string" }, "cache": { "location": "string", "type": "string" }, "created": number, "description": "string", "encryptionKey": "string", "environment": { "certificate": "string", "computeType": "string", "environmentVariables": [ { "name": "string", "type": "string", "value": "string" } ], "image": "string", "privilegedMode": boolean, "type": "string" }, "lastModified": number, "logsConfig": { "cloudWatchLogs": { "groupName": "string", "status": "string", "streamName": "string" }, "s3Logs": { "location": "string", "status": "string" } }, "name": "string", "queuedTimeoutInMinutes": number, "secondaryArtifacts": [ { "artifactIdentifier": "string", "encryptionDisabled": boolean, "location": "string", "name": "string", "namespaceType": "string", "overrideArtifactName": boolean, "packaging": "string", "path": "string", "type": "string" } ], "secondarySources": [ { "auth": { "resource": "string", "type": "string" }, "buildspec": "string", "gitCloneDepth": number, "insecureSsl": boolean, "location": "string", "reportBuildStatus": boolean, "sourceIdentifier": "string", "type": "string" } ], "serviceRole": "string", "source": { "auth": { "resource": "string", "type": "string" }, "buildspec": "string", "gitCloneDepth": number, "insecureSsl": boolean, "location": "string", "reportBuildStatus": boolean, "sourceIdentifier": "string", "type": "string" }, "tags": [ { "key": "string", "value": "string" } ], "timeoutInMinutes": number, "vpcConfig": { "securityGroupIds": [ "string" ], "subnets": [ "string" ], "vpcId": "string" }, "webhook": { "branchFilter": "string", "lastModifiedSecret": number, "payloadUrl": "string", "secret": "string", "url": "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

project

Information about the build project that was created.

Type: Project object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccountLimitExceededException

An AWS service limit was exceeded for the calling AWS account.

HTTP Status Code: 400

InvalidInputException

The input value that was provided is not valid.

HTTP Status Code: 400

ResourceAlreadyExistsException

The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.

HTTP Status Code: 400

See Also

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