Package software.amazon.awscdk.services.apprunner.alpha

Interface GithubRepositoryProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GithubRepositoryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:18.719Z")
@Stability(Experimental)
public interface GithubRepositoryProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties of the Github repository for Source.fromGitHub().

Example:

 Service.Builder.create(this, "Service")
         .source(Source.fromGitHub(GithubRepositoryProps.builder()
                 .repositoryUrl("https://github.com/aws-containers/hello-app-runner")
                 .branch("main")
                 .configurationSource(ConfigurationSourceType.REPOSITORY)
                 .connection(GitHubConnection.fromConnectionArn("CONNECTION_ARN"))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GithubRepositoryProps.Builder	builder()
default String	getBranch()	(experimental) The branch name that represents a specific version for the repository.
default CodeConfigurationValues	getCodeConfigurationValues()	(experimental) The code configuration values.
ConfigurationSourceType	getConfigurationSource()	(experimental) The source of the App Runner configuration.
GitHubConnection	getConnection()	(experimental) ARN of the connection to Github.
String	getRepositoryUrl()	(experimental) The location of the repository that contains the source code.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfigurationSource

@Stability(Experimental)
@NotNull
ConfigurationSourceType getConfigurationSource()

(experimental) The source of the App Runner configuration.

getConnection

@Stability(Experimental)
@NotNull
GitHubConnection getConnection()

(experimental) ARN of the connection to Github.

Only required for Github source.

getRepositoryUrl

@Stability(Experimental)
@NotNull
String getRepositoryUrl()

(experimental) The location of the repository that contains the source code.

getBranch

@Stability(Experimental)
@Nullable
default String getBranch()

(experimental) The branch name that represents a specific version for the repository.

Default: main

getCodeConfigurationValues

@Stability(Experimental)
@Nullable
default CodeConfigurationValues getCodeConfigurationValues()

(experimental) The code configuration values.

Will be ignored if configurationSource is REPOSITORY.

Default: - no values will be passed. The `apprunner.yaml` from the github reopsitory will be used instead.

builder

@Stability(Experimental)
static GithubRepositoryProps.Builder builder()

Returns:

a GithubRepositoryProps.Builder of GithubRepositoryProps