Package software.amazon.awscdk.services.codepipeline

Class CfnPipeline

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.codepipeline.CfnPipeline

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:40.551Z")
@Stability(Stable)
public class CfnPipeline
extends CfnResource
implements IInspectable, ITaggable

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.services.codepipeline.*;
 Object configuration;
 CfnPipeline cfnPipeline = CfnPipeline.Builder.create(this, "MyCfnPipeline")
         .roleArn("roleArn")
         .stages(List.of(StageDeclarationProperty.builder()
                 .actions(List.of(ActionDeclarationProperty.builder()
                         .actionTypeId(ActionTypeIdProperty.builder()
                                 .category("category")
                                 .owner("owner")
                                 .provider("provider")
                                 .version("version")
                                 .build())
                         .name("name")
                         // the properties below are optional
                         .configuration(configuration)
                         .inputArtifacts(List.of(InputArtifactProperty.builder()
                                 .name("name")
                                 .build()))
                         .namespace("namespace")
                         .outputArtifacts(List.of(OutputArtifactProperty.builder()
                                 .name("name")
                                 .build()))
                         .region("region")
                         .roleArn("roleArn")
                         .runOrder(123)
                         .timeoutInMinutes(123)
                         .build()))
                 .name("name")
                 // the properties below are optional
                 .beforeEntry(BeforeEntryConditionsProperty.builder()
                         .conditions(List.of(ConditionProperty.builder()
                                 .result("result")
                                 .rules(List.of(RuleDeclarationProperty.builder()
                                         .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()))
                 .onFailure(FailureConditionsProperty.builder()
                         .conditions(List.of(ConditionProperty.builder()
                                 .result("result")
                                 .rules(List.of(RuleDeclarationProperty.builder()
                                         .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")
                         .build())
                 .onSuccess(SuccessConditionsProperty.builder()
                         .conditions(List.of(ConditionProperty.builder()
                                 .result("result")
                                 .rules(List.of(RuleDeclarationProperty.builder()
                                         .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()))
         // the properties below are optional
         .artifactStore(ArtifactStoreProperty.builder()
                 .location("location")
                 .type("type")
                 // the properties below are optional
                 .encryptionKey(EncryptionKeyProperty.builder()
                         .id("id")
                         .type("type")
                         .build())
                 .build())
         .artifactStores(List.of(ArtifactStoreMapProperty.builder()
                 .artifactStore(ArtifactStoreProperty.builder()
                         .location("location")
                         .type("type")
                         // the properties below are optional
                         .encryptionKey(EncryptionKeyProperty.builder()
                                 .id("id")
                                 .type("type")
                                 .build())
                         .build())
                 .region("region")
                 .build()))
         .disableInboundStageTransitions(List.of(StageTransitionProperty.builder()
                 .reason("reason")
                 .stageName("stageName")
                 .build()))
         .executionMode("executionMode")
         .name("name")
         .pipelineType("pipelineType")
         .restartExecutionOnUpdate(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .triggers(List.of(PipelineTriggerDeclarationProperty.builder()
                 .providerType("providerType")
                 // the properties below are optional
                 .gitConfiguration(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())
                 .build()))
         .variables(List.of(VariableDeclarationProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .defaultValue("defaultValue")
                 .description("description")
                 .build()))
         .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	CfnPipeline.ActionDeclarationProperty	Represents information about an action declaration.
static interface	CfnPipeline.ActionTypeIdProperty	Represents information about an action type.
static interface	CfnPipeline.ArtifactStoreMapProperty	A mapping of artifactStore objects and their corresponding AWS Regions.
static interface	CfnPipeline.ArtifactStoreProperty	The S3 bucket where artifacts for the pipeline are stored.
static interface	CfnPipeline.BeforeEntryConditionsProperty	The conditions for making checks for entry to a stage.
static interface	CfnPipeline.BlockerDeclarationProperty	Reserved for future use.
static final class	CfnPipeline.Builder	A fluent builder for CfnPipeline.
static interface	CfnPipeline.ConditionProperty	The condition for the stage.
static interface	CfnPipeline.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	CfnPipeline.FailureConditionsProperty	The configuration that specifies the result, such as rollback, to occur upon stage failure.
static interface	CfnPipeline.GitBranchFilterCriteriaProperty	The Git repository branches specified as filter criteria to start the pipeline.
static interface	CfnPipeline.GitConfigurationProperty	A type of trigger configuration for Git-based source actions.
static interface	CfnPipeline.GitFilePathFilterCriteriaProperty	The Git repository file paths specified as filter criteria to start the pipeline.
static interface	CfnPipeline.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	CfnPipeline.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	CfnPipeline.GitTagFilterCriteriaProperty	The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline.
static interface	CfnPipeline.InputArtifactProperty	Represents information about an artifact to be worked on, such as a test or build artifact.
static interface	CfnPipeline.OutputArtifactProperty	Represents information about the output of an action.
static interface	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.
static interface	CfnPipeline.RuleDeclarationProperty	Represents information about the rule to be created for an associated condition.
static interface	CfnPipeline.RuleTypeIdProperty	The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
static interface	CfnPipeline.StageDeclarationProperty	Represents information about a stage and its definition.
static interface	CfnPipeline.StageTransitionProperty	The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
static interface	CfnPipeline.SuccessConditionsProperty	The conditions for making checks that, if met, succeed a stage.
static interface	CfnPipeline.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.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnPipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPipeline(software.amazon.jsii.JsiiObjectRef objRef)
	CfnPipeline(software.constructs.Construct scope, String id, CfnPipelineProps props)

Method Summary

Modifier and Type	Method	Description
Object	getArtifactStore()	The S3 bucket where artifacts for the pipeline are stored.
Object	getArtifactStores()	A mapping of artifactStore objects and their corresponding AWS Regions.
String	getAttrVersion()	The version of the pipeline.
protected Map<String,Object>	getCfnProperties()
Object	getDisableInboundStageTransitions()	Represents the input of a DisableStageTransition action.
String	getExecutionMode()	The method that the pipeline will use to handle multiple executions.
String	getName()	The name of the pipeline.
String	getPipelineType()	CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
Object	getRestartExecutionOnUpdate()	Indicates whether to rerun the CodePipeline pipeline after you update it.
String	getRoleArn()	The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn , or to use to assume roles for actions with an actionRoleArn .
Object	getStages()	Represents information about a stage and its definition.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Specifies the tags applied to the pipeline.
Object	getTriggers()	The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
Object	getVariables()	A list that defines the pipeline variables for a pipeline resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setArtifactStore(IResolvable value)	The S3 bucket where artifacts for the pipeline are stored.
void	setArtifactStore(CfnPipeline.ArtifactStoreProperty value)	The S3 bucket where artifacts for the pipeline are stored.
void	setArtifactStores(List<Object> value)	A mapping of artifactStore objects and their corresponding AWS Regions.
void	setArtifactStores(IResolvable value)	A mapping of artifactStore objects and their corresponding AWS Regions.
void	setDisableInboundStageTransitions(List<Object> value)	Represents the input of a DisableStageTransition action.
void	setDisableInboundStageTransitions(IResolvable value)	Represents the input of a DisableStageTransition action.
void	setExecutionMode(String value)	The method that the pipeline will use to handle multiple executions.
void	setName(String value)	The name of the pipeline.
void	setPipelineType(String value)	CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
void	setRestartExecutionOnUpdate(Boolean value)	Indicates whether to rerun the CodePipeline pipeline after you update it.
void	setRestartExecutionOnUpdate(IResolvable value)	Indicates whether to rerun the CodePipeline pipeline after you update it.
void	setRoleArn(String value)	The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn , or to use to assume roles for actions with an actionRoleArn .
void	setStages(List<Object> value)	Represents information about a stage and its definition.
void	setStages(IResolvable value)	Represents information about a stage and its definition.
void	setTagsRaw(List<CfnTag> value)	Specifies the tags applied to the pipeline.
void	setTriggers(List<Object> value)	The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
void	setTriggers(IResolvable value)	The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
void	setVariables(List<Object> value)	A list that defines the pipeline variables for a pipeline resource.
void	setVariables(IResolvable value)	A list that defines the pipeline variables for a pipeline resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnPipeline

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

CfnPipeline

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

CfnPipeline

@Stability(Stable)
public CfnPipeline(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnPipelineProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrVersion

@Stability(Stable)
@NotNull
public String getAttrVersion()

The version of the pipeline.

A new pipeline is always assigned a version number of 1. This number increments when a pipeline is updated.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getRoleArn

@Stability(Stable)
@NotNull
public String getRoleArn()

The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn , or to use to assume roles for actions with an actionRoleArn .

setRoleArn

@Stability(Stable)
public void setRoleArn(@NotNull
 String value)

The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn , or to use to assume roles for actions with an actionRoleArn .

getStages

@Stability(Stable)
@NotNull
public Object getStages()

Represents information about a stage and its definition.

setStages

@Stability(Stable)
public void setStages(@NotNull
 IResolvable value)

Represents information about a stage and its definition.

setStages

@Stability(Stable)
public void setStages(@NotNull
 List<Object> value)

Represents information about a stage and its definition.

getArtifactStore

@Stability(Stable)
@Nullable
public Object getArtifactStore()

The S3 bucket where artifacts for the pipeline are stored.

setArtifactStore

@Stability(Stable)
public void setArtifactStore(@Nullable
 IResolvable value)

The S3 bucket where artifacts for the pipeline are stored.

setArtifactStore

@Stability(Stable)
public void setArtifactStore(@Nullable
 CfnPipeline.ArtifactStoreProperty value)

The S3 bucket where artifacts for the pipeline are stored.

getArtifactStores

@Stability(Stable)
@Nullable
public Object getArtifactStores()

A mapping of artifactStore objects and their corresponding AWS Regions.

setArtifactStores

@Stability(Stable)
public void setArtifactStores(@Nullable
 IResolvable value)

A mapping of artifactStore objects and their corresponding AWS Regions.

setArtifactStores

@Stability(Stable)
public void setArtifactStores(@Nullable
 List<Object> value)

A mapping of artifactStore objects and their corresponding AWS Regions.

getDisableInboundStageTransitions

@Stability(Stable)
@Nullable
public Object getDisableInboundStageTransitions()

Represents the input of a DisableStageTransition action.

setDisableInboundStageTransitions

@Stability(Stable)
public void setDisableInboundStageTransitions(@Nullable
 IResolvable value)

Represents the input of a DisableStageTransition action.

setDisableInboundStageTransitions

@Stability(Stable)
public void setDisableInboundStageTransitions(@Nullable
 List<Object> value)

Represents the input of a DisableStageTransition action.

getExecutionMode

@Stability(Stable)
@Nullable
public String getExecutionMode()

The method that the pipeline will use to handle multiple executions.

setExecutionMode

@Stability(Stable)
public void setExecutionMode(@Nullable
 String value)

The method that the pipeline will use to handle multiple executions.

getName

@Stability(Stable)
@Nullable
public String getName()

The name of the pipeline.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The name of the pipeline.

getPipelineType

@Stability(Stable)
@Nullable
public String getPipelineType()

CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

setPipelineType

@Stability(Stable)
public void setPipelineType(@Nullable
 String value)

CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

getRestartExecutionOnUpdate

@Stability(Stable)
@Nullable
public Object getRestartExecutionOnUpdate()

Indicates whether to rerun the CodePipeline pipeline after you update it.

setRestartExecutionOnUpdate

@Stability(Stable)
public void setRestartExecutionOnUpdate(@Nullable
 Boolean value)

Indicates whether to rerun the CodePipeline pipeline after you update it.

setRestartExecutionOnUpdate

@Stability(Stable)
public void setRestartExecutionOnUpdate(@Nullable
 IResolvable value)

Indicates whether to rerun the CodePipeline pipeline after you update it.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

Specifies the tags applied to the pipeline.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

Specifies the tags applied to the pipeline.

getTriggers

@Stability(Stable)
@Nullable
public Object getTriggers()

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

setTriggers

@Stability(Stable)
public void setTriggers(@Nullable
 IResolvable value)

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

setTriggers

@Stability(Stable)
public void setTriggers(@Nullable
 List<Object> value)

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

getVariables

@Stability(Stable)
@Nullable
public Object getVariables()

A list that defines the pipeline variables for a pipeline resource.

setVariables

@Stability(Stable)
public void setVariables(@Nullable
 IResolvable value)

A list that defines the pipeline variables for a pipeline resource.

setVariables

@Stability(Stable)
public void setVariables(@Nullable
 List<Object> value)

A list that defines the pipeline variables for a pipeline resource.