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.

Container for the parameters to the StartBuild operation. Starts running a build.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CodeBuild.AmazonCodeBuildRequest
      Amazon.CodeBuild.Model.StartBuildRequest

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

Syntax

C#
public class StartBuildRequest : AmazonCodeBuildRequest
         IAmazonWebServiceRequest

The StartBuildRequest type exposes the following members

Constructors

NameDescription
Public Method StartBuildRequest()

Properties

NameTypeDescription
Public Property ArtifactsOverride Amazon.CodeBuild.Model.ProjectArtifacts

Gets and sets the property ArtifactsOverride.

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

Public Property BuildspecOverride System.String

Gets and sets the property BuildspecOverride.

A build spec declaration that overrides, for this build only, the latest one already defined in the build project.

Public Property CacheOverride Amazon.CodeBuild.Model.ProjectCache

Gets and sets the property CacheOverride.

A ProjectCache object specified for this build that overrides the one defined in the build project.

Public Property CertificateOverride System.String

Gets and sets the property CertificateOverride.

The name of a certificate for this build that overrides the one specified in the build project.

Public Property ComputeTypeOverride Amazon.CodeBuild.ComputeType

Gets and sets the property ComputeTypeOverride.

The name of a compute type for this build that overrides the one specified in the build project.

Public Property EnvironmentTypeOverride Amazon.CodeBuild.EnvironmentType

Gets and sets the property EnvironmentTypeOverride.

A container type for this build that overrides the one specified in the build project.

Public Property EnvironmentVariablesOverride System.Collections.Generic.List<Amazon.CodeBuild.Model.EnvironmentVariable>

Gets and sets the property EnvironmentVariablesOverride.

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Public Property GitCloneDepthOverride System.Int32

Gets and sets the property GitCloneDepthOverride.

The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.

Public Property IdempotencyToken System.String

Gets and sets the property IdempotencyToken.

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

Public Property ImageOverride System.String

Gets and sets the property ImageOverride.

The name of an image for this build that overrides the one specified in the build project.

Public Property InsecureSslOverride System.Boolean

Gets and sets the property InsecureSslOverride.

Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

Public Property PrivilegedModeOverride System.Boolean

Gets and sets the property PrivilegedModeOverride.

Enable this flag to override privileged mode in the build project.

Public Property ProjectName System.String

Gets and sets the property ProjectName.

The name of the AWS CodeBuild build project to start running a build.

Public Property ReportBuildStatusOverride System.Boolean

Gets and sets the property ReportBuildStatusOverride.

Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, an invalidInputException is thrown.

Public Property ServiceRoleOverride System.String

Gets and sets the property ServiceRoleOverride.

The name of a service role for this build that overrides the one specified in the build project.

Public Property SourceAuthOverride Amazon.CodeBuild.Model.SourceAuth

Gets and sets the property SourceAuthOverride.

An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.

Public Property SourceLocationOverride System.String

Gets and sets the property SourceLocationOverride.

A location that overrides for this build the source location for the one defined in the build project.

Public Property SourceTypeOverride Amazon.CodeBuild.SourceType

Gets and sets the property SourceTypeOverride.

A source input type for this build that overrides the source input defined in the build project

Public Property SourceVersion System.String

Gets and sets the property SourceVersion.

A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:

  • For AWS CodeCommit: the commit ID 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 will be used. If not specified, the default branch's HEAD commit ID will be 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 will be used. If not specified, the default branch's HEAD commit ID will be used.

  • For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.

Public Property TimeoutInMinutesOverride System.Int32

Gets and sets the property TimeoutInMinutesOverride.

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms