View a markdown version of this page

AWS::CodeBuild::BuildBatch - 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::BuildBatch

Contains information about a batch build.

Syntax

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

JSON

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

YAML

Type: AWS::CodeBuild::BuildBatch
Properties:
  ProjectName: String

Properties

ProjectName

The name of the batch build project.

Required: No

Type: String

Minimum: 1

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

The ARN of the batch build.

BuildBatchNumber

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

BuildBatchStatus

The status of the batch build.

BuildTimeoutInMinutes

Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.

Complete

Indicates if the batch build is complete.

CurrentPhase

The current phase of the batch build.

EncryptionKey

The Amazon Key Management Service customer master key (CMK) to be used for encrypting the batch 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>).

Id

The identifier of the batch build.

Initiator

The entity that started the batch 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.

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

QueuedTimeoutInMinutes

Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.

StartTime

The date and time that the batch build started.