BuildBatch - AWS CodeBuild
ContentsSee Also

BuildBatch

Contains information about a batch build.

Contents

Note

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

arn

The ARN of the batch build.

Type: String

Length Constraints: Minimum length of 1.

Required: No

artifacts

A BuildArtifacts object the defines the build artifacts for this batch build.

Type: BuildArtifacts object

Required: No

buildBatchConfig

Contains configuration information about a batch build project.

Type: ProjectBuildBatchConfig object

Required: No

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.

Type: Long

Required: No

buildBatchStatus

The status of the batch build.

Type: String

Valid Values: SUCCEEDED | FAILED | FAULT | TIMED_OUT | IN_PROGRESS | STOPPED

Required: No

buildGroups

An array of BuildGroup objects that define the build groups for the batch build.

Type: Array of BuildGroup objects

Required: No

buildTimeoutInMinutes

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

Type: Integer

Required: No

cache

Information about the cache for the build project.

Type: ProjectCache object

Required: No

complete

Indicates if the batch build is complete.

Type: Boolean

Required: No

currentPhase

The current phase of the batch build.

Type: String

Required: No

debugSessionEnabled

Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.

Type: Boolean

Required: No

encryptionKey

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

Type: String

Length Constraints: Minimum length of 1.

Required: No

endTime

The date and time that the batch build ended.

Type: Timestamp

Required: No

environment

Information about the build environment of the build project.

Type: ProjectEnvironment object

Required: No

fileSystemLocations

An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

Type: Array of ProjectFileSystemLocation objects

Required: No

id

The identifier of the batch build.

Type: String

Length Constraints: Minimum length of 1.

Required: No

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 AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

Type: String

Required: No

logConfig

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

Type: LogsConfig object

Required: No

phases

An array of BuildBatchPhase objects the specify the phases of the batch build.

Type: Array of BuildBatchPhase objects

Required: No

projectName

The name of the batch build project.

Type: String

Length Constraints: Minimum length of 1.

Required: No

queuedTimeoutInMinutes

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

Type: Integer

Required: No

reportArns

An array that contains the ARNs of reports created by merging reports from builds associated with this batch build.

Type: Array of strings

Required: No

resolvedSourceVersion

The identifier of the resolved version of this batch build's source code.

  • For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

  • For CodePipeline, the source revision provided by CodePipeline.

  • For Amazon S3, this does not apply.

Type: String

Length Constraints: Minimum length of 1.

Required: No

secondaryArtifacts

An array of BuildArtifacts objects the define the build artifacts for this batch build.

Type: Array of BuildArtifacts objects

Array Members: Minimum number of 0 items. Maximum number of 12 items.

Required: No

secondarySources

An array of ProjectSource objects that define the sources for the batch build.

Type: Array of ProjectSource objects

Array Members: Minimum number of 0 items. Maximum number of 12 items.

Required: No

secondarySourceVersions

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

  • For CodeCommit: the commit ID, branch, or Git tag to use.

  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

Type: Array of ProjectSourceVersion objects

Array Members: Minimum number of 0 items. Maximum number of 12 items.

Required: No

serviceRole

The name of a service role used for builds in the batch.

Type: String

Length Constraints: Minimum length of 1.

Required: No

source

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

Type: ProjectSource object

Required: No

sourceVersion

The identifier of the version of the source code to be built.

Type: String

Length Constraints: Minimum length of 1.

Required: No

startTime

The date and time that the batch build started.

Type: Timestamp

Required: No

vpcConfig

Information about the VPC configuration that AWS CodeBuild accesses.

Type: VpcConfig object

Required: No

See Also

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