AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::CodeBuild::Model::ProjectArtifacts Class Reference

#include <ProjectArtifacts.h>

Public Member Functions

 ProjectArtifacts ()
 
 ProjectArtifacts (Aws::Utils::Json::JsonView jsonValue)
 
ProjectArtifactsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const ArtifactsTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const ArtifactsType &value)
 
void SetType (ArtifactsType &&value)
 
ProjectArtifactsWithType (const ArtifactsType &value)
 
ProjectArtifactsWithType (ArtifactsType &&value)
 
const Aws::StringGetLocation () const
 
bool LocationHasBeenSet () const
 
void SetLocation (const Aws::String &value)
 
void SetLocation (Aws::String &&value)
 
void SetLocation (const char *value)
 
ProjectArtifactsWithLocation (const Aws::String &value)
 
ProjectArtifactsWithLocation (Aws::String &&value)
 
ProjectArtifactsWithLocation (const char *value)
 
const Aws::StringGetPath () const
 
bool PathHasBeenSet () const
 
void SetPath (const Aws::String &value)
 
void SetPath (Aws::String &&value)
 
void SetPath (const char *value)
 
ProjectArtifactsWithPath (const Aws::String &value)
 
ProjectArtifactsWithPath (Aws::String &&value)
 
ProjectArtifactsWithPath (const char *value)
 
const ArtifactNamespaceGetNamespaceType () const
 
bool NamespaceTypeHasBeenSet () const
 
void SetNamespaceType (const ArtifactNamespace &value)
 
void SetNamespaceType (ArtifactNamespace &&value)
 
ProjectArtifactsWithNamespaceType (const ArtifactNamespace &value)
 
ProjectArtifactsWithNamespaceType (ArtifactNamespace &&value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
ProjectArtifactsWithName (const Aws::String &value)
 
ProjectArtifactsWithName (Aws::String &&value)
 
ProjectArtifactsWithName (const char *value)
 
const ArtifactPackagingGetPackaging () const
 
bool PackagingHasBeenSet () const
 
void SetPackaging (const ArtifactPackaging &value)
 
void SetPackaging (ArtifactPackaging &&value)
 
ProjectArtifactsWithPackaging (const ArtifactPackaging &value)
 
ProjectArtifactsWithPackaging (ArtifactPackaging &&value)
 
bool GetOverrideArtifactName () const
 
bool OverrideArtifactNameHasBeenSet () const
 
void SetOverrideArtifactName (bool value)
 
ProjectArtifactsWithOverrideArtifactName (bool value)
 
bool GetEncryptionDisabled () const
 
bool EncryptionDisabledHasBeenSet () const
 
void SetEncryptionDisabled (bool value)
 
ProjectArtifactsWithEncryptionDisabled (bool value)
 
const Aws::StringGetArtifactIdentifier () const
 
bool ArtifactIdentifierHasBeenSet () const
 
void SetArtifactIdentifier (const Aws::String &value)
 
void SetArtifactIdentifier (Aws::String &&value)
 
void SetArtifactIdentifier (const char *value)
 
ProjectArtifactsWithArtifactIdentifier (const Aws::String &value)
 
ProjectArtifactsWithArtifactIdentifier (Aws::String &&value)
 
ProjectArtifactsWithArtifactIdentifier (const char *value)
 

Detailed Description

Information about the build output artifacts for the build project.

See Also:

AWS API Reference

Definition at line 35 of file ProjectArtifacts.h.

Constructor & Destructor Documentation

◆ ProjectArtifacts() [1/2]

Aws::CodeBuild::Model::ProjectArtifacts::ProjectArtifacts ( )

◆ ProjectArtifacts() [2/2]

Aws::CodeBuild::Model::ProjectArtifacts::ProjectArtifacts ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ArtifactIdentifierHasBeenSet()

bool Aws::CodeBuild::Model::ProjectArtifacts::ArtifactIdentifierHasBeenSet ( ) const
inline

An identifier for this artifact definition.

Definition at line 838 of file ProjectArtifacts.h.

◆ EncryptionDisabledHasBeenSet()

bool Aws::CodeBuild::Model::ProjectArtifacts::EncryptionDisabledHasBeenSet ( ) const
inline

Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown.

Definition at line 811 of file ProjectArtifacts.h.

◆ GetArtifactIdentifier()

const Aws::String& Aws::CodeBuild::Model::ProjectArtifacts::GetArtifactIdentifier ( ) const
inline

An identifier for this artifact definition.

Definition at line 833 of file ProjectArtifacts.h.

◆ GetEncryptionDisabled()

bool Aws::CodeBuild::Model::ProjectArtifacts::GetEncryptionDisabled ( ) const
inline

Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown.

Definition at line 803 of file ProjectArtifacts.h.

◆ GetLocation()

const Aws::String& Aws::CodeBuild::Model::ProjectArtifacts::GetLocation ( ) const
inline

Information about the build output artifact location:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

Definition at line 121 of file ProjectArtifacts.h.

◆ GetName()

const Aws::String& Aws::CodeBuild::Model::ProjectArtifacts::GetName ( ) const
inline

Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.

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 is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

  • If path is empty, namespaceType is set to NONE, and name is set to "<code>/</code>", the output artifact is stored in the root of the output bucket.

  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "<code>/</code>", the output artifact is stored in MyArtifacts/<build-ID>.

Definition at line 489 of file ProjectArtifacts.h.

◆ GetNamespaceType()

const ArtifactNamespace& Aws::CodeBuild::Model::ProjectArtifacts::GetNamespaceType ( ) const
inline

Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, 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, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

Definition at line 363 of file ProjectArtifacts.h.

◆ GetOverrideArtifactName()

bool Aws::CodeBuild::Model::ProjectArtifacts::GetOverrideArtifactName ( ) const
inline

If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.

Definition at line 770 of file ProjectArtifacts.h.

◆ GetPackaging()

const ArtifactPackaging& Aws::CodeBuild::Model::ProjectArtifacts::GetPackaging ( ) const
inline

The type of build output artifact to create:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

    • NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.

    • ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.

Definition at line 681 of file ProjectArtifacts.h.

◆ GetPath()

const Aws::String& Aws::CodeBuild::Model::ProjectArtifacts::GetPath ( ) const
inline

Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

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

Definition at line 223 of file ProjectArtifacts.h.

◆ GetType()

const ArtifactsType& Aws::CodeBuild::Model::ProjectArtifacts::GetType ( ) const
inline

The type of build output artifact. Valid values include:

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

    The CODEPIPELINE type is not supported for secondaryArtifacts.

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

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

Definition at line 53 of file ProjectArtifacts.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::CodeBuild::Model::ProjectArtifacts::Jsonize ( ) const

◆ LocationHasBeenSet()

bool Aws::CodeBuild::Model::ProjectArtifacts::LocationHasBeenSet ( ) const
inline

Information about the build output artifact location:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

Definition at line 133 of file ProjectArtifacts.h.

◆ NameHasBeenSet()

bool Aws::CodeBuild::Model::ProjectArtifacts::NameHasBeenSet ( ) const
inline

Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.

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 is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

  • If path is empty, namespaceType is set to NONE, and name is set to "<code>/</code>", the output artifact is stored in the root of the output bucket.

  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "<code>/</code>", the output artifact is stored in MyArtifacts/<build-ID>.

Definition at line 514 of file ProjectArtifacts.h.

◆ NamespaceTypeHasBeenSet()

bool Aws::CodeBuild::Model::ProjectArtifacts::NamespaceTypeHasBeenSet ( ) const
inline

Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, 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, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

Definition at line 383 of file ProjectArtifacts.h.

◆ operator=()

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OverrideArtifactNameHasBeenSet()

bool Aws::CodeBuild::Model::ProjectArtifacts::OverrideArtifactNameHasBeenSet ( ) const
inline

If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.

Definition at line 778 of file ProjectArtifacts.h.

◆ PackagingHasBeenSet()

bool Aws::CodeBuild::Model::ProjectArtifacts::PackagingHasBeenSet ( ) const
inline

The type of build output artifact to create:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

    • NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.

    • ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.

Definition at line 697 of file ProjectArtifacts.h.

◆ PathHasBeenSet()

bool Aws::CodeBuild::Model::ProjectArtifacts::PathHasBeenSet ( ) const
inline

Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

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

Definition at line 240 of file ProjectArtifacts.h.

◆ SetArtifactIdentifier() [1/3]

void Aws::CodeBuild::Model::ProjectArtifacts::SetArtifactIdentifier ( const Aws::String value)
inline

An identifier for this artifact definition.

Definition at line 843 of file ProjectArtifacts.h.

◆ SetArtifactIdentifier() [2/3]

void Aws::CodeBuild::Model::ProjectArtifacts::SetArtifactIdentifier ( Aws::String &&  value)
inline

An identifier for this artifact definition.

Definition at line 848 of file ProjectArtifacts.h.

◆ SetArtifactIdentifier() [3/3]

void Aws::CodeBuild::Model::ProjectArtifacts::SetArtifactIdentifier ( const char *  value)
inline

An identifier for this artifact definition.

Definition at line 853 of file ProjectArtifacts.h.

◆ SetEncryptionDisabled()

void Aws::CodeBuild::Model::ProjectArtifacts::SetEncryptionDisabled ( bool  value)
inline

Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown.

Definition at line 819 of file ProjectArtifacts.h.

◆ SetLocation() [1/3]

void Aws::CodeBuild::Model::ProjectArtifacts::SetLocation ( const Aws::String value)
inline

Information about the build output artifact location:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

Definition at line 145 of file ProjectArtifacts.h.

◆ SetLocation() [2/3]

void Aws::CodeBuild::Model::ProjectArtifacts::SetLocation ( Aws::String &&  value)
inline

Information about the build output artifact location:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

Definition at line 157 of file ProjectArtifacts.h.

◆ SetLocation() [3/3]

void Aws::CodeBuild::Model::ProjectArtifacts::SetLocation ( const char *  value)
inline

Information about the build output artifact location:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

Definition at line 169 of file ProjectArtifacts.h.

◆ SetName() [1/3]

void Aws::CodeBuild::Model::ProjectArtifacts::SetName ( const Aws::String value)
inline

Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.

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 is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

  • If path is empty, namespaceType is set to NONE, and name is set to "<code>/</code>", the output artifact is stored in the root of the output bucket.

  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "<code>/</code>", the output artifact is stored in MyArtifacts/<build-ID>.

Definition at line 539 of file ProjectArtifacts.h.

◆ SetName() [2/3]

void Aws::CodeBuild::Model::ProjectArtifacts::SetName ( Aws::String &&  value)
inline

Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.

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 is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

  • If path is empty, namespaceType is set to NONE, and name is set to "<code>/</code>", the output artifact is stored in the root of the output bucket.

  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "<code>/</code>", the output artifact is stored in MyArtifacts/<build-ID>.

Definition at line 564 of file ProjectArtifacts.h.

◆ SetName() [3/3]

void Aws::CodeBuild::Model::ProjectArtifacts::SetName ( const char *  value)
inline

Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.

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 is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

  • If path is empty, namespaceType is set to NONE, and name is set to "<code>/</code>", the output artifact is stored in the root of the output bucket.

  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "<code>/</code>", the output artifact is stored in MyArtifacts/<build-ID>.

Definition at line 589 of file ProjectArtifacts.h.

◆ SetNamespaceType() [1/2]

void Aws::CodeBuild::Model::ProjectArtifacts::SetNamespaceType ( const ArtifactNamespace value)
inline

Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, 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, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

Definition at line 403 of file ProjectArtifacts.h.

◆ SetNamespaceType() [2/2]

void Aws::CodeBuild::Model::ProjectArtifacts::SetNamespaceType ( ArtifactNamespace &&  value)
inline

Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, 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, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

Definition at line 423 of file ProjectArtifacts.h.

◆ SetOverrideArtifactName()

void Aws::CodeBuild::Model::ProjectArtifacts::SetOverrideArtifactName ( bool  value)
inline

If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.

Definition at line 786 of file ProjectArtifacts.h.

◆ SetPackaging() [1/2]

void Aws::CodeBuild::Model::ProjectArtifacts::SetPackaging ( const ArtifactPackaging value)
inline

The type of build output artifact to create:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

    • NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.

    • ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.

Definition at line 713 of file ProjectArtifacts.h.

◆ SetPackaging() [2/2]

void Aws::CodeBuild::Model::ProjectArtifacts::SetPackaging ( ArtifactPackaging &&  value)
inline

The type of build output artifact to create:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

    • NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.

    • ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.

Definition at line 729 of file ProjectArtifacts.h.

◆ SetPath() [1/3]

void Aws::CodeBuild::Model::ProjectArtifacts::SetPath ( const Aws::String value)
inline

Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

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

Definition at line 257 of file ProjectArtifacts.h.

◆ SetPath() [2/3]

void Aws::CodeBuild::Model::ProjectArtifacts::SetPath ( Aws::String &&  value)
inline

Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

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

Definition at line 274 of file ProjectArtifacts.h.

◆ SetPath() [3/3]

void Aws::CodeBuild::Model::ProjectArtifacts::SetPath ( const char *  value)
inline

Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

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

Definition at line 291 of file ProjectArtifacts.h.

◆ SetType() [1/2]

void Aws::CodeBuild::Model::ProjectArtifacts::SetType ( const ArtifactsType value)
inline

The type of build output artifact. Valid values include:

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

    The CODEPIPELINE type is not supported for secondaryArtifacts.

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

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

Definition at line 75 of file ProjectArtifacts.h.

◆ SetType() [2/2]

void Aws::CodeBuild::Model::ProjectArtifacts::SetType ( ArtifactsType &&  value)
inline

The type of build output artifact. Valid values include:

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

    The CODEPIPELINE type is not supported for secondaryArtifacts.

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

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

Definition at line 86 of file ProjectArtifacts.h.

◆ TypeHasBeenSet()

bool Aws::CodeBuild::Model::ProjectArtifacts::TypeHasBeenSet ( ) const
inline

The type of build output artifact. Valid values include:

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

    The CODEPIPELINE type is not supported for secondaryArtifacts.

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

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

Definition at line 64 of file ProjectArtifacts.h.

◆ WithArtifactIdentifier() [1/3]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithArtifactIdentifier ( const Aws::String value)
inline

An identifier for this artifact definition.

Definition at line 858 of file ProjectArtifacts.h.

◆ WithArtifactIdentifier() [2/3]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithArtifactIdentifier ( Aws::String &&  value)
inline

An identifier for this artifact definition.

Definition at line 863 of file ProjectArtifacts.h.

◆ WithArtifactIdentifier() [3/3]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithArtifactIdentifier ( const char *  value)
inline

An identifier for this artifact definition.

Definition at line 868 of file ProjectArtifacts.h.

◆ WithEncryptionDisabled()

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithEncryptionDisabled ( bool  value)
inline

Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown.

Definition at line 827 of file ProjectArtifacts.h.

◆ WithLocation() [1/3]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithLocation ( const Aws::String value)
inline

Information about the build output artifact location:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

Definition at line 181 of file ProjectArtifacts.h.

◆ WithLocation() [2/3]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithLocation ( Aws::String &&  value)
inline

Information about the build output artifact location:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

Definition at line 193 of file ProjectArtifacts.h.

◆ WithLocation() [3/3]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithLocation ( const char *  value)
inline

Information about the build output artifact location:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

Definition at line 205 of file ProjectArtifacts.h.

◆ WithName() [1/3]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithName ( const Aws::String value)
inline

Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.

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 is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

  • If path is empty, namespaceType is set to NONE, and name is set to "<code>/</code>", the output artifact is stored in the root of the output bucket.

  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "<code>/</code>", the output artifact is stored in MyArtifacts/<build-ID>.

Definition at line 614 of file ProjectArtifacts.h.

◆ WithName() [2/3]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithName ( Aws::String &&  value)
inline

Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.

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 is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

  • If path is empty, namespaceType is set to NONE, and name is set to "<code>/</code>", the output artifact is stored in the root of the output bucket.

  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "<code>/</code>", the output artifact is stored in MyArtifacts/<build-ID>.

Definition at line 639 of file ProjectArtifacts.h.

◆ WithName() [3/3]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithName ( const char *  value)
inline

Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.

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 is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

  • If path is empty, namespaceType is set to NONE, and name is set to "<code>/</code>", the output artifact is stored in the root of the output bucket.

  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "<code>/</code>", the output artifact is stored in MyArtifacts/<build-ID>.

Definition at line 664 of file ProjectArtifacts.h.

◆ WithNamespaceType() [1/2]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithNamespaceType ( const ArtifactNamespace value)
inline

Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, 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, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

Definition at line 443 of file ProjectArtifacts.h.

◆ WithNamespaceType() [2/2]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithNamespaceType ( ArtifactNamespace &&  value)
inline

Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, 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, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

Definition at line 463 of file ProjectArtifacts.h.

◆ WithOverrideArtifactName()

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithOverrideArtifactName ( bool  value)
inline

If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.

Definition at line 794 of file ProjectArtifacts.h.

◆ WithPackaging() [1/2]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithPackaging ( const ArtifactPackaging value)
inline

The type of build output artifact to create:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

    • NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.

    • ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.

Definition at line 745 of file ProjectArtifacts.h.

◆ WithPackaging() [2/2]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithPackaging ( ArtifactPackaging &&  value)
inline

The type of build output artifact to create:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

    • NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.

    • ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.

Definition at line 761 of file ProjectArtifacts.h.

◆ WithPath() [1/3]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithPath ( const Aws::String value)
inline

Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

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

Definition at line 308 of file ProjectArtifacts.h.

◆ WithPath() [2/3]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithPath ( Aws::String &&  value)
inline

Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

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

Definition at line 325 of file ProjectArtifacts.h.

◆ WithPath() [3/3]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithPath ( const char *  value)
inline

Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.

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

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

Definition at line 342 of file ProjectArtifacts.h.

◆ WithType() [1/2]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithType ( const ArtifactsType value)
inline

The type of build output artifact. Valid values include:

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

    The CODEPIPELINE type is not supported for secondaryArtifacts.

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

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

Definition at line 97 of file ProjectArtifacts.h.

◆ WithType() [2/2]

ProjectArtifacts& Aws::CodeBuild::Model::ProjectArtifacts::WithType ( ArtifactsType &&  value)
inline

The type of build output artifact. Valid values include:

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

    The CODEPIPELINE type is not supported for secondaryArtifacts.

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

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

Definition at line 108 of file ProjectArtifacts.h.


The documentation for this class was generated from the following file: