Package software.amazon.awscdk.services.codepipeline

Interface CfnPipeline.GitConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipeline.GitConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

@Stability(Stable)
public static interface CfnPipeline.GitConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

A type of trigger configuration for Git-based source actions.

You can specify the Git configuration trigger type for all third-party Git-based source actions that are supported by the CodeStarSourceConnection action type.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.*;
 GitConfigurationProperty gitConfigurationProperty = GitConfigurationProperty.builder()
         .sourceActionName("sourceActionName")
         // the properties below are optional
         .pullRequest(List.of(GitPullRequestFilterProperty.builder()
                 .branches(GitBranchFilterCriteriaProperty.builder()
                         .excludes(List.of("excludes"))
                         .includes(List.of("includes"))
                         .build())
                 .events(List.of("events"))
                 .filePaths(GitFilePathFilterCriteriaProperty.builder()
                         .excludes(List.of("excludes"))
                         .includes(List.of("includes"))
                         .build())
                 .build()))
         .push(List.of(GitPushFilterProperty.builder()
                 .branches(GitBranchFilterCriteriaProperty.builder()
                         .excludes(List.of("excludes"))
                         .includes(List.of("includes"))
                         .build())
                 .filePaths(GitFilePathFilterCriteriaProperty.builder()
                         .excludes(List.of("excludes"))
                         .includes(List.of("includes"))
                         .build())
                 .tags(GitTagFilterCriteriaProperty.builder()
                         .excludes(List.of("excludes"))
                         .includes(List.of("includes"))
                         .build())
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipeline.GitConfigurationProperty.Builder	A builder for CfnPipeline.GitConfigurationProperty
static final class	CfnPipeline.GitConfigurationProperty.Jsii$Proxy	An implementation for CfnPipeline.GitConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipeline.GitConfigurationProperty.Builder	builder()
default Object	getPullRequest()	The field where the repository event that will start the pipeline is specified as pull requests.
default Object	getPush()	The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details.
String	getSourceActionName()	The name of the pipeline source action where the trigger configuration, such as Git tags, is specified.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSourceActionName

@Stability(Stable)
@NotNull
String getSourceActionName()

The name of the pipeline source action where the trigger configuration, such as Git tags, is specified.

The trigger configuration will start the pipeline upon the specified change only.

You can only specify one trigger configuration per source action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitconfiguration.html#cfn-codepipeline-pipeline-gitconfiguration-sourceactionname

getPullRequest

@Stability(Stable)
@Nullable
default Object getPullRequest()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitconfiguration.html#cfn-codepipeline-pipeline-gitconfiguration-pullrequest

getPush

@Stability(Stable)
@Nullable
default Object getPush()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitconfiguration.html#cfn-codepipeline-pipeline-gitconfiguration-push

builder

@Stability(Stable)
static CfnPipeline.GitConfigurationProperty.Builder builder()

Returns:

a CfnPipeline.GitConfigurationProperty.Builder of CfnPipeline.GitConfigurationProperty