interface PipelineTriggerDeclarationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CodePipeline.CfnPipeline.PipelineTriggerDeclarationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#CfnPipeline_PipelineTriggerDeclarationProperty`
Java	`software.amazon.awscdk.services.codepipeline.CfnPipeline.PipelineTriggerDeclarationProperty`
Python	`aws_cdk.aws_codepipeline.CfnPipeline.PipelineTriggerDeclarationProperty`
TypeScript	`aws-cdk-lib` » `aws_codepipeline` » `CfnPipeline` » `PipelineTriggerDeclarationProperty`

Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.

This is only supported for the CodeStarSourceConnection action type. > When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

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 pipelineTriggerDeclarationProperty: codepipeline.CfnPipeline.PipelineTriggerDeclarationProperty = {
  providerType: 'providerType',

  // the properties below are optional
  gitConfiguration: {
    sourceActionName: 'sourceActionName',

    // the properties below are optional
    pullRequest: [{
      branches: {
        excludes: ['excludes'],
        includes: ['includes'],
      },
      events: ['events'],
      filePaths: {
        excludes: ['excludes'],
        includes: ['includes'],
      },
    }],
    push: [{
      branches: {
        excludes: ['excludes'],
        includes: ['includes'],
      },
      filePaths: {
        excludes: ['excludes'],
        includes: ['includes'],
      },
      tags: {
        excludes: ['excludes'],
        includes: ['includes'],
      },
    }],
  },
};

Properties

Name	Type	Description
providerType	`string`	The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration.
gitConfiguration?	`IResolvable` `\|` `GitConfigurationProperty`	Provides the filter criteria and the source stage for the repository event that starts the pipeline, such as Git tags.

providerType

Type: string

The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration.

gitConfiguration?

Type: IResolvable | GitConfigurationProperty (optional)

Provides the filter criteria and the source stage for the repository event that starts the pipeline, such as Git tags.