View a markdown version of this page

AWS::CodeBuild::Build - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::CodeBuild::Build

Information about a build.

Syntax

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

JSON

{
  "Type" : "AWS::CodeBuild::Build",
  "Properties" : {
      "ProjectName" : String
    }
}

YAML

Type: AWS::CodeBuild::Build
Properties:
  ProjectName: String

Properties

ProjectName

The name of the Amazon CodeBuild project.

Required: No

Type: String

Minimum: 1

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the build.

BuildComplete

Whether the build is complete. True if complete; otherwise, false.

BuildNumber

The number of the build. For each project, the buildNumber of its first build is 1. The buildNumber of each subsequent build is incremented by 1. If a build is deleted, the buildNumber of other builds does not change.

BuildStatus

The current status of the build. Valid values include:

  • FAILED: The build failed.

  • FAULT: The build faulted.

  • IN_PROGRESS: The build is still in progress.

  • STOPPED: The build stopped.

  • SUCCEEDED: The build succeeded.

  • TIMED_OUT: The build timed out.

CurrentPhase

The current build phase.

EncryptionKey

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

EndTime

When the build process ended, expressed in Unix time format.

Id

The unique ID for the build.

Initiator

The entity that started the build. Valid values include:

  • If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

  • If a user started the build, the user's name (for example, MyUserName).

  • If the Jenkins plugin for Amazon CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

QueuedTimeoutInMinutes

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

ServiceRole

The name of a service role used for this build.

StartTime

When the build process started, expressed in Unix time format.

TimeoutInMinutes

How long, in minutes, from 5 to 2160 (36 hours), for Amazon CodeBuild to wait before timing out this build if it does not get marked as completed.