software.amazon.awscdk.pipelines

Class PipelineBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.pipelines.PipelineBase

All Implemented Interfaces:

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

Direct Known Subclasses:

CodePipeline

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.940Z")
 @Stability(value=Stable)
public abstract class PipelineBase
extends software.constructs.Construct

A generic CDK Pipelines pipeline.

Different deployment systems will provide subclasses of Pipeline that generate the deployment infrastructure necessary to deploy CDK apps, specific to that system.

This library comes with the CodePipeline class, which uses AWS CodePipeline to deploy CDK apps.

The actual pipeline infrastructure is constructed (by invoking the engine) when buildPipeline() is called, or when app.synth() is called (whichever happens first).

Nested Class Summary

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
StageDeployment	addStage(Stage stage) Deploy a single Stage by itself.
StageDeployment	addStage(Stage stage, AddStageOpts options) Deploy a single Stage by itself.
Wave	addWave(String id) Add a Wave to the pipeline, for deploying multiple Stages in parallel.
Wave	addWave(String id, WaveOptions options) Add a Wave to the pipeline, for deploying multiple Stages in parallel.
void	buildPipeline() Send the current pipeline definition to the engine, and construct the pipeline.
protected abstract void	doBuildPipeline() Implemented by subclasses to do the actual pipeline construction.
FileSet	getCloudAssemblyFileSet() The FileSet tha contains the cloud assembly.
IFileSetProducer	getSynth() The build step that produces the CDK Cloud Assembly.
List<Wave>	getWaves() The waves in this pipeline.
static Boolean	isPipeline(Object x) Return whether the given object extends PipelineBase.

Methods inherited from class software.constructs.Construct

getNode, isConstruct, 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.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

PipelineBase

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

PipelineBase

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

PipelineBase

@Stability(value=Stable)
protected PipelineBase(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                PipelineBaseProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

isPipeline

@Stability(value=Stable)
 @NotNull
public static Boolean isPipeline(@NotNull
                                                                    Object x)

Return whether the given object extends PipelineBase.

We do attribute detection since we can't reliably use 'instanceof'.

Parameters:

x - This parameter is required.

addStage

@Stability(value=Stable)
 @NotNull
public StageDeployment addStage(@NotNull
                                                                   Stage stage,
                                                                   @Nullable
                                                                   AddStageOpts options)

Deploy a single Stage by itself.

Add a Stage to the pipeline, to be deployed in sequence with other Stages added to the pipeline. All Stacks in the stage will be deployed in an order automatically determined by their relative dependencies.

Parameters:

stage - This parameter is required.

options -

addStage

@Stability(value=Stable)
 @NotNull
public StageDeployment addStage(@NotNull
                                                                   Stage stage)

Deploy a single Stage by itself.

Add a Stage to the pipeline, to be deployed in sequence with other Stages added to the pipeline. All Stacks in the stage will be deployed in an order automatically determined by their relative dependencies.

Parameters:

stage - This parameter is required.

addWave

@Stability(value=Stable)
 @NotNull
public Wave addWave(@NotNull
                                                       String id,
                                                       @Nullable
                                                       WaveOptions options)

Add a Wave to the pipeline, for deploying multiple Stages in parallel.

Use the return object of this method to deploy multiple stages in parallel.

Example:

 CodePipeline pipeline;
 Wave wave = pipeline.addWave("MyWave");
 wave.addStage(new MyApplicationStage(this, "Stage1"));
 wave.addStage(new MyApplicationStage(this, "Stage2"));
 

Parameters:

id - This parameter is required.

options -

addWave

@Stability(value=Stable)
 @NotNull
public Wave addWave(@NotNull
                                                       String id)

Add a Wave to the pipeline, for deploying multiple Stages in parallel.

Use the return object of this method to deploy multiple stages in parallel.

Example:

 CodePipeline pipeline;
 Wave wave = pipeline.addWave("MyWave");
 wave.addStage(new MyApplicationStage(this, "Stage1"));
 wave.addStage(new MyApplicationStage(this, "Stage2"));
 

Parameters:

id - This parameter is required.

buildPipeline

@Stability(value=Stable)
public void buildPipeline()

Send the current pipeline definition to the engine, and construct the pipeline.

It is not possible to modify the pipeline after calling this method.

doBuildPipeline

@Stability(value=Stable)
protected abstract void doBuildPipeline()

Implemented by subclasses to do the actual pipeline construction.

getCloudAssemblyFileSet

@Stability(value=Stable)
 @NotNull
public FileSet getCloudAssemblyFileSet()

The FileSet tha contains the cloud assembly.

This is the primary output of the synth step.

getSynth

@Stability(value=Stable)
 @NotNull
public IFileSetProducer getSynth()

The build step that produces the CDK Cloud Assembly.

getWaves

@Stability(value=Stable)
 @NotNull
public List<Wave> getWaves()

The waves in this pipeline.