@aws-cdk_aws-apprunner-alpha.GithubRepositoryProps

interface GithubRepositoryProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.AppRunner.Alpha.GithubRepositoryProps
Gogithub.com/aws/aws-cdk-go/awscdkapprunneralpha/v2#GithubRepositoryProps
Javasoftware.amazon.awscdk.services.apprunner.alpha.GithubRepositoryProps
Pythonaws_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

NameTypeDescription
configurationSource๐Ÿ”นConfigurationSourceTypeThe source of the App Runner configuration.
connection๐Ÿ”นGitHubConnectionARN of the connection to Github.
repositoryUrl๐Ÿ”นstringThe location of the repository that contains the source code.
branch?๐Ÿ”นstringThe branch name that represents a specific version for the repository.
codeConfigurationValues?๐Ÿ”นCodeConfigurationValuesThe 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.