Source

class aws_cdk.aws_codebuild.Source(*, identifier=None)

Bases: object

Source provider definition for a CodeBuild Project.

ExampleMetadata:

infused

Example:

project = codebuild.Project(self, "MyProject",
    build_spec=codebuild.BuildSpec.from_source_filename("my-buildspec.yml"),
    source=codebuild.Source.git_hub(
        owner="awslabs",
        repo="aws-cdk"
    )
)
Parameters:

identifier (Optional[str]) – The source identifier. This property is required on secondary sources.

Methods

bind(_scope, _project)

Called by the project when the source is added so that the source can perform binding operations on the source.

For example, it can grant permissions to the code build project to read from the S3 bucket.

Parameters:
Return type:

SourceConfig

Attributes

badge_supported
identifier
type

Static Methods

classmethod bit_bucket(*, owner, repo, branch_or_ref=None, build_status_name=None, build_status_url=None, clone_depth=None, fetch_submodules=None, report_build_status=None, webhook=None, webhook_filters=None, webhook_triggers_batch_build=None, identifier=None)
Parameters:

  • owner (str) – The BitBucket account/user that owns the repo.

  • repo (str) – The name of the repo (without the username).

  • branch_or_ref (Optional[str]) – The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. Default: the default branch’s HEAD commit ID is used

  • build_status_name (Optional[str]) – This parameter is used for the name parameter in the Bitbucket commit status. Can use built-in CodeBuild variables, like $AWS_REGION. Default: “AWS CodeBuild $AWS_REGION ($PROJECT_NAME)”

  • build_status_url (Optional[str]) – The URL that the build will report back to the source provider. Can use built-in CodeBuild variables, like $AWS_REGION. Default: - link to the AWS Console for CodeBuild to a particular build execution

  • clone_depth (Union[int, float, None]) – The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build of the project.

  • fetch_submodules (Optional[bool]) – Whether to fetch submodules while cloning git repo. Default: false

  • report_build_status (Optional[bool]) – Whether to send notifications on your build’s start and end. Default: true

  • webhook (Optional[bool]) – Whether to create a webhook that will trigger a build every time an event happens in the repository. Default: true if any webhookFilters were provided, false otherwise

  • webhook_filters (Optional[Sequence[FilterGroup]]) – A list of webhook filters that can constraint what events in the repository will trigger a build. A build is triggered if any of the provided filter groups match. Only valid if webhook was not provided as false. Default: every push and every Pull Request (create or update) triggers a build

  • webhook_triggers_batch_build (Optional[bool]) – Trigger a batch build from a webhook instead of a standard one. Enabling this will enable batch builds on the CodeBuild project. Default: false

  • identifier (Optional[str]) – The source identifier. This property is required on secondary sources.

Return type:

ISource

classmethod code_commit(*, repository, branch_or_ref=None, clone_depth=None, fetch_submodules=None, identifier=None)
Parameters:

  • repository (IRepository) –

  • branch_or_ref (Optional[str]) – The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. Default: the default branch’s HEAD commit ID is used

  • clone_depth (Union[int, float, None]) – The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build of the project.

  • fetch_submodules (Optional[bool]) – Whether to fetch submodules while cloning git repo. Default: false

  • identifier (Optional[str]) – The source identifier. This property is required on secondary sources.

Return type:

ISource

classmethod git_hub(*, owner, branch_or_ref=None, build_status_context=None, build_status_url=None, clone_depth=None, fetch_submodules=None, repo=None, report_build_status=None, webhook=None, webhook_filters=None, webhook_triggers_batch_build=None, identifier=None)
Parameters:

  • owner (str) – The GitHub Organization/user that owns the repo.

  • branch_or_ref (Optional[str]) – The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. Default: the default branch’s HEAD commit ID is used

  • build_status_context (Optional[str]) – This parameter is used for the context parameter in the GitHub commit status. Can use built-in CodeBuild variables, like $AWS_REGION. Default: “AWS CodeBuild $AWS_REGION ($PROJECT_NAME)”

  • build_status_url (Optional[str]) – The URL that the build will report back to the source provider. Can use built-in CodeBuild variables, like $AWS_REGION. Default: - link to the AWS Console for CodeBuild to a particular build execution

  • clone_depth (Union[int, float, None]) – The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build of the project.

  • fetch_submodules (Optional[bool]) – Whether to fetch submodules while cloning git repo. Default: false

  • repo (Optional[str]) – The name of the repo (without the username). Default: undefined will create an organization webhook

  • report_build_status (Optional[bool]) – Whether to send notifications on your build’s start and end. Default: true

  • webhook (Optional[bool]) – Whether to create a webhook that will trigger a build every time an event happens in the repository. Default: true if any webhookFilters were provided, false otherwise

  • webhook_filters (Optional[Sequence[FilterGroup]]) – A list of webhook filters that can constraint what events in the repository will trigger a build. A build is triggered if any of the provided filter groups match. Only valid if webhook was not provided as false. Default: every push and every Pull Request (create or update) triggers a build

  • webhook_triggers_batch_build (Optional[bool]) – Trigger a batch build from a webhook instead of a standard one. Enabling this will enable batch builds on the CodeBuild project. Default: false

  • identifier (Optional[str]) – The source identifier. This property is required on secondary sources.

Return type:

ISource

classmethod git_hub_enterprise(*, https_clone_url, branch_or_ref=None, build_status_context=None, build_status_url=None, clone_depth=None, fetch_submodules=None, ignore_ssl_errors=None, report_build_status=None, webhook=None, webhook_filters=None, webhook_triggers_batch_build=None, identifier=None)
Parameters:

  • https_clone_url (str) – The HTTPS URL of the repository in your GitHub Enterprise installation.

  • branch_or_ref (Optional[str]) – The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. Default: the default branch’s HEAD commit ID is used

  • build_status_context (Optional[str]) – This parameter is used for the context parameter in the GitHub commit status. Can use built-in CodeBuild variables, like $AWS_REGION. Default: “AWS CodeBuild $AWS_REGION ($PROJECT_NAME)”

  • build_status_url (Optional[str]) – The URL that the build will report back to the source provider. Can use built-in CodeBuild variables, like $AWS_REGION. Default: - link to the AWS Console for CodeBuild to a particular build execution

  • clone_depth (Union[int, float, None]) – The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build of the project.

  • fetch_submodules (Optional[bool]) – Whether to fetch submodules while cloning git repo. Default: false

  • ignore_ssl_errors (Optional[bool]) – Whether to ignore SSL errors when connecting to the repository. Default: false

  • report_build_status (Optional[bool]) – Whether to send notifications on your build’s start and end. Default: true

  • webhook (Optional[bool]) – Whether to create a webhook that will trigger a build every time an event happens in the repository. Default: true if any webhookFilters were provided, false otherwise

  • webhook_filters (Optional[Sequence[FilterGroup]]) – A list of webhook filters that can constraint what events in the repository will trigger a build. A build is triggered if any of the provided filter groups match. Only valid if webhook was not provided as false. Default: every push and every Pull Request (create or update) triggers a build

  • webhook_triggers_batch_build (Optional[bool]) – Trigger a batch build from a webhook instead of a standard one. Enabling this will enable batch builds on the CodeBuild project. Default: false

  • identifier (Optional[str]) – The source identifier. This property is required on secondary sources.

Return type:

ISource

classmethod s3(*, bucket, path, version=None, identifier=None)
Parameters:

  • bucket (IBucket) –

  • path (str) –

  • version (Optional[str]) – The version ID of the object that represents the build input ZIP file to use. Default: latest

  • identifier (Optional[str]) – The source identifier. This property is required on secondary sources.

Return type:

ISource