PipelineBase
- class aws_cdk.pipelines.PipelineBase(scope, id, *, synth)
Bases:
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 whenapp.synth()
is called (whichever happens first).- Parameters:
scope (
Construct
) –id (
str
) –synth (
IFileSetProducer
) – The build step that produces the CDK Cloud Assembly. The primary output of this step needs to be thecdk.out
directory generated by thecdk synth
command. If you use aShellStep
here and you don’t configure an output directory, the output directory will automatically be assumed to becdk.out
.
Methods
- add_stage(stage, *, post=None, pre=None, stack_steps=None)
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 (
Stage
) –post (
Optional
[Sequence
[Step
]]) – Additional steps to run after all of the stacks in the stage. Default: - No additional stepspre (
Optional
[Sequence
[Step
]]) – Additional steps to run before any of the stacks in the stage. Default: - No additional stepsstack_steps (
Optional
[Sequence
[Union
[StackSteps
,Dict
[str
,Any
]]]]) – Instructions for stack level steps. Default: - No additional instructions
- Return type:
- add_wave(id, *, post=None, pre=None)
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:
# pipeline: pipelines.CodePipeline wave = pipeline.add_wave("MyWave") wave.add_stage(MyApplicationStage(self, "Stage1")) wave.add_stage(MyApplicationStage(self, "Stage2"))
- build_pipeline()
Send the current pipeline definition to the engine, and construct the pipeline.
It is not possible to modify the pipeline after calling this method.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- cloud_assembly_file_set
The FileSet tha contains the cloud assembly.
This is the primary output of the synth step.
- node
The tree node.
- synth
The build step that produces the CDK Cloud Assembly.
- waves
The waves in this pipeline.
Static Methods
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
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 classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
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 theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
- classmethod is_pipeline(x)
Return whether the given object extends
PipelineBase
.We do attribute detection since we can’t reliably use ‘instanceof’.
- Parameters:
x (
Any
) –- Return type:
bool