Package software.amazon.awscdk.cfnpropertymixins.services.codepipeline

Class CfnPipelinePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.codepipeline.CfnPipelinePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.318Z")
@Stability(Stable)
public class CfnPipelinePropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process.

For more information, see What Is CodePipeline? in the CodePipeline User Guide .

For an example in YAML and JSON that contains the parameters in this reference, see Examples .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.codepipeline.*;
 import software.amazon.awscdk.*;
 Object configuration;
 IMergeStrategy mergeStrategy;
 CfnPipelinePropsMixin cfnPipelinePropsMixin = CfnPipelinePropsMixin.Builder.create(CfnPipelineMixinProps.builder()
         .artifactStore(ArtifactStoreProperty.builder()
                 .encryptionKey(EncryptionKeyProperty.builder()
                         .id("id")
                         .type("type")
                         .build())
                 .location("location")
                 .type("type")
                 .build())
         .artifactStores(List.of(ArtifactStoreMapProperty.builder()
                 .artifactStore(ArtifactStoreProperty.builder()
                         .encryptionKey(EncryptionKeyProperty.builder()
                                 .id("id")
                                 .type("type")
                                 .build())
                         .location("location")
                         .type("type")
                         .build())
                 .region("region")
                 .build()))
         .disableInboundStageTransitions(List.of(StageTransitionProperty.builder()
                 .reason("reason")
                 .stageName("stageName")
                 .build()))
         .executionMode("executionMode")
         .name("name")
         .pipelineType("pipelineType")
         .restartExecutionOnUpdate(false)
         .roleArn("roleArn")
         .stages(List.of(StageDeclarationProperty.builder()
                 .actions(List.of(ActionDeclarationProperty.builder()
                         .actionTypeId(ActionTypeIdProperty.builder()
                                 .category("category")
                                 .owner("owner")
                                 .provider("provider")
                                 .version("version")
                                 .build())
                         .commands(List.of("commands"))
                         .configuration(configuration)
                         .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                                 .name("name")
                                 .type("type")
                                 .value("value")
                                 .build()))
                         .inputArtifacts(List.of(InputArtifactProperty.builder()
                                 .name("name")
                                 .build()))
                         .name("name")
                         .namespace("namespace")
                         .outputArtifacts(List.of(OutputArtifactProperty.builder()
                                 .files(List.of("files"))
                                 .name("name")
                                 .build()))
                         .outputVariables(List.of("outputVariables"))
                         .region("region")
                         .roleArn("roleArn")
                         .runOrder(123)
                         .timeoutInMinutes(123)
                         .build()))
                 .beforeEntry(BeforeEntryConditionsProperty.builder()
                         .conditions(List.of(ConditionProperty.builder()
                                 .result("result")
                                 .rules(List.of(RuleDeclarationProperty.builder()
                                         .commands(List.of("commands"))
                                         .configuration(configuration)
                                         .inputArtifacts(List.of(InputArtifactProperty.builder()
                                                 .name("name")
                                                 .build()))
                                         .name("name")
                                         .region("region")
                                         .roleArn("roleArn")
                                         .ruleTypeId(RuleTypeIdProperty.builder()
                                                 .category("category")
                                                 .owner("owner")
                                                 .provider("provider")
                                                 .version("version")
                                                 .build())
                                         .build()))
                                 .build()))
                         .build())
                 .blockers(List.of(BlockerDeclarationProperty.builder()
                         .name("name")
                         .type("type")
                         .build()))
                 .name("name")
                 .onFailure(FailureConditionsProperty.builder()
                         .conditions(List.of(ConditionProperty.builder()
                                 .result("result")
                                 .rules(List.of(RuleDeclarationProperty.builder()
                                         .commands(List.of("commands"))
                                         .configuration(configuration)
                                         .inputArtifacts(List.of(InputArtifactProperty.builder()
                                                 .name("name")
                                                 .build()))
                                         .name("name")
                                         .region("region")
                                         .roleArn("roleArn")
                                         .ruleTypeId(RuleTypeIdProperty.builder()
                                                 .category("category")
                                                 .owner("owner")
                                                 .provider("provider")
                                                 .version("version")
                                                 .build())
                                         .build()))
                                 .build()))
                         .result("result")
                         .retryConfiguration(RetryConfigurationProperty.builder()
                                 .retryMode("retryMode")
                                 .build())
                         .build())
                 .onSuccess(SuccessConditionsProperty.builder()
                         .conditions(List.of(ConditionProperty.builder()
                                 .result("result")
                                 .rules(List.of(RuleDeclarationProperty.builder()
                                         .commands(List.of("commands"))
                                         .configuration(configuration)
                                         .inputArtifacts(List.of(InputArtifactProperty.builder()
                                                 .name("name")
                                                 .build()))
                                         .name("name")
                                         .region("region")
                                         .roleArn("roleArn")
                                         .ruleTypeId(RuleTypeIdProperty.builder()
                                                 .category("category")
                                                 .owner("owner")
                                                 .provider("provider")
                                                 .version("version")
                                                 .build())
                                         .build()))
                                 .build()))
                         .build())
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .triggers(List.of(PipelineTriggerDeclarationProperty.builder()
                 .gitConfiguration(GitConfigurationProperty.builder()
                         .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()))
                         .sourceActionName("sourceActionName")
                         .build())
                 .providerType("providerType")
                 .build()))
         .variables(List.of(VariableDeclarationProperty.builder()
                 .defaultValue("defaultValue")
                 .description("description")
                 .name("name")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnPipelinePropsMixin.ActionDeclarationProperty	Represents information about an action declaration.
static interface	CfnPipelinePropsMixin.ActionTypeIdProperty	Represents information about an action type.
static interface	CfnPipelinePropsMixin.ArtifactStoreMapProperty	A mapping of artifactStore objects and their corresponding AWS Regions.
static interface	CfnPipelinePropsMixin.ArtifactStoreProperty	The S3 bucket where artifacts for the pipeline are stored.
static interface	CfnPipelinePropsMixin.BeforeEntryConditionsProperty	The conditions for making checks for entry to a stage.
static interface	CfnPipelinePropsMixin.BlockerDeclarationProperty	Reserved for future use.
static final class	CfnPipelinePropsMixin.Builder	A fluent builder for CfnPipelinePropsMixin.
static interface	CfnPipelinePropsMixin.ConditionProperty	The condition for the stage.
static interface	CfnPipelinePropsMixin.EncryptionKeyProperty	Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.
static interface	CfnPipelinePropsMixin.EnvironmentVariableProperty	The environment variables for the action.
static interface	CfnPipelinePropsMixin.FailureConditionsProperty	The configuration that specifies the result, such as rollback, to occur upon stage failure.
static interface	CfnPipelinePropsMixin.GitBranchFilterCriteriaProperty	The Git repository branches specified as filter criteria to start the pipeline.
static interface	CfnPipelinePropsMixin.GitConfigurationProperty	A type of trigger configuration for Git-based source actions.
static interface	CfnPipelinePropsMixin.GitFilePathFilterCriteriaProperty	The Git repository file paths specified as filter criteria to start the pipeline.
static interface	CfnPipelinePropsMixin.GitPullRequestFilterProperty	The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.
static interface	CfnPipelinePropsMixin.GitPushFilterProperty	The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.
static interface	CfnPipelinePropsMixin.GitTagFilterCriteriaProperty	The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline.
static interface	CfnPipelinePropsMixin.InputArtifactProperty	Represents information about an artifact to be worked on, such as a test or build artifact.
static interface	CfnPipelinePropsMixin.OutputArtifactProperty	Represents information about the output of an action.
static interface	CfnPipelinePropsMixin.PipelineTriggerDeclarationProperty	Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.
static interface	CfnPipelinePropsMixin.RetryConfigurationProperty	The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.
static interface	CfnPipelinePropsMixin.RuleDeclarationProperty	Represents information about the rule to be created for an associated condition.
static interface	CfnPipelinePropsMixin.RuleTypeIdProperty	The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
static interface	CfnPipelinePropsMixin.StageDeclarationProperty	Represents information about a stage and its definition.
static interface	CfnPipelinePropsMixin.StageTransitionProperty	The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
static interface	CfnPipelinePropsMixin.SuccessConditionsProperty	The conditions for making checks that, if met, succeed a stage.
static interface	CfnPipelinePropsMixin.VariableDeclarationProperty	A variable declared at the pipeline level.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnPipelinePropsMixin(CfnPipelineMixinProps props)	Create a mixin to apply properties to AWS::CodePipeline::Pipeline.
	CfnPipelinePropsMixin(CfnPipelineMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::CodePipeline::Pipeline.
protected	CfnPipelinePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPipelinePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnPipelineMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnPipelinePropsMixin

protected CfnPipelinePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnPipelinePropsMixin

protected CfnPipelinePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPipelinePropsMixin

@Stability(Stable)
public CfnPipelinePropsMixin(@NotNull
 CfnPipelineMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::CodePipeline::Pipeline.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnPipelinePropsMixin

@Stability(Stable)
public CfnPipelinePropsMixin(@NotNull
 CfnPipelineMixinProps props)

Create a mixin to apply properties to AWS::CodePipeline::Pipeline.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnPipelineMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()