AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Contains information about a batch build.

Inheritance Hierarchy

System.Object
  Amazon.CodeBuild.Model.BuildBatch

Namespace: Amazon.CodeBuild.Model
Assembly: AWSSDK.CodeBuild.dll
Version: 3.x.y.z

Syntax

C#
public class BuildBatch

The BuildBatch type exposes the following members

Constructors

NameDescription
Public Method BuildBatch()

Properties

NameTypeDescription
Public Property Arn System.String

Gets and sets the property Arn.

The ARN of the batch build.

Public Property Artifacts Amazon.CodeBuild.Model.BuildArtifacts

Gets and sets the property Artifacts.

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

Public Property BuildBatchConfig Amazon.CodeBuild.Model.ProjectBuildBatchConfig

Gets and sets the property BuildBatchConfig.

Public Property BuildBatchNumber System.Int64

Gets and sets the property 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.

Public Property BuildBatchStatus Amazon.CodeBuild.StatusType

Gets and sets the property BuildBatchStatus.

The status of the batch build.

Public Property BuildGroups System.Collections.Generic.List<Amazon.CodeBuild.Model.BuildGroup>

Gets and sets the property BuildGroups.

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

Public Property BuildTimeoutInMinutes System.Int32

Gets and sets the property BuildTimeoutInMinutes.

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

Public Property Cache Amazon.CodeBuild.Model.ProjectCache

Gets and sets the property Cache.

Public Property Complete System.Boolean

Gets and sets the property Complete.

Indicates if the batch build is complete.

Public Property CurrentPhase System.String

Gets and sets the property CurrentPhase.

The current phase of the batch build.

Public Property DebugSessionEnabled System.Boolean

Gets and sets the property 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.

Public Property EncryptionKey System.String

Gets and sets the property 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/).

Public Property EndTime System.DateTime

Gets and sets the property EndTime.

The date and time that the batch build ended.

Public Property Environment Amazon.CodeBuild.Model.ProjectEnvironment

Gets and sets the property Environment.

Public Property FileSystemLocations System.Collections.Generic.List<Amazon.CodeBuild.Model.ProjectFileSystemLocation>

Gets and sets the property 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.

Public Property Id System.String

Gets and sets the property Id.

The identifier of the batch build.

Public Property Initiator System.String

Gets and sets the property 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 CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

Public Property LogConfig Amazon.CodeBuild.Model.LogsConfig

Gets and sets the property LogConfig.

Public Property Phases System.Collections.Generic.List<Amazon.CodeBuild.Model.BuildBatchPhase>

Gets and sets the property Phases.

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

Public Property ProjectName System.String

Gets and sets the property ProjectName.

The name of the batch build project.

Public Property QueuedTimeoutInMinutes System.Int32

Gets and sets the property QueuedTimeoutInMinutes.

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

Public Property ResolvedSourceVersion System.String

Gets and sets the property 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.

Public Property SecondaryArtifacts System.Collections.Generic.List<Amazon.CodeBuild.Model.BuildArtifacts>

Gets and sets the property SecondaryArtifacts.

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

Public Property SecondarySources System.Collections.Generic.List<Amazon.CodeBuild.Model.ProjectSource>

Gets and sets the property SecondarySources.

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

Public Property SecondarySourceVersions System.Collections.Generic.List<Amazon.CodeBuild.Model.ProjectSourceVersion>

Gets and sets the property 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.

Public Property ServiceRole System.String

Gets and sets the property ServiceRole.

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

Public Property Source Amazon.CodeBuild.Model.ProjectSource

Gets and sets the property Source.

Public Property SourceVersion System.String

Gets and sets the property SourceVersion.

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

Public Property StartTime System.DateTime

Gets and sets the property StartTime.

The date and time that the batch build started.

Public Property VpcConfig Amazon.CodeBuild.Model.VpcConfig

Gets and sets the property VpcConfig.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5