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 CreateProject operation. Creates a build project.

Inheritance Hierarchy

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

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

Syntax

C#
public class CreateProjectRequest : AmazonCodeBuildRequest
         IAmazonWebServiceRequest

The CreateProjectRequest type exposes the following members

Constructors

NameDescription
Public Method CreateProjectRequest()

Properties

NameTypeDescription
Public Property Artifacts Amazon.CodeBuild.Model.ProjectArtifacts

Gets and sets the property Artifacts.

Information about the build output artifacts for the build project.

Public Property BadgeEnabled System.Boolean

Gets and sets the property BadgeEnabled.

Set this to true to generate a publicly accessible URL for your project's build badge.

Public Property BuildBatchConfig Amazon.CodeBuild.Model.ProjectBuildBatchConfig

Gets and sets the property BuildBatchConfig.

A ProjectBuildBatchConfig object that defines the batch build options for the project.

Public Property Cache Amazon.CodeBuild.Model.ProjectCache

Gets and sets the property Cache.

Stores recently used information so that it can be quickly accessed at a later time.

Public Property ConcurrentBuildLimit System.Int32

Gets and sets the property ConcurrentBuildLimit.

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

Public Property Description System.String

Gets and sets the property Description.

A description that makes the build project easy to identify.

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 Environment Amazon.CodeBuild.Model.ProjectEnvironment

Gets and sets the property Environment.

Information about the build environment for the build project.

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 LogsConfig Amazon.CodeBuild.Model.LogsConfig

Gets and sets the property LogsConfig.

Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.

Public Property Name System.String

Gets and sets the property Name.

The name of the build 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 SecondaryArtifacts System.Collections.Generic.List<Amazon.CodeBuild.Model.ProjectArtifacts>

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. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level).

Public Property ServiceRole System.String

Gets and sets the property ServiceRole.

The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

Public Property Source Amazon.CodeBuild.Model.ProjectSource

Gets and sets the property Source.

Information about the build input source code for 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 project. If not specified, the latest version is used. If specified, it 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.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

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

Public Property Tags System.Collections.Generic.List<Amazon.CodeBuild.Model.Tag>

Gets and sets the property Tags.

A list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

Public Property TimeoutInMinutes System.Int32

Gets and sets the property TimeoutInMinutes.

How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.

Public Property VpcConfig Amazon.CodeBuild.Model.VpcConfig

Gets and sets the property VpcConfig.

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

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