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.

Information about a build.

Inheritance Hierarchy

System.Object
  Amazon.CodeBuild.Model.Build

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

Syntax

C#
public class Build

The Build type exposes the following members

Constructors

NameDescription
Public Method Build()

Properties

NameTypeDescription
Public Property Arn System.String

Gets and sets the property Arn.

The Amazon Resource Name (ARN) of the build.

Public Property Artifacts Amazon.CodeBuild.Model.BuildArtifacts

Gets and sets the property Artifacts.

Information about the output artifacts for the build.

Public Property BuildBatchArn System.String

Gets and sets the property BuildBatchArn.

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

Public Property BuildComplete System.Boolean

Gets and sets the property BuildComplete.

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

Public Property BuildNumber System.Int64

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

Public Property BuildStatus Amazon.CodeBuild.StatusType

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

Public Property Cache Amazon.CodeBuild.Model.ProjectCache

Gets and sets the property Cache.

Information about the cache for the build.

Public Property CurrentPhase System.String

Gets and sets the property CurrentPhase.

The current build phase.

Public Property DebugSession Amazon.CodeBuild.Model.DebugSession

Gets and sets the property DebugSession.

Contains information about the debug session for this build.

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

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

Public Property Environment Amazon.CodeBuild.Model.ProjectEnvironment

Gets and sets the property Environment.

Information about the build environment for this build.

Public Property ExportedEnvironmentVariables System.Collections.Generic.List<Amazon.CodeBuild.Model.ExportedEnvironmentVariable>

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

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

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

Public Property Id System.String

Gets and sets the property Id.

The unique ID for the build.

Public Property Initiator System.String

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

Public Property Logs Amazon.CodeBuild.Model.LogsLocation

Gets and sets the property Logs.

Information about the build's logs in CloudWatch Logs.

Public Property NetworkInterface Amazon.CodeBuild.Model.NetworkInterface

Gets and sets the property NetworkInterface.

Describes a network interface.

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

Gets and sets the property Phases.

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

Public Property ProjectName System.String

Gets and sets the property ProjectName.

The name of the CodeBuild project.

Public Property QueuedTimeoutInMinutes System.Int32

Gets and sets the property QueuedTimeoutInMinutes.

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

Public Property ReportArns System.Collections.Generic.List<System.String>

Gets and sets the property ReportArns.

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

Public Property ResolvedSourceVersion System.String

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

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

Gets and sets the property SecondaryArtifacts.

An array of ProjectArtifacts objects.

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

Gets and sets the property SecondarySources.

An array of ProjectSource objects.

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 this build.

Public Property Source Amazon.CodeBuild.Model.ProjectSource

Gets and sets the property Source.

Information about the source code to be built.

Public Property SourceVersion System.String

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

Public Property StartTime System.DateTime

Gets and sets the property StartTime.

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

Public Property TimeoutInMinutes System.Int32

Gets and sets the property TimeoutInMinutes.

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

Public Property VpcConfig Amazon.CodeBuild.Model.VpcConfig

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5