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 the build output artifacts for the build project.

Inheritance Hierarchy

System.Object
  Amazon.CodeBuild.Model.ProjectArtifacts

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

Syntax

C#
public class ProjectArtifacts

The ProjectArtifacts type exposes the following members

Constructors

NameDescription
Public Method ProjectArtifacts()

Properties

NameTypeDescription
Public Property Location System.String

Gets and sets the property Location.

Information about the build output artifact location, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, this is the name of the output bucket.

Public Property Name System.String

Gets and sets the property Name.

Along with path and namespaceType, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, this is the name of the output artifact object.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

Public Property NamespaceType Amazon.CodeBuild.ArtifactNamespace

Gets and sets the property NamespaceType.

Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, then valid values include:

    • BUILD_ID: Include the build ID in the location of the build output artifact.

    • NONE: Do not include the build ID. This is the default if namespaceType is not specified.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

Public Property Packaging Amazon.CodeBuild.ArtifactPackaging

Gets and sets the property Packaging.

The type of build output artifact to create, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, valid values include:

    • NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.

    • ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.

Public Property Path System.String

Gets and sets the property Path.

Along with namespaceType and name, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, this is the path to the output artifact. If path is not specified, then path will not be used.

For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip.

Public Property Type Amazon.CodeBuild.ArtifactsType

Gets and sets the property Type.

The type of build output artifact. Valid values include:

  • CODEPIPELINE: The build project will have build output generated through AWS CodePipeline.

  • NO_ARTIFACTS: The build project will not produce any build output.

  • S3: The build project will store build output in Amazon Simple Storage Service (Amazon S3).

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