software.amazon.awscdk.services.codebuild

Interface GitHubEnterpriseSourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SourceProps

All Known Implementing Classes:

GitHubEnterpriseSourceProps.Jsii$Proxy

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

Construction properties for GitHubEnterpriseSource.

Example:

 Project.Builder.create(this, "Project")
         .source(Source.gitHubEnterprise(GitHubEnterpriseSourceProps.builder()
                 .httpsCloneUrl("https://my-github-enterprise.com/owner/repo")
                 .build()))
         // Enable Docker AND custom caching
         .cache(Cache.local(LocalCacheMode.DOCKER_LAYER, LocalCacheMode.CUSTOM))
         // BuildSpec with a 'cache' section necessary for 'CUSTOM' 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

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

Method Summary

Modifier and Type	Method and Description
static GitHubEnterpriseSourceProps.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 String	getBuildStatusContext() This parameter is used for the `context` parameter in the GitHub commit status.
default String	getBuildStatusUrl() The URL that the build will report back to the source provider.
default Number	getCloneDepth() The depth of history to download.
default Boolean	getFetchSubmodules() Whether to fetch submodules while cloning git repo.
String	getHttpsCloneUrl() The HTTPS URL of the repository in your GitHub Enterprise installation.
default Boolean	getIgnoreSslErrors() Whether to ignore SSL errors when connecting to the repository.
default Boolean	getReportBuildStatus() Whether to send notifications on your build's start and end.
default Boolean	getWebhook() Whether to create a webhook that will trigger a build every time an event happens in the repository.
default List<FilterGroup>	getWebhookFilters() A list of webhook filters that can constraint what events in the repository will trigger a build.
default Boolean	getWebhookTriggersBatchBuild() 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

getHttpsCloneUrl

@Stability(value=Stable)
 @NotNull
String getHttpsCloneUrl()

The HTTPS URL of the repository in your GitHub Enterprise installation.

getBranchOrRef

@Stability(value=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";
 

getBuildStatusContext

@Stability(value=Stable)
 @Nullable
default String getBuildStatusContext()

This parameter is used for the `context` parameter in the GitHub commit status.

Can use built-in CodeBuild variables, like $AWS_REGION.

Default: "AWS CodeBuild $AWS_REGION ($PROJECT_NAME)"

Example:

 "My build #$CODEBUILD_BUILD_NUMBER";
 

See Also:

https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html

getBuildStatusUrl

@Stability(value=Stable)
 @Nullable
default String getBuildStatusUrl()

The URL that the build will report back to the source provider.

Can use built-in CodeBuild variables, like $AWS_REGION.

Default: - link to the AWS Console for CodeBuild to a particular build execution

Example:

 "$CODEBUILD_PUBLIC_BUILD_URL";
 

See Also:

https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html

getCloneDepth

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

Whether to fetch submodules while cloning git repo.

Default: false

getIgnoreSslErrors

@Stability(value=Stable)
 @Nullable
default Boolean getIgnoreSslErrors()

Whether to ignore SSL errors when connecting to the repository.

Default: false

getReportBuildStatus

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

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

Default: true

getWebhook

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

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=Stable)
 @Nullable
default List<FilterGroup> getWebhookFilters()

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=Stable)
 @Nullable
default Boolean getWebhookTriggersBatchBuild()

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=Stable)
static GitHubEnterpriseSourceProps.Builder builder()

Specified by:

builder in interface SourceProps

Returns:

a GitHubEnterpriseSourceProps.Builder of GitHubEnterpriseSourceProps