ReadonlycloudThe FileSet tha contains the cloud assembly
This is the primary output of the synth step.
ReadonlynodeThe tree node.
ReadonlyselfWhether SelfMutation is enabled for this CDK Pipeline
ReadonlysynthThe build step that produces the CDK Cloud Assembly
ReadonlyuseAllow pipeline service role used for actions if no action role configured instead of creating a new role for each action
ReadonlywavesThe waves in this pipeline
The CodePipeline pipeline that deploys the CDK app
Only available after the pipeline has been built.
The CodeBuild project that performs the SelfMutation
Will throw an error if this is accessed before buildPipeline()
is called, or if selfMutation has been disabled.
The CodeBuild project that performs the Synth
Only available after the pipeline has been built.
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.
Optionaloptions: AddStageOptsAdd 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:
declare const pipeline: pipelines.CodePipeline;
const wave = pipeline.addWave('MyWave');
wave.addStage(new MyApplicationStage(this, 'Stage1'));
wave.addStage(new MyApplicationStage(this, 'Stage2'));
Optionaloptions: WaveOptionsSend the current pipeline definition to the engine, and construct the pipeline
It is not possible to modify the pipeline after calling this method.
ProtecteddoImplemented by subclasses to do the actual pipeline construction
Returns a string representation of this construct.
StaticisChecks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Any object
true if x is an object created from a class which extends Construct.
StaticisReturn whether the given object extends PipelineBase.
We do attribute detection since we can't reliably use 'instanceof'.
A CDK Pipeline that uses CodePipeline to deploy CDK apps
This is a
Pipelinewith itsengineproperty set toCodePipelineEngine, and exists for nicer ergonomics for users that don't need to switch out engines.