GitConfiguration

class aws_cdk.aws_codepipeline.GitConfiguration(*, source_action, pull_request_filter=None, push_filter=None)

Bases: object

Git configuration for trigger.

Parameters:

source_action (IAction) – The pipeline source action where the trigger configuration, such as Git tags. The trigger configuration will start the pipeline upon the specified change only. You can only specify one trigger configuration per source action. Since the provider for sourceAction must be CodeStarSourceConnection, you can use CodeStarConnectionsSourceAction construct in aws-codepipeline-actions module.
pull_request_filter (Optional[Sequence[Union[GitPullRequestFilter, Dict[str, Any]]]]) – The field where the repository event that will start the pipeline is specified as pull requests. The length must be less than or equal to 3. Default: - no filter.
push_filter (Optional[Sequence[Union[GitPushFilter, Dict[str, Any]]]]) – The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details. Git tags is the only supported event type. The length must be less than or equal to 3. Default: - no filter.

ExampleMetadata:

infused

Example:

# source_action: codepipeline_actions.CodeStarConnectionsSourceAction
# build_action: codepipeline_actions.CodeBuildAction


codepipeline.Pipeline(self, "Pipeline",
    pipeline_type=codepipeline.PipelineType.V2,
    stages=[codepipeline.StageProps(
        stage_name="Source",
        actions=[source_action]
    ), codepipeline.StageProps(
        stage_name="Build",
        actions=[build_action]
    )
    ],
    triggers=[codepipeline.TriggerProps(
        provider_type=codepipeline.ProviderType.CODE_STAR_SOURCE_CONNECTION,
        git_configuration=codepipeline.GitConfiguration(
            source_action=source_action,
            push_filter=[codepipeline.GitPushFilter(
                tags_excludes=["exclude1", "exclude2"],
                tags_includes=["include*"]
            )]
        )
    )]
)

Attributes

pull_request_filter

The field where the repository event that will start the pipeline is specified as pull requests.

The length must be less than or equal to 3.

Default:

no filter.

push_filter

The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details.

Git tags is the only supported event type.

The length must be less than or equal to 3.

Default:

no filter.

source_action

The pipeline source action where the trigger configuration, such as Git tags.

The trigger configuration will start the pipeline upon the specified change only. You can only specify one trigger configuration per source action.

Since the provider for sourceAction must be CodeStarSourceConnection, you can use CodeStarConnectionsSourceAction construct in aws-codepipeline-actions module.