Documentation

Information about a build.

See: newBuild smart constructor.

Create a value of Build 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:Build', build_phases - Information about all previous build phases that are complete and information about any current build phase that is not yet complete.

$sel:buildComplete:Build', build_buildComplete - Whether the build is complete. True if complete; otherwise, false.

$sel:secondaryArtifacts:Build', build_secondaryArtifacts - An array of ProjectArtifacts objects.

$sel:arn:Build', build_arn - The Amazon Resource Name (ARN) of the build.

$sel:exportedEnvironmentVariables:Build', build_exportedEnvironmentVariables - A list of exported environment variables for this build.

Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.

$sel:buildNumber:Build', build_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.

$sel:startTime:Build', build_startTime - When the build process started, expressed in Unix time format.

$sel:artifacts:Build', build_artifacts - Information about the output artifacts for the build.

$sel:environment:Build', build_environment - Information about the build environment for this build.

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

$sel:networkInterface:Build', build_networkInterface - Describes a network interface.

$sel:secondarySourceVersions:Build', build_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:currentPhase:Build', build_currentPhase - The current build phase.

$sel:queuedTimeoutInMinutes:Build', build_queuedTimeoutInMinutes - The number of minutes a build is allowed to be queued before it times out.

$sel:cache:Build', build_cache - Information about the cache for the build.

$sel:secondarySources:Build', build_secondarySources - An array of ProjectSource objects.

$sel:debugSession:Build', build_debugSession - Contains information about the debug session for this build.

$sel:sourceVersion:Build', build_sourceVersion - Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

$sel:buildBatchArn:Build', build_buildBatchArn - The ARN of the batch build that this build is a member of, if applicable.

$sel:logs:Build', build_logs - Information about the build's logs in CloudWatch Logs.

$sel:resolvedSourceVersion:Build', build_resolvedSourceVersion - An identifier for the version of this 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:Build', build_vpcConfig - If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.

$sel:endTime:Build', build_endTime - When the build process ended, expressed in Unix time format.

$sel:projectName:Build', build_projectName - The name of the CodeBuild project.

$sel:buildStatus:Build', build_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.

$sel:source:Build', build_source - Information about the source code to be built.

$sel:id:Build', build_id - The unique ID for the build.

$sel:fileSystemLocations:Build', build_fileSystemLocations - An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

$sel:reportArns:Build', build_reportArns - An array of the ARNs associated with this build's reports.

$sel:encryptionKey:Build', build_encryptionKey - The Key Management Service customer master key (CMK) to be used for encrypting the 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:serviceRole:Build', build_serviceRole - The name of a service role used for this build.

$sel:timeoutInMinutes:Build', build_timeoutInMinutes - How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.

Information about all previous build phases that are complete and information about any current build phase that is not yet complete.

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

An array of ProjectArtifacts objects.

The Amazon Resource Name (ARN) of the build.

A list of exported environment variables for this build.

Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.

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.

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

Information about the output artifacts for the build.

Information about the build environment for this build.

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

Describes a network interface.

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 current build phase.

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

Information about the cache for the build.

An array of ProjectSource objects.

Contains information about the debug session for this build.

Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

The ARN of the batch build that this build is a member of, if applicable.

Information about the build's logs in CloudWatch Logs.

An identifier for the version of this 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.

If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.

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

The name of the CodeBuild project.

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.

Information about the source code to be built.

The unique ID for the build.

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

An array of the ARNs associated with this build's reports.

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

The name of a service role used for this build.

How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.