Package software.amazon.awscdk.services.codebuild

Interface CodeCommitSourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SourceProps

All Known Implementing Classes:

CodeCommitSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:11.972Z")
@Stability(Stable)
public interface CodeCommitSourceProps
extends software.amazon.jsii.JsiiSerializable, SourceProps

Construction properties for CodeCommitSource.

Example:

 import software.amazon.awscdk.services.codecommit.*;
 Repository repo;
 Bucket bucket;
 Project project = Project.Builder.create(this, "MyProject")
         .secondarySources(List.of(Source.codeCommit(CodeCommitSourceProps.builder()
                 .identifier("source2")
                 .repository(repo)
                 .build())))
         .secondaryArtifacts(List.of(Artifacts.s3(S3ArtifactsProps.builder()
                 .identifier("artifact2")
                 .bucket(bucket)
                 .path("some/path")
                 .name("file.zip")
                 .build())))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CodeCommitSourceProps.Builder	builder()
default String	getBranchOrRef()	The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build.
default Number	getCloneDepth()	The depth of history to download.
default Boolean	getFetchSubmodules()	Whether to fetch submodules while cloning git repo.
IRepository	getRepository()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getIdentifier

Method Details

getRepository

@Stability(Stable)
@NotNull
IRepository getRepository()

getBranchOrRef

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

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build.

Default: the default branch's HEAD commit ID is used

Example:

 "mybranch";
 

getCloneDepth

@Stability(Stable)
@Nullable
default Number getCloneDepth()

The depth of history to download.

Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build of the project.

getFetchSubmodules

@Stability(Stable)
@Nullable
default Boolean getFetchSubmodules()

Whether to fetch submodules while cloning git repo.

Default: false

builder

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

Returns:

a CodeCommitSourceProps.Builder of CodeCommitSourceProps