Package software.amazon.awscdk.services.codebuild

Class Source

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codebuild.Source

All Implemented Interfaces:

ISource, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:07.328Z")
@Stability(Stable)
public abstract class Source
extends software.amazon.jsii.JsiiObject
implements ISource

Source provider definition for a CodeBuild Project.

Example:

 Bucket myCachingBucket;
 Project.Builder.create(this, "Project")
         .source(Source.bitBucket(BitBucketSourceProps.builder()
                 .owner("awslabs")
                 .repo("aws-cdk")
                 .build()))
         .cache(Cache.bucket(myCachingBucket))
         // BuildSpec with a 'cache' section necessary for S3 caching. This can
         // also come from 'buildspec.yml' in your source.
         .buildSpec(BuildSpec.fromObject(Map.of(
                 "version", "0.2",
                 "phases", Map.of(
                         "build", Map.of(
                                 "commands", List.of("..."))),
                 "cache", Map.of(
                         "paths", List.of("/root/cachedir/**/*")))))
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codebuild.ISource

ISource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Source(SourceProps props)
protected	Source(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Source(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
SourceConfig	bind(software.constructs.Construct _scope, IProject _project)	Called by the project when the source is added so that the source can perform binding operations on the source.
static ISource	bitBucket(BitBucketSourceProps props)
static ISource	codeCommit(CodeCommitSourceProps props)
Boolean	getBadgeSupported()
String	getIdentifier()
abstract String	getType()
static ISource	gitHub(GitHubSourceProps props)
static ISource	gitHubEnterprise(GitHubEnterpriseSourceProps props)
static ISource	s3(S3SourceProps props)

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Source

protected Source(software.amazon.jsii.JsiiObjectRef objRef)

Source

protected Source(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Source

@Stability(Stable)
protected Source(@NotNull
 SourceProps props)

Parameters:

props - This parameter is required.

Method Details

bitBucket

@Stability(Stable)
@NotNull
public static ISource bitBucket(@NotNull
 BitBucketSourceProps props)

Parameters:

props - This parameter is required.

codeCommit

@Stability(Stable)
@NotNull
public static ISource codeCommit(@NotNull
 CodeCommitSourceProps props)

Parameters:

props - This parameter is required.

gitHub

@Stability(Stable)
@NotNull
public static ISource gitHub(@NotNull
 GitHubSourceProps props)

Parameters:

props - This parameter is required.

gitHubEnterprise

@Stability(Stable)
@NotNull
public static ISource gitHubEnterprise(@NotNull
 GitHubEnterpriseSourceProps props)

Parameters:

props - This parameter is required.

s3

@Stability(Stable)
@NotNull
public static ISource s3(@NotNull
 S3SourceProps props)

Parameters:

props - This parameter is required.

bind

@Stability(Stable)
@NotNull
public SourceConfig bind(@NotNull
 software.constructs.Construct _scope,
 @NotNull
 IProject _project)

Called by the project when the source is added so that the source can perform binding operations on the source.

For example, it can grant permissions to the code build project to read from the S3 bucket.

Specified by:

bind in interface ISource

Parameters:

_scope - This parameter is required.

_project - This parameter is required.

getBadgeSupported

@Stability(Stable)
@NotNull
public Boolean getBadgeSupported()

Specified by:

getBadgeSupported in interface ISource

getType

@Stability(Stable)
@NotNull
public abstract String getType()

Specified by:

getType in interface ISource

getIdentifier

@Stability(Stable)
@Nullable
public String getIdentifier()

Specified by:

getIdentifier in interface ISource