@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-31T18:37:02.627Z")
public abstract class PipelineBase
extends Construct
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).
IConstruct.Jsii$Default| Modifier | Constructor and Description |
|---|---|
protected |
PipelineBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
PipelineBase(software.amazon.jsii.JsiiObjectRef objRef) |
protected |
PipelineBase(software.constructs.Construct scope,
java.lang.String id,
PipelineBaseProps props) |
| 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(java.lang.String id)
Add a Wave to the pipeline, for deploying multiple Stages in parallel.
|
Wave |
addWave(java.lang.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.
|
java.util.List<Wave> |
getWaves()
The waves in this pipeline.
|
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validateprotected PipelineBase(software.amazon.jsii.JsiiObjectRef objRef)
protected PipelineBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected PipelineBase(software.constructs.Construct scope,
java.lang.String id,
PipelineBaseProps props)
scope - This parameter is required.id - This parameter is required.props - This parameter is required.public StageDeployment addStage(Stage stage, AddStageOpts options)
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.
stage - This parameter is required.options - public StageDeployment addStage(Stage stage)
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.
stage - This parameter is required.public Wave addWave(java.lang.String id, WaveOptions options)
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"));
id - This parameter is required.options - public Wave addWave(java.lang.String id)
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"));
id - This parameter is required.public void buildPipeline()
It is not possible to modify the pipeline after calling this method.
protected abstract void doBuildPipeline()
public FileSet getCloudAssemblyFileSet()
This is the primary output of the synth step.
public IFileSetProducer getSynth()
public java.util.List<Wave> getWaves()