Documentation

Contains information about a batch build.

See: newBuildBatch smart constructor.

Create a value of BuildBatch with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:phases:BuildBatch', buildBatch_phases - An array of BuildBatchPhase objects the specify the phases of the batch build.

$sel:secondaryArtifacts:BuildBatch', buildBatch_secondaryArtifacts - An array of BuildArtifacts objects the define the build artifacts for this batch build.

$sel:buildTimeoutInMinutes:BuildBatch', buildBatch_buildTimeoutInMinutes - Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.

$sel:debugSessionEnabled:BuildBatch', buildBatch_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.

$sel:arn:BuildBatch', buildBatch_arn - The ARN of the batch build.

$sel:startTime:BuildBatch', buildBatch_startTime - The date and time that the batch build started.

$sel:artifacts:BuildBatch', buildBatch_artifacts - A BuildArtifacts object the defines the build artifacts for this batch build.

$sel:environment:BuildBatch', buildBatch_environment - Undocumented member.

$sel:initiator:BuildBatch', buildBatch_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 an IAM user started the build, the user's name.
• If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

$sel:secondarySourceVersions:BuildBatch', buildBatch_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.

$sel:buildBatchStatus:BuildBatch', buildBatch_buildBatchStatus - The status of the batch build.

$sel:currentPhase:BuildBatch', buildBatch_currentPhase - The current phase of the batch build.

$sel:buildBatchNumber:BuildBatch', buildBatch_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.

$sel:queuedTimeoutInMinutes:BuildBatch', buildBatch_queuedTimeoutInMinutes - Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.

$sel:cache:BuildBatch', buildBatch_cache - Undocumented member.

$sel:secondarySources:BuildBatch', buildBatch_secondarySources - An array of ProjectSource objects that define the sources for the batch build.

$sel:sourceVersion:BuildBatch', buildBatch_sourceVersion - The identifier of the version of the source code to be built.

$sel:resolvedSourceVersion:BuildBatch', buildBatch_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.

$sel:vpcConfig:BuildBatch', buildBatch_vpcConfig - Undocumented member.

$sel:endTime:BuildBatch', buildBatch_endTime - The date and time that the batch build ended.

$sel:projectName:BuildBatch', buildBatch_projectName - The name of the batch build project.

$sel:buildGroups:BuildBatch', buildBatch_buildGroups - An array of BuildGroup objects that define the build groups for the batch build.

$sel:source:BuildBatch', buildBatch_source - Undocumented member.

$sel:id:BuildBatch', buildBatch_id - The identifier of the batch build.

$sel:fileSystemLocations:BuildBatch', buildBatch_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.

$sel:buildBatchConfig:BuildBatch', buildBatch_buildBatchConfig - Undocumented member.

$sel:encryptionKey:BuildBatch', buildBatch_encryptionKey - The Key Management Service customer master key (CMK) to be used for encrypting the batch build output artifacts.

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

$sel:logConfig:BuildBatch', buildBatch_logConfig - Undocumented member.

$sel:serviceRole:BuildBatch', buildBatch_serviceRole - The name of a service role used for builds in the batch.

$sel:complete:BuildBatch', buildBatch_complete - Indicates if the batch build is complete.

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

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

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

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.

The ARN of the batch build.

The date and time that the batch build started.

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

Undocumented member.

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 an IAM user started the build, the user's name.
• If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

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.

The status of the batch build.

The current phase of the batch build.

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.

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

Undocumented member.

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

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

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.

Undocumented member.

The date and time that the batch build ended.

The name of the batch build project.

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

Undocumented member.

The identifier of the batch build.

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.

Undocumented member.

The Key Management Service customer master key (CMK) to be used for encrypting the batch build output artifacts.

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

Undocumented member.

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

Indicates if the batch build is complete.