GitPullRequestFilter

class aws_cdk.aws_codepipeline.GitPullRequestFilter(*, branches_excludes=None, branches_includes=None, events=None, file_paths_excludes=None, file_paths_includes=None)

Bases: object

Git pull request filter for trigger.

Parameters:

  • branches_excludes (Optional[Sequence[str]]) – The list of patterns of Git branches that, when pull request events occurs, are to be excluded from starting the pipeline. You can filter with glob patterns. The branchesExcludes takes priority over the branchesIncludes. Maximum length of this array is 8. Default: - no branches.

  • branches_includes (Optional[Sequence[str]]) – The list of patterns of Git branches that, when pull request events occurs, are to be included as criteria that starts the pipeline. You can filter with glob patterns. The branchesExcludes takes priority over the branchesIncludes. Maximum length of this array is 8. Default: - no branches.

  • events (Optional[Sequence[GitPullRequestEvent]]) – The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration. Default: - all events.

  • file_paths_excludes (Optional[Sequence[str]]) – The list of patterns of Git repository file paths that, when pull request events occurs, are to be excluded from starting the pipeline. You can filter with glob patterns. The filePathsExcludes takes priority over the filePathsIncludes. Maximum length of this array is 8. Default: - no filePaths.

  • file_paths_includes (Optional[Sequence[str]]) – The list of patterns of Git repository file paths that, when pull request events occurs, are to be included as criteria that starts the pipeline. You can filter with glob patterns. The filePathsExcludes takes priority over the filePathsIncludes. Maximum length of this array is 8. Default: - no filePaths.

ExampleMetadata:

fixture=_generated

Example:

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

git_pull_request_filter = codepipeline.GitPullRequestFilter(
    branches_excludes=["branchesExcludes"],
    branches_includes=["branchesIncludes"],
    events=[codepipeline.GitPullRequestEvent.OPEN],
    file_paths_excludes=["filePathsExcludes"],
    file_paths_includes=["filePathsIncludes"]
)

Attributes

branches_excludes

The list of patterns of Git branches that, when pull request events occurs, are to be excluded from starting the pipeline.

You can filter with glob patterns. The branchesExcludes takes priority over the branchesIncludes.

Maximum length of this array is 8.

Default:

  • no branches.

branches_includes

The list of patterns of Git branches that, when pull request events occurs, are to be included as criteria that starts the pipeline.

You can filter with glob patterns. The branchesExcludes takes priority over the branchesIncludes.

Maximum length of this array is 8.

Default:

  • no branches.

events

The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.

Default:

  • all events.

file_paths_excludes

The list of patterns of Git repository file paths that, when pull request events occurs, are to be excluded from starting the pipeline.

You can filter with glob patterns. The filePathsExcludes takes priority over the filePathsIncludes.

Maximum length of this array is 8.

Default:

  • no filePaths.

file_paths_includes

The list of patterns of Git repository file paths that, when pull request events occurs, are to be included as criteria that starts the pipeline.

You can filter with glob patterns. The filePathsExcludes takes priority over the filePathsIncludes.

Maximum length of this array is 8.

Default:

  • no filePaths.