Package software.amazon.awscdk.services.codebuild

Interface CfnProject.ArtifactsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProject.ArtifactsProperty.Jsii$Proxy

Enclosing class:

CfnProject

@Stability(Stable)
public static interface CfnProject.ArtifactsProperty
extends software.amazon.jsii.JsiiSerializable

Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codebuild.*;
 ArtifactsProperty artifactsProperty = ArtifactsProperty.builder()
         .type("type")
         // the properties below are optional
         .artifactIdentifier("artifactIdentifier")
         .encryptionDisabled(false)
         .location("location")
         .name("name")
         .namespaceType("namespaceType")
         .overrideArtifactName(false)
         .packaging("packaging")
         .path("path")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProject.ArtifactsProperty.Builder	A builder for CfnProject.ArtifactsProperty
static final class	CfnProject.ArtifactsProperty.Jsii$Proxy	An implementation for CfnProject.ArtifactsProperty

Method Summary

Modifier and Type	Method	Description
static CfnProject.ArtifactsProperty.Builder	builder()
default String	getArtifactIdentifier()	An identifier for this artifact definition.
default Object	getEncryptionDisabled()	Set to true if you do not want your output artifacts encrypted.
default String	getLocation()	Information about the build output artifact location:.
default String	getName()	Along with path and namespaceType , the pattern that AWS CodeBuild uses to name and store the output artifact:.
default String	getNamespaceType()	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 , CodePipeline ignores this value if specified.
default Object	getOverrideArtifactName()	If set to true a name specified in the buildspec file overrides the artifact name.
default String	getPackaging()	The type of build output artifact to create:.
default String	getPath()	Along with namespaceType and name , the pattern that AWS CodeBuild uses to name and store the output artifact:.
String	getType()	The type of build output artifact.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

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

• CODEPIPELINE : The build project has build output generated through 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 S3.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-type

getArtifactIdentifier

@Stability(Stable)
@Nullable
default String getArtifactIdentifier()

An identifier for this artifact definition.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-artifactidentifier

getEncryptionDisabled

@Stability(Stable)
@Nullable
default Object getEncryptionDisabled()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-encryptiondisabled

getLocation

@Stability(Stable)
@Nullable
default String getLocation()

Information about the build output artifact location:.

• If type is set to CODEPIPELINE , AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of 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.

If you specify CODEPIPELINE or NO_ARTIFACTS for the Type property, don't specify this property. For all of the other types, you must specify this property.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-location

getName

@Stability(Stable)
@Nullable
default String getName()

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

If you specify CODEPIPELINE or NO_ARTIFACTS for the Type property, don't specify this property. For all of the other types, you must specify this property.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-name

getNamespaceType

@Stability(Stable)
@Nullable
default String getNamespaceType()

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 , CodePipeline ignores this value if specified.

This is because 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-namespacetype

getOverrideArtifactName

@Stability(Stable)
@Nullable
default Object getOverrideArtifactName()

If set to true 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-overrideartifactname

getPackaging

@Stability(Stable)
@Nullable
default String getPackaging()

The type of build output artifact to create:.

• If type is set to CODEPIPELINE , CodePipeline ignores this value if specified. This is because 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-packaging

getPath

@Stability(Stable)
@Nullable
default String getPath()

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

• If type is set to CODEPIPELINE , CodePipeline ignores this value if specified. This is because 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-path

builder

@Stability(Stable)
static CfnProject.ArtifactsProperty.Builder builder()

Returns:

a CfnProject.ArtifactsProperty.Builder of CfnProject.ArtifactsProperty