Source¶
-
class
aws_cdk.aws_codebuild.
Source
(*, identifier=None)¶ Bases:
object
Source provider definition for a CodeBuild Project.
- 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
Attributes
-
badge_supported
¶ - Return type
bool
-
identifier
¶ - Return type
Optional
[str
]
-
type
¶ - Return type
str
Static Methods
-
classmethod
bit_bucket
(*, owner, repo, branch_or_ref=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 usedclone_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: falsereport_build_status (
Optional
[bool
]) – Whether to send notifications on your build’s start and end. Default: truewebhook (
Optional
[bool
]) – Whether to create a webhook that will trigger a build every time an event happens in the repository. Default: true if anywebhookFilters
were provided, false otherwisewebhook_filters (
Optional
[List
[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 ifwebhook
was not provided as false. Default: every push and every Pull Request (create or update) triggers a buildwebhook_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: falseidentifier (
Optional
[str
]) – The source identifier. This property is required on secondary sources.
- Return type
-
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 usedclone_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: falseidentifier (
Optional
[str
]) – The source identifier. This property is required on secondary sources.
- Return type
-
classmethod
git_hub
(*, owner, repo, branch_or_ref=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 GitHub 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 usedclone_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: falsereport_build_status (
Optional
[bool
]) – Whether to send notifications on your build’s start and end. Default: truewebhook (
Optional
[bool
]) – Whether to create a webhook that will trigger a build every time an event happens in the repository. Default: true if anywebhookFilters
were provided, false otherwisewebhook_filters (
Optional
[List
[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 ifwebhook
was not provided as false. Default: every push and every Pull Request (create or update) triggers a buildwebhook_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: falseidentifier (
Optional
[str
]) – The source identifier. This property is required on secondary sources.
- Return type
-
classmethod
git_hub_enterprise
(*, https_clone_url, branch_or_ref=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 usedclone_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: falseignore_ssl_errors (
Optional
[bool
]) – Whether to ignore SSL errors when connecting to the repository. Default: falsereport_build_status (
Optional
[bool
]) – Whether to send notifications on your build’s start and end. Default: truewebhook (
Optional
[bool
]) – Whether to create a webhook that will trigger a build every time an event happens in the repository. Default: true if anywebhookFilters
were provided, false otherwisewebhook_filters (
Optional
[List
[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 ifwebhook
was not provided as false. Default: every push and every Pull Request (create or update) triggers a buildwebhook_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: falseidentifier (
Optional
[str
]) – The source identifier. This property is required on secondary sources.
- Return type
-
classmethod
s3
(*, bucket, path, version=None, identifier=None)¶