Step

class aws_cdk.pipelines.Step(id)

Bases: object

A generic Step which can be added to a Pipeline.

Steps can be used to add Sources, Build Actions and Validations to your pipeline.

This class is abstract. See specific subclasses of Step for useful steps to add to your Pipeline

ExampleMetadata

infused

Example:

# Step A will depend on step B and step B will depend on step C
ordered_steps = pipelines.Step.sequence([
    pipelines.ManualApprovalStep("A"),
    pipelines.ManualApprovalStep("B"),
    pipelines.ManualApprovalStep("C")
])
Parameters

id (str) – Identifier for this step.

Methods

add_step_dependency(step)

Add a dependency on another step.

Parameters

step (Step) –

Return type

None

to_string()

Return a string representation of this Step.

Return type

str

Attributes

dependencies

Return the steps this step depends on, based on the FileSets it requires.

dependency_file_sets

The list of FileSets consumed by this Step.

id

Identifier for this step.

is_source

Whether or not this is a Source step.

What it means to be a Source step depends on the engine.

primary_output

The primary FileSet produced by this Step.

Not all steps produce an output FileSet–if they do you can substitute the Step object for the FileSet object.

Static Methods

classmethod sequence(steps)

Define a sequence of steps to be executed in order.

If you need more fine-grained step ordering, use the addStepDependency() API. For example, if you want secondStep to occur after firstStep, call secondStep.addStepDependency(firstStep).

Parameters

steps (Sequence[Step]) –

Return type

List[Step]