software.amazon.awssdk.services.codebuild.model

Interface ProjectArtifacts.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ProjectArtifacts.Builder,ProjectArtifacts>, SdkBuilder<ProjectArtifacts.Builder,ProjectArtifacts>, SdkPojo

Enclosing class:

ProjectArtifacts

public static interface ProjectArtifacts.Builder
extends SdkPojo, CopyableBuilder<ProjectArtifacts.Builder,ProjectArtifacts>

Method Summary

Modifier and Type	Method and Description
ProjectArtifacts.Builder	artifactIdentifier(String artifactIdentifier) An identifier for this artifact definition.
ProjectArtifacts.Builder	encryptionDisabled(Boolean encryptionDisabled) Set to true if you do not want your output artifacts encrypted.
ProjectArtifacts.Builder	location(String location) Information about the build output artifact location:
ProjectArtifacts.Builder	name(String name) Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:
ProjectArtifacts.Builder	namespaceType(ArtifactNamespace namespaceType) Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:
ProjectArtifacts.Builder	namespaceType(String namespaceType) Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:
ProjectArtifacts.Builder	overrideArtifactName(Boolean overrideArtifactName) If this flag is set, a name specified in the build spec file overrides the artifact name.
ProjectArtifacts.Builder	packaging(ArtifactPackaging packaging) The type of build output artifact to create:
ProjectArtifacts.Builder	packaging(String packaging) The type of build output artifact to create:
ProjectArtifacts.Builder	path(String path) Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:
ProjectArtifacts.Builder	type(ArtifactsType type) The type of build output artifact.
ProjectArtifacts.Builder	type(String type) The type of build output artifact.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

type

ProjectArtifacts.Builder type(String type)

The type of build output artifact. Valid values include:

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

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

Parameters:

type - The type of build output artifact. Valid values include:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ArtifactsType, ArtifactsType

type

ProjectArtifacts.Builder type(ArtifactsType type)

The type of build output artifact. Valid values include:

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

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

Parameters:

type - The type of build output artifact. Valid values include:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ArtifactsType, ArtifactsType

location

ProjectArtifacts.Builder location(String location)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

path

ProjectArtifacts.Builder path(String path)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

namespaceType

ProjectArtifacts.Builder namespaceType(String namespaceType)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ArtifactNamespace, ArtifactNamespace

namespaceType

ProjectArtifacts.Builder namespaceType(ArtifactNamespace namespaceType)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ArtifactNamespace, ArtifactNamespace

name

ProjectArtifacts.Builder name(String name)

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 "/", 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 "/", the output artifact is stored in MyArtifacts/build-ID .

Parameters:

name - 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 "/", 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 "/", the output artifact is stored in MyArtifacts/build-ID .

Returns:

Returns a reference to this object so that method calls can be chained together.

packaging

ProjectArtifacts.Builder packaging(String packaging)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ArtifactPackaging, ArtifactPackaging

packaging

ProjectArtifacts.Builder packaging(ArtifactPackaging packaging)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ArtifactPackaging, ArtifactPackaging

overrideArtifactName

ProjectArtifacts.Builder overrideArtifactName(Boolean overrideArtifactName)

If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec 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.

Parameters:

overrideArtifactName - If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionDisabled

ProjectArtifacts.Builder encryptionDisabled(Boolean encryptionDisabled)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

artifactIdentifier

ProjectArtifacts.Builder artifactIdentifier(String artifactIdentifier)

An identifier for this artifact definition.

Parameters:

artifactIdentifier - An identifier for this artifact definition.

Returns:

Returns a reference to this object so that method calls can be chained together.