interface GithubRepositoryProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.AppRunner.Alpha.GithubRepositoryProps
Go	github.com/aws/aws-cdk-go/awscdkapprunneralpha/v2#GithubRepositoryProps
Java	software.amazon.awscdk.services.apprunner.alpha.GithubRepositoryProps
Python	aws_cdk.aws_apprunner_alpha.GithubRepositoryProps
TypeScript (source)	@aws-cdk/aws-apprunner-alpha » GithubRepositoryProps

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

Example

new apprunner.Service(this, 'Service', {
  source: apprunner.Source.fromGitHub({
    repositoryUrl: 'https://github.com/aws-containers/hello-app-runner',
    branch: 'main',
    configurationSource: apprunner.ConfigurationSourceType.REPOSITORY,
    connection: apprunner.GitHubConnection.fromConnectionArn('CONNECTION_ARN'),
  }),
});

Properties

Name	Type	Description
configurationSource🔹	ConfigurationSourceType	The source of the App Runner configuration.
connection🔹	GitHubConnection	ARN of the connection to Github.
repositoryUrl🔹	string	The location of the repository that contains the source code.
branch?🔹	string	The branch name that represents a specific version for the repository.
codeConfigurationValues?🔹	CodeConfigurationValues	The code configuration values.

---

configurationSource🔹

Type: ConfigurationSourceType

The source of the App Runner configuration.

---

connection🔹

Type: GitHubConnection

ARN of the connection to Github.

Only required for Github source.

---

repositoryUrl🔹

Type: string

The location of the repository that contains the source code.

---

branch?🔹

Type: string (optional, default: main)

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

---

codeConfigurationValues?🔹

Type: CodeConfigurationValues (optional, default: no values will be passed. The apprunner.yaml from the github reopsitory will be used instead.)

The code configuration values.

Will be ignored if configurationSource is REPOSITORY.