GithubRepositoryProps

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

Bases: object

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

Parameters
  • branch (Optional[str]) – (experimental) The branch name that represents a specific version for the repository. Default: main

  • code_configuration_values (Optional[CodeConfigurationValues]) – (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.

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

Stability

experimental

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apprunner as apprunner

# git_hub_connection is of type GitHubConnection
# runtime is of type Runtime

github_repository_props = apprunner.GithubRepositoryProps(
    configuration_source=apprunner.ConfigurationSourceType.REPOSITORY,
    connection=git_hub_connection,
    repository_url="repositoryUrl",

    # the properties below are optional
    branch="branch",
    code_configuration_values=apprunner.CodeConfigurationValues(
        runtime=runtime,

        # the properties below are optional
        build_command="buildCommand",
        environment={
            "environment_key": "environment"
        },
        port="port",
        start_command="startCommand"
    )
)

Attributes

branch

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

Default

main

Stability

experimental

Return type

Optional[str]

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

Return type

Optional[CodeConfigurationValues]

configuration_source

(experimental) The source of the App Runner configuration.

Stability

experimental

Return type

ConfigurationSourceType

connection

(experimental) ARN of the connection to Github.

Only required for Github source.

Stability

experimental

Return type

GitHubConnection

repository_url

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

Stability

experimental

Return type

str