software.amazon.awscdk.services.codepipeline

Class Pipeline

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.codepipeline.Pipeline

All Implemented Interfaces:

IConstruct, IDependable, IResource, IPipeline, INotificationRuleSource

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:52.216Z")
public class Pipeline
extends Resource
implements IPipeline

An AWS CodePipeline pipeline with its associated IAM role and S3 bucket.

Example:

 // create a pipeline
 import software.amazon.awscdk.services.codecommit.*;
 // add a source action to the stage
 Repository repo;
 Artifact sourceArtifact;
 Pipeline pipeline = new Pipeline(this, "Pipeline");
 // add a stage
 IStage sourceStage = pipeline.addStage(StageOptions.builder().stageName("Source").build());
 sourceStage.addAction(CodeCommitSourceAction.Builder.create()
         .actionName("Source")
         .output(sourceArtifact)
         .repository(repo)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pipeline.Builder A fluent builder for Pipeline.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codepipeline.IPipeline

IPipeline.Jsii$Default, IPipeline.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Pipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Pipeline(software.amazon.jsii.JsiiObjectRef objRef)
	Pipeline(software.constructs.Construct scope, java.lang.String id)
	Pipeline(software.constructs.Construct scope, java.lang.String id, PipelineProps props)

Method Summary

Modifier and Type	Method and Description
IStage	addStage(StageOptions props) Creates a new Stage, and adds it to this Pipeline.
void	addToRolePolicy(PolicyStatement statement) Adds a statement to the pipeline role.
NotificationRuleSourceConfig	bindAsNotificationRuleSource(software.constructs.Construct _scope) Returns a source configuration for notification rule.
static IPipeline	fromPipelineArn(software.constructs.Construct scope, java.lang.String id, java.lang.String pipelineArn) Import a pipeline into this app.
IBucket	getArtifactBucket() Bucket used to store output artifacts.
java.util.Map<java.lang.String,CrossRegionSupport>	getCrossRegionSupport() Returns all of the CrossRegionSupportStacks that were generated automatically when dealing with Actions that reside in a different region than the Pipeline itself.
java.lang.String	getPipelineArn() ARN of this pipeline.
java.lang.String	getPipelineName() The name of the pipeline.
java.lang.String	getPipelineVersion() The version of the pipeline.
IRole	getRole() The IAM role AWS CodePipeline will use to perform actions or assume roles for actions with a more specific IAM role.
java.lang.Number	getStageCount() Get the number of Stages in this Pipeline.
java.util.List<IStage>	getStages() Returns the stages that comprise the pipeline.
INotificationRule	notifyOn(java.lang.String id, INotificationRuleTarget target, PipelineNotifyOnOptions options) Defines a CodeStar notification rule triggered when the pipeline events emitted by you specified, it very similar to `onEvent` API.
INotificationRule	notifyOnAnyActionStateChange(java.lang.String id, INotificationRuleTarget target) Define an notification rule triggered by the set of the "Action execution" events emitted from this pipeline.
INotificationRule	notifyOnAnyActionStateChange(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Define an notification rule triggered by the set of the "Action execution" events emitted from this pipeline.
INotificationRule	notifyOnAnyManualApprovalStateChange(java.lang.String id, INotificationRuleTarget target) Define an notification rule triggered by the set of the "Manual approval" events emitted from this pipeline.
INotificationRule	notifyOnAnyManualApprovalStateChange(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Define an notification rule triggered by the set of the "Manual approval" events emitted from this pipeline.
INotificationRule	notifyOnAnyStageStateChange(java.lang.String id, INotificationRuleTarget target) Define an notification rule triggered by the set of the "Stage execution" events emitted from this pipeline.
INotificationRule	notifyOnAnyStageStateChange(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Define an notification rule triggered by the set of the "Stage execution" events emitted from this pipeline.
INotificationRule	notifyOnExecutionStateChange(java.lang.String id, INotificationRuleTarget target) Define an notification rule triggered by the set of the "Pipeline execution" events emitted from this pipeline.
INotificationRule	notifyOnExecutionStateChange(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Define an notification rule triggered by the set of the "Pipeline execution" events emitted from this pipeline.
Rule	onEvent(java.lang.String id) Defines an event rule triggered by this CodePipeline.
Rule	onEvent(java.lang.String id, OnEventOptions options) Defines an event rule triggered by this CodePipeline.
Rule	onStateChange(java.lang.String id) Defines an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.
Rule	onStateChange(java.lang.String id, OnEventOptions options) Defines an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.
IStage	stage(java.lang.String stageName) Access one of the pipeline's stages by stage name.
protected java.util.List<java.lang.String>	validate() Validate the pipeline structure.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

Pipeline

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

Pipeline

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

Pipeline

public Pipeline(software.constructs.Construct scope,
                java.lang.String id,
                PipelineProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Pipeline

public Pipeline(software.constructs.Construct scope,
                java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromPipelineArn

public static IPipeline fromPipelineArn(software.constructs.Construct scope,
                                        java.lang.String id,
                                        java.lang.String pipelineArn)

Import a pipeline into this app.

Parameters:

scope - the scope into which to import this pipeline. This parameter is required.

id - the logical ID of the returned pipeline construct. This parameter is required.

pipelineArn - The ARN of the pipeline (e.g. `arn:aws:codepipeline:us-east-1:123456789012:MyDemoPipeline`). This parameter is required.

addStage

public IStage addStage(StageOptions props)

Creates a new Stage, and adds it to this Pipeline.

Parameters:

props - the creation properties of the new Stage. This parameter is required.

Returns:

the newly created Stage

addToRolePolicy

public void addToRolePolicy(PolicyStatement statement)

Adds a statement to the pipeline role.

Parameters:

statement - This parameter is required.

bindAsNotificationRuleSource

public NotificationRuleSourceConfig bindAsNotificationRuleSource(software.constructs.Construct _scope)

Returns a source configuration for notification rule.

Specified by:

bindAsNotificationRuleSource in interface INotificationRuleSource

Parameters:

_scope - This parameter is required.

notifyOn

public INotificationRule notifyOn(java.lang.String id,
                                  INotificationRuleTarget target,
                                  PipelineNotifyOnOptions options)

Defines a CodeStar notification rule triggered when the pipeline events emitted by you specified, it very similar to `onEvent` API.

You can also use the methods notifyOnExecutionStateChange, notifyOnAnyStageStateChange, notifyOnAnyActionStateChange and notifyOnAnyManualApprovalStateChange to define rules for these specific event emitted.

Specified by:

notifyOn in interface IPipeline

Parameters:

id - This parameter is required.

target - This parameter is required.

options - This parameter is required.

Returns:

CodeStar notification rule associated with this build project.

notifyOnAnyActionStateChange

public INotificationRule notifyOnAnyActionStateChange(java.lang.String id,
                                                      INotificationRuleTarget target,
                                                      NotificationRuleOptions options)

Define an notification rule triggered by the set of the "Action execution" events emitted from this pipeline.

Specified by:

notifyOnAnyActionStateChange in interface IPipeline

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnAnyActionStateChange

public INotificationRule notifyOnAnyActionStateChange(java.lang.String id,
                                                      INotificationRuleTarget target)

Define an notification rule triggered by the set of the "Action execution" events emitted from this pipeline.

Specified by:

notifyOnAnyActionStateChange in interface IPipeline

Parameters:

id - This parameter is required.

target - This parameter is required.

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnAnyManualApprovalStateChange

public INotificationRule notifyOnAnyManualApprovalStateChange(java.lang.String id,
                                                              INotificationRuleTarget target,
                                                              NotificationRuleOptions options)

Define an notification rule triggered by the set of the "Manual approval" events emitted from this pipeline.

Specified by:

notifyOnAnyManualApprovalStateChange in interface IPipeline

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnAnyManualApprovalStateChange

public INotificationRule notifyOnAnyManualApprovalStateChange(java.lang.String id,
                                                              INotificationRuleTarget target)

Define an notification rule triggered by the set of the "Manual approval" events emitted from this pipeline.

Specified by:

notifyOnAnyManualApprovalStateChange in interface IPipeline

Parameters:

id - This parameter is required.

target - This parameter is required.

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnAnyStageStateChange

public INotificationRule notifyOnAnyStageStateChange(java.lang.String id,
                                                     INotificationRuleTarget target,
                                                     NotificationRuleOptions options)

Define an notification rule triggered by the set of the "Stage execution" events emitted from this pipeline.

Specified by:

notifyOnAnyStageStateChange in interface IPipeline

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnAnyStageStateChange

public INotificationRule notifyOnAnyStageStateChange(java.lang.String id,
                                                     INotificationRuleTarget target)

Define an notification rule triggered by the set of the "Stage execution" events emitted from this pipeline.

Specified by:

notifyOnAnyStageStateChange in interface IPipeline

Parameters:

id - This parameter is required.

target - This parameter is required.

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnExecutionStateChange

public INotificationRule notifyOnExecutionStateChange(java.lang.String id,
                                                      INotificationRuleTarget target,
                                                      NotificationRuleOptions options)

Define an notification rule triggered by the set of the "Pipeline execution" events emitted from this pipeline.

Specified by:

notifyOnExecutionStateChange in interface IPipeline

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnExecutionStateChange

public INotificationRule notifyOnExecutionStateChange(java.lang.String id,
                                                      INotificationRuleTarget target)

Define an notification rule triggered by the set of the "Pipeline execution" events emitted from this pipeline.

Specified by:

notifyOnExecutionStateChange in interface IPipeline

Parameters:

id - This parameter is required.

target - This parameter is required.

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

onEvent

public Rule onEvent(java.lang.String id,
                    OnEventOptions options)

Defines an event rule triggered by this CodePipeline.

Specified by:

onEvent in interface IPipeline

Parameters:

id - Identifier for this event handler. This parameter is required.

options - Additional options to pass to the event rule.

onEvent

public Rule onEvent(java.lang.String id)

Defines an event rule triggered by this CodePipeline.

Specified by:

onEvent in interface IPipeline

Parameters:

id - Identifier for this event handler. This parameter is required.

onStateChange

public Rule onStateChange(java.lang.String id,
                          OnEventOptions options)

Defines an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.

Specified by:

onStateChange in interface IPipeline

Parameters:

id - Identifier for this event handler. This parameter is required.

options - Additional options to pass to the event rule.

onStateChange

public Rule onStateChange(java.lang.String id)

Defines an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.

Specified by:

onStateChange in interface IPipeline

Parameters:

id - Identifier for this event handler. This parameter is required.

stage

public IStage stage(java.lang.String stageName)

Access one of the pipeline's stages by stage name.

Parameters:

stageName - This parameter is required.

validate

protected java.util.List<java.lang.String> validate()

Validate the pipeline structure.

Validation happens according to the rules documented at

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#pipeline-requirements

Overrides:

validate in class Construct

Returns:

An array of validation error messages, or an empty array if the construct is valid.

getArtifactBucket

public IBucket getArtifactBucket()

Bucket used to store output artifacts.

getCrossRegionSupport

public java.util.Map<java.lang.String,CrossRegionSupport> getCrossRegionSupport()

Returns all of the CrossRegionSupportStacks that were generated automatically when dealing with Actions that reside in a different region than the Pipeline itself.

getPipelineArn

public java.lang.String getPipelineArn()

ARN of this pipeline.

Specified by:

getPipelineArn in interface IPipeline

getPipelineName

public java.lang.String getPipelineName()

The name of the pipeline.

Specified by:

getPipelineName in interface IPipeline

getPipelineVersion

public java.lang.String getPipelineVersion()

The version of the pipeline.

getRole

public IRole getRole()

The IAM role AWS CodePipeline will use to perform actions or assume roles for actions with a more specific IAM role.

getStageCount

public java.lang.Number getStageCount()

Get the number of Stages in this Pipeline.

getStages

public java.util.List<IStage> getStages()

Returns the stages that comprise the pipeline.

Note: the returned array is a defensive copy, so adding elements to it has no effect. Instead, use the {@link addStage} method if you want to add more stages to the pipeline.