Class PipelineBase
A generic CDK Pipelines pipeline.
Inherited Members
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Pipelines.dll
Syntax (csharp)
public abstract class PipelineBase : Construct, IConstruct, IDependable
Syntax (vb)
Public MustInherit Class PipelineBase
Inherits Construct
Implements IConstruct, IDependable
Remarks
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).
Synopsis
Constructors
PipelineBase(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
PipelineBase(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
PipelineBase(Construct, String, IPipelineBaseProps) |
Properties
CloudAssemblyFileSet | The FileSet tha contains the cloud assembly. |
Synth | The build step that produces the CDK Cloud Assembly. |
Waves | The waves in this pipeline. |
Methods
AddStage(Stage, IAddStageOpts) | Deploy a single Stage by itself. |
AddWave(String, IWaveOptions) | Add a Wave to the pipeline, for deploying multiple Stages in parallel. |
BuildPipeline() | Send the current pipeline definition to the engine, and construct the pipeline. |
DoBuildPipeline() | Implemented by subclasses to do the actual pipeline construction. |
Constructors
PipelineBase(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected PipelineBase(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
PipelineBase(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected PipelineBase(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
PipelineBase(Construct, String, IPipelineBaseProps)
protected PipelineBase(Construct scope, string id, IPipelineBaseProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IPipelineBaseProps
Properties
CloudAssemblyFileSet
The FileSet tha contains the cloud assembly.
public virtual FileSet CloudAssemblyFileSet { get; }
Property Value
Remarks
This is the primary output of the synth step.
Synth
The build step that produces the CDK Cloud Assembly.
public virtual IFileSetProducer Synth { get; }
Property Value
Waves
Methods
AddStage(Stage, IAddStageOpts)
Deploy a single Stage by itself.
public virtual StageDeployment AddStage(Stage stage, IAddStageOpts options = null)
Parameters
- stage Stage
- options IAddStageOpts
Returns
Remarks
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.
AddWave(String, IWaveOptions)
Add a Wave to the pipeline, for deploying multiple Stages in parallel.
public virtual Wave AddWave(string id, IWaveOptions options = null)
Parameters
- id System.String
- options IWaveOptions
Returns
Remarks
Use the return object of this method to deploy multiple stages in parallel.
Example:
CodePipeline pipeline;
var wave = pipeline.AddWave("MyWave");
wave.AddStage(new MyApplicationStage(this, "Stage1"));
wave.AddStage(new MyApplicationStage(this, "Stage2"));
BuildPipeline()
Send the current pipeline definition to the engine, and construct the pipeline.
public virtual void BuildPipeline()
Remarks
It is not possible to modify the pipeline after calling this method.
DoBuildPipeline()
Implemented by subclasses to do the actual pipeline construction.
protected abstract void DoBuildPipeline()