Private Optional _cloudPrivate Optional _fallbackThis is set to the very first artifact produced in the pipeline
Private Optional _myPrivate Optional _pipelinePrivate Optional _selfPrivate Optional _synthPrivate actionMake an action from the given node and/or step
Private actionTake a Step and turn it into a CodePipeline Action
There are only 3 types of Steps we need to support:
The rest is expressed in terms of these 3, or in terms of graph nodes which are handled elsewhere.
Private artifactsPrivate Readonly assetAsset roles shared for publishing
Private Readonly cachedPrivate Optional Readonly cliReadonly cloudThe FileSet tha contains the cloud assembly
This is the primary output of the synth step.
Private codePrivate createPrivate Readonly dockerPrivate executePrivate executeReadonly nodeThe tree node.
Private nodePrivate obtainThis role is used by both the CodePipeline build action and related CodeBuild project. Consolidating these two roles into one, and re-using across all assets, saves significant size of the final synthesized output. Modeled after the CodePipeline role and 'CodePipelineActionRole' roles. Generates one role per asset type to separate file and Docker/image-based permissions.
Private pipelinePrivate postDo additional things after the action got added to the pipeline
Some minor state manipulation of CodeBuild projects and pipeline artifacts.
Private Readonly propsPrivate publishPrivate rolePrivate selfReadonly selfWhether SelfMutation is enabled for this CDK Pipeline
Private Readonly singlePrivate stackReadonly synthThe build step that produces the CDK Cloud Assembly
Private Readonly useReadonly wavesThe waves in this pipeline
Private writeNon-template config files for CodePipeline actions
Currently only supports tags.
Private assetsScope for Assets-related resources.
Purely exists for construct tree backwards compatibility with legacy pipelines
Private myThe 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.
Optional options: 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'));
Optional options: WaveOptionsProtected doStatic isChecks 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.
Static isReturn whether the given object extends PipelineBase.
We do attribute detection since we can't reliably use 'instanceof'.
Generated using TypeDoc
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.