GithubRepositoryProps

class aws_cdk.aws_apprunner.GithubRepositoryProps(*, configuration_source, connection, repository_url, branch=None, code_configuration_values=None)

Bases: object

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

Parameters:

configuration_source (ConfigurationSourceType) – (experimental) The source of the App Runner configuration.
connection (GitHubConnection) – (experimental) ARN of the connection to Github. Only required for Github source.
repository_url (str) – (experimental) The location of the repository that contains the source code.
branch (Optional[str]) – (experimental) The branch name that represents a specific version for the repository. Default: main
code_configuration_values (Union[CodeConfigurationValues, Dict[str, Any], None]) – (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.

Stability:

experimental

ExampleMetadata:

infused

Example:

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")
    )
)

Attributes

branch

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

Default:: main
Stability:: experimental

code_configuration_values

(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.

Stability:

experimental

configuration_source

(experimental) The source of the App Runner configuration.

Stability:: experimental

connection

(experimental) ARN of the connection to Github.

Only required for Github source.

Stability:: experimental

repository_url

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

Stability:: experimental