AWS CDK Reference

Appearance

v2.277.0

Experimental

@aws-cdk/aws-apprunner-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

GithubRepositoryProps Struct ​

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

Stability
Experimental
Source
lib/service.ts

Example ​

ts
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'),
  }),
});
python
apprunner.Service(self, "Service",
    source=apprunner.Source.from_git_hub(
        repository_url="https://github.com/aws-containers/hello-app-runner",
        branch="main",
        configuration_source=apprunner.ConfigurationSourceType.REPOSITORY,
        connection=apprunner.GitHubConnection.from_connection_arn("CONNECTION_ARN")
    )
)
java
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();
csharp
// Install: dotnet add package Amazon.CDK.AWS.AppRunner.Alpha
new Service(this, "Service", new ServiceProps {
    Source = Source.FromGitHub(new GithubRepositoryProps {
        RepositoryUrl = "https://github.com/aws-containers/hello-app-runner",
        Branch = "main",
        ConfigurationSource = ConfigurationSourceType.REPOSITORY,
        Connection = GitHubConnection.FromConnectionArn("CONNECTION_ARN")
    })
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkapprunneralpha/v2
apprunner.NewService(this, jsii.String("Service"), &ServiceProps{
	Source: apprunner.Source_FromGitHub(&GithubRepositoryProps{
		RepositoryUrl: jsii.String("https://github.com/aws-containers/hello-app-runner"),
		Branch: jsii.String("main"),
		ConfigurationSource: apprunner.ConfigurationSourceType_REPOSITORY,
		Connection: apprunner.GitHubConnection_FromConnectionArn(jsii.String("CONNECTION_ARN")),
	}),
})

Properties ​

branchoptionalstringbranchoptionalstrbranchoptionalStringBranchoptionalstringBranchoptional*string= main#
The branch name that represents a specific version for the repository.
codeConfigurationValuesoptionalCodeConfigurationValuescode_configuration_valuesoptionalCodeConfigurationValuescodeConfigurationValuesoptionalCodeConfigurationValuesCodeConfigurationValuesoptionalCodeConfigurationValuesCodeConfigurationValuesoptionalCodeConfigurationValues#
The code configuration values.

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

Will be ignored if configurationSource is REPOSITORY.

configurationSourceConfigurationSourceTypeconfiguration_sourceConfigurationSourceTypeconfigurationSourceConfigurationSourceTypeConfigurationSourceConfigurationSourceTypeConfigurationSourceConfigurationSourceTyperequired#
The source of the App Runner configuration.
connectionGitHubConnectionconnectionGitHubConnectionconnectionGitHubConnectionConnectionGitHubConnectionConnectionGitHubConnectionrequired#
ARN of the connection to Github.

Only required for Github source.

repositoryUrlstringrepository_urlstrrepositoryUrlStringRepositoryUrlstringRepositoryUrl*stringrequired#
The location of the repository that contains the source code.