software.amazon.awscdk.services.codebuild

Interface GitHubSourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SourceProps

All Known Implementing Classes:

GitHubSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:54.197Z")
 @Stability(value=Experimental)
public interface GitHubSourceProps
extends software.amazon.jsii.JsiiSerializable, SourceProps

(experimental) Construction properties for GitHubSource and GitHubEnterpriseSource.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static GitHubSourceProps.Builder	builder()
default String	getBranchOrRef() (experimental) 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() (experimental) The depth of history to download.
default Boolean	getFetchSubmodules() (experimental) Whether to fetch submodules while cloning git repo.
String	getOwner() (experimental) The GitHub account/user that owns the repo.
String	getRepo() (experimental) The name of the repo (without the username).
default Boolean	getReportBuildStatus() (experimental) Whether to send notifications on your build's start and end.
default Boolean	getWebhook() (experimental) Whether to create a webhook that will trigger a build every time an event happens in the repository.
default List<FilterGroup>	getWebhookFilters() (experimental) A list of webhook filters that can constraint what events in the repository will trigger a build.
default Boolean	getWebhookTriggersBatchBuild() (experimental) Trigger a batch build from a webhook instead of a standard one.

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

getIdentifier

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getOwner

@Stability(value=Experimental)
 @NotNull
String getOwner()

(experimental) The GitHub account/user that owns the repo.

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 "awslabs";

getRepo

@Stability(value=Experimental)
 @NotNull
String getRepo()

(experimental) The name of the repo (without the username).

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 "aws-cdk";

getBranchOrRef

@Stability(value=Experimental)
 @Nullable
default String getBranchOrRef()

(experimental) 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:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 "mybranch";

getCloneDepth

@Stability(value=Experimental)
 @Nullable
default Number getCloneDepth()

(experimental) 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(value=Experimental)
 @Nullable
default Boolean getFetchSubmodules()

(experimental) Whether to fetch submodules while cloning git repo.

Default: false

getReportBuildStatus

@Stability(value=Experimental)
 @Nullable
default Boolean getReportBuildStatus()

(experimental) Whether to send notifications on your build's start and end.

Default: true

getWebhook

@Stability(value=Experimental)
 @Nullable
default Boolean getWebhook()

(experimental) Whether to create a webhook that will trigger a build every time an event happens in the repository.

Default: true if any `webhookFilters` were provided, false otherwise

getWebhookFilters

@Stability(value=Experimental)
 @Nullable
default List<FilterGroup> getWebhookFilters()

(experimental) A list of webhook filters that can constraint what events in the repository will trigger a build.

A build is triggered if any of the provided filter groups match. Only valid if webhook was not provided as false.

Default: every push and every Pull Request (create or update) triggers a build

getWebhookTriggersBatchBuild

@Stability(value=Experimental)
 @Nullable
default Boolean getWebhookTriggersBatchBuild()

(experimental) Trigger a batch build from a webhook instead of a standard one.

Enabling this will enable batch builds on the CodeBuild project.

Default: false

builder

@Stability(value=Experimental)
static GitHubSourceProps.Builder builder()

Specified by:

builder in interface SourceProps

Returns:

a GitHubSourceProps.Builder of GitHubSourceProps