Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS CodeBuild Resource Types Reference » AWS::CodeBuild::Project » AWS CodeBuild Project Source

AWS CodeBuild Project Source

Source is a property of the AWS::CodeBuild::Project resource that specifies the source code settings for an AWS CodeBuild project.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Auth" : SourceAuth,
  "BuildSpec" : String,
  "GitCloneDepth" : Integer,
  "InsecureSsl" : Boolean,
  "Location" : String,
  "ReportBuildStatus" : Boolean,
  "SourceIdentifier" : String,
  "Type" : String
}

YAML

Auth:SourceAuth
BuildSpec: String
GitCloneDepth: Integer
InsecureSsl: Boolean
Location: String
ReportBuildStatus: Boolean
SourceIdentifier: String
Type: String

Properties

Auth

Information about the authorization settings for AWS CodeBuild to access the source code to be built.

Note

Your code shouldn't get or set this information directly unless the project's source type is GITHUB.

Required: No

Type: SourceAuth

Update requires: No interruption

BuildSpec

The build specification for the project. If this value is not provided, then the source code must contain a build spec file named buildspec.yml at the root level. If this value is provided, it can be either a single string containing the entire build specification, or the path to an alternate build spec file relative to the value of the built-in environment variable CODEBUILD_SRC_DIR. The alternate build spec file can have a name other than buildspec.yml, for example myspec.yml or build_spec_qa.yml or similar. For more information, see the Build Spec Reference in the AWS CodeBuild User Guide.

Required: No

Type: String

GitCloneDepth

The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build project. If your source type is Amazon S3, this value is not supported.

Required: No

Type: Integer

InsecureSsl

This is used with GitHub Enterprise only. Set to true to ignore SSL warnings while connecting to your GitHub Enterprise project repository. The default value is false. InsecureSsl should be used for testing purposes only. It should not be used in a production environment.

Required: No

Type: Boolean

Location

The location of the source code in the specified repository type. For more information, see the source-location field in the AWS CodeBuild User Guide.

Required: Conditional. If you specify CODEPIPELINE for the Type property, don't specify this property. For all of the other types, you must specify this property.

Type: String

ReportBuildStatus

This specifies whether to send your source provider the status of a build's start and completion. If you set this with a source provider other than GitHub, an invalidInputException is thrown.

Required: No

Type: Boolean

SourceIdentifier

An identifier for this project source.

Required: No

Type: String

Type

The type of repository that contains your source code. For valid values, see the source-type field in the AWS CodeBuild User Guide.

Required: Yes

Type: String

On this page: