Package 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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:41.840Z")
@Stability(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	Description
static final class	ProjectProps.Builder	A builder for ProjectProps
static final class	ProjectProps.Jsii$Proxy	An implementation for ProjectProps

Method Summary

Modifier and Type	Method	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 Details

getArtifacts

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

Defines where build artifacts will be stored.

Could be: PipelineBuildArtifacts, NoArtifacts and S3Artifacts.

Default: NoArtifacts

getSecondaryArtifacts

@Stability(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 Project.addSecondaryArtifact(software.amazon.awscdk.services.codebuild.IArtifacts) method.

Default: - No secondary artifacts.

See Also:

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

getSecondarySources

@Stability(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 Project.addSecondarySource(software.amazon.awscdk.services.codebuild.ISource) method.

Default: - No secondary sources.

See Also:

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

getSource

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

The source of the build.

*Note*: if NoSource is given as the source, then you need to provide an explicit `buildSpec`.

Default: - NoSource

builder

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

Returns:

a ProjectProps.Builder of ProjectProps