2.182.0

interface GitPullRequestFilter

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.GitPullRequestFilter
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#GitPullRequestFilter
Javasoftware.amazon.awscdk.services.codepipeline.GitPullRequestFilter
Pythonaws_cdk.aws_codepipeline.GitPullRequestFilter
TypeScript (source)aws-cdk-lib » aws_codepipeline » GitPullRequestFilter

Git pull request filter for trigger.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';
const gitPullRequestFilter: codepipeline.GitPullRequestFilter = {
  branchesExcludes: ['branchesExcludes'],
  branchesIncludes: ['branchesIncludes'],
  events: [codepipeline.GitPullRequestEvent.OPEN],
  filePathsExcludes: ['filePathsExcludes'],
  filePathsIncludes: ['filePathsIncludes'],
};

Properties

NameTypeDescription
branchesExcludes?string[]The list of patterns of Git branches that, when pull request events occurs, are to be excluded from starting the pipeline.
branchesIncludes?string[]The list of patterns of Git branches that, when pull request events occurs, are to be included as criteria that starts the pipeline.
events?GitPullRequestEvent[]The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.
filePathsExcludes?string[]The list of patterns of Git repository file paths that, when pull request events occurs, are to be excluded from starting the pipeline.
filePathsIncludes?string[]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.

branchesExcludes?

Type: string[] (optional, default: no branches.)

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.

branchesIncludes?

Type: string[] (optional, default: no branches.)

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.

events?

Type: GitPullRequestEvent[] (optional, default: all events.)

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

filePathsExcludes?

Type: string[] (optional, default: no filePaths.)

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.

filePathsIncludes?

Type: string[] (optional, default: no filePaths.)

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.

← PreviousNext →