@aws-cdk/aws-apprunner-alpha.GithubRepositoryProps

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

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

branchstringbranchstrbranchStringBranchstringBranch*string= main#

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

codeConfigurationValuesCodeConfigurationValuescode_configuration_valuesCodeConfigurationValuescodeConfigurationValuesCodeConfigurationValuesCodeConfigurationValuesCodeConfigurationValuesCodeConfigurationValuesCodeConfigurationValues= no values will be passed. The `a…#

The code configuration values.

Will be ignored if configurationSource is REPOSITORY.

default

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

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.

Used as props by

• GithubSource