software.amazon.awscdk.services.codepipeline

Class Pipeline

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.codepipeline.Pipeline

All Implemented Interfaces:

IDependable, IResource, IPipeline, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-11T12:53:02.490Z")
 @Stability(value=Stable)
public class Pipeline
extends Resource
implements IPipeline

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

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 // create a pipeline
 var pipeline = new Pipeline(this, "Pipeline");
 // add a stage
 var sourceStage = pipeline.addStage(Map.of("stageName", "Source"));
 // add a source action to the stage
 sourceStage.addAction(CodeCommitSourceAction.Builder.create()
         .actionName("Source")
         .outputArtifactName("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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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
	Pipeline(software.constructs.Construct scope, String id)
	Pipeline(software.constructs.Construct scope, String id, PipelineProps props)
protected	Pipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Pipeline(software.amazon.jsii.JsiiObjectRef objRef)

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.
static IPipeline	fromPipelineArn(software.constructs.Construct scope, String id, String pipelineArn) Import a pipeline into this app.
IBucket	getArtifactBucket() Bucket used to store output artifacts.
Map<String,CrossRegionSupport>	getCrossRegionSupport() (experimental) Returns all of the CrossRegionSupportStacks that were generated automatically when dealing with Actions that reside in a different region than the Pipeline itself.
String	getPipelineArn() ARN of this pipeline.
String	getPipelineName() The name of the pipeline.
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.
Number	getStageCount() Get the number of Stages in this Pipeline.
List<IStage>	getStages() Returns the stages that comprise the pipeline.
Rule	onEvent(String id) Defines an event rule triggered by this CodePipeline.
Rule	onEvent(String id, OnEventOptions options) Defines an event rule triggered by this CodePipeline.
Rule	onStateChange(String id) Defines an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.
Rule	onStateChange(String id, OnEventOptions options) Defines an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.
IStage	stage(String stageName) Access one of the pipeline's stages by stage name.
protected List<String>	validate() Validate the pipeline structure.

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

generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack

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

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

Methods inherited from class software.constructs.Construct

toString

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.awscdk.core.IResource

getEnv, getStack

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Pipeline

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

Pipeline

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

Pipeline

@Stability(value=Stable)
public Pipeline(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @Nullable
                                         PipelineProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Pipeline

@Stability(value=Stable)
public Pipeline(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromPipelineArn

@Stability(value=Stable)
 @NotNull
public static IPipeline fromPipelineArn(@NotNull
                                                                           software.constructs.Construct scope,
                                                                           @NotNull
                                                                           String id,
                                                                           @NotNull
                                                                           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

@Stability(value=Stable)
 @NotNull
public IStage addStage(@NotNull
                                                          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

@Stability(value=Stable)
public void addToRolePolicy(@NotNull
                                                     PolicyStatement statement)

Adds a statement to the pipeline role.

Parameters:

statement - This parameter is required.

onEvent

@Stability(value=Stable)
 @NotNull
public Rule onEvent(@NotNull
                                                       String id,
                                                       @Nullable
                                                       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

@Stability(value=Stable)
 @NotNull
public Rule onEvent(@NotNull
                                                       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

@Stability(value=Stable)
 @NotNull
public Rule onStateChange(@NotNull
                                                             String id,
                                                             @Nullable
                                                             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

@Stability(value=Stable)
 @NotNull
public Rule onStateChange(@NotNull
                                                             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

@Stability(value=Stable)
 @NotNull
public IStage stage(@NotNull
                                                       String stageName)

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

Parameters:

stageName - This parameter is required.

validate

@Stability(value=Stable)
 @NotNull
protected List<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

getArtifactBucket

@Stability(value=Stable)
 @NotNull
public IBucket getArtifactBucket()

Bucket used to store output artifacts.

getCrossRegionSupport

@Stability(value=Experimental)
 @NotNull
public Map<String,CrossRegionSupport> getCrossRegionSupport()

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

getPipelineArn

@Stability(value=Stable)
 @NotNull
public String getPipelineArn()

ARN of this pipeline.

Specified by:

getPipelineArn in interface IPipeline

getPipelineName

@Stability(value=Stable)
 @NotNull
public String getPipelineName()

The name of the pipeline.

Specified by:

getPipelineName in interface IPipeline

getPipelineVersion

@Stability(value=Stable)
 @NotNull
public String getPipelineVersion()

The version of the pipeline.

getRole

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @NotNull
public Number getStageCount()

Get the number of Stages in this Pipeline.

getStages

@Stability(value=Stable)
 @NotNull
public 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.