software.amazon.awscdk.services.codebuild

Interface ProjectProps

All Superinterfaces:

CommonProjectProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ProjectProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.364Z")
 @Stability(value=Stable)
public interface ProjectProps
extends software.amazon.jsii.JsiiSerializable, CommonProjectProps

Example:

 Bucket bucket;
 Project project = Project.Builder.create(this, "MyProject")
         .buildSpec(BuildSpec.fromObject(Map.of(
                 "version", "0.2")))
         .artifacts(Artifacts.s3(S3ArtifactsProps.builder()
                 .bucket(bucket)
                 .includeBuildId(false)
                 .packageZip(true)
                 .path("another/path")
                 .identifier("AddArtifact1")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ProjectProps.Builder	builder()
default IArtifacts	getArtifacts() Defines where build artifacts will be stored.
default List<IArtifacts>	getSecondaryArtifacts() The secondary artifacts for the Project.
default List<ISource>	getSecondarySources() The secondary sources for the Project.
default ISource	getSource() The source of the build.

Methods inherited from interface software.amazon.awscdk.services.codebuild.CommonProjectProps

getAllowAllOutbound, getBadge, getBuildSpec, getCache, getCheckSecretsInPlainTextEnvVariables, getConcurrentBuildLimit, getDescription, getEncryptionKey, getEnvironment, getEnvironmentVariables, getFileSystemLocations, getGrantReportGroupPermissions, getLogging, getProjectName, getQueuedTimeout, getRole, getSecurityGroups, getSubnetSelection, getTimeout, getVpc

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArtifacts

@Stability(value=Stable)
 @Nullable
default IArtifacts getArtifacts()

Defines where build artifacts will be stored.

Could be: PipelineBuildArtifacts, NoArtifacts and S3Artifacts.

Default: NoArtifacts

getSecondaryArtifacts

@Stability(value=Stable)
 @Nullable
default List<IArtifacts> getSecondaryArtifacts()

The secondary artifacts for the Project.

Can also be added after the Project has been created by using the {@link Project#addSecondaryArtifact} method.

Default: - No secondary artifacts.

See Also:

https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html

getSecondarySources

@Stability(value=Stable)
 @Nullable
default List<ISource> getSecondarySources()

The secondary sources for the Project.

Can be also added after the Project has been created by using the {@link Project#addSecondarySource} method.

Default: - No secondary sources.

See Also:

https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html

getSource

@Stability(value=Stable)
 @Nullable
default ISource getSource()

The source of the build.

Note: if {@link NoSource} is given as the source, then you need to provide an explicit buildSpec.

Default: - NoSource

builder

@Stability(value=Stable)
static ProjectProps.Builder builder()

Specified by:

builder in interface CommonProjectProps

Returns:

a ProjectProps.Builder of ProjectProps