software.amazon.awscdk.pipelines

Class Step

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.Step

All Implemented Interfaces:

IFileSetProducer

Direct Known Subclasses:

CodePipelineSource, ConfirmPermissionsBroadening, ManualApprovalStep, ShellStep

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:37.760Z")
public abstract class Step
extends software.amazon.jsii.JsiiObject
implements IFileSetProducer

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

Example:

 // Step A will depend on step B and step B will depend on step C
 Step[] orderedSteps = Step.sequence(List.of(
     new ManualApprovalStep("A"),
     new ManualApprovalStep("B"),
     new ManualApprovalStep("C")));
 

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.pipelines.IFileSetProducer

IFileSetProducer.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Step(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Step(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected void	addDependencyFileSet(FileSet fs) Add an additional FileSet to the set of file sets required by this step.
void	addStepDependency(Step step) Add a dependency on another step.
protected void	configurePrimaryOutput(FileSet fs) Configure the given FileSet as the primary output of this step.
protected void	discoverReferencedOutputs(java.lang.Object structure) Crawl the given structure for references to StepOutputs and add dependencies on all steps found.
java.util.List<Step>	getDependencies() Return the steps this step depends on, based on the FileSets it requires.
java.util.List<FileSet>	getDependencyFileSets() The list of FileSets consumed by this Step.
java.lang.String	getId() Identifier for this step.
java.lang.Boolean	getIsSource() Whether or not this is a Source step.
FileSet	getPrimaryOutput() The primary FileSet produced by this Step.
static java.util.List<Step>	sequence(java.util.List<? extends Step> steps) Define a sequence of steps to be executed in order.
java.lang.String	toString() Return a string representation of this Step.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Step

protected Step(software.amazon.jsii.JsiiObjectRef objRef)

Step

protected Step(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

sequence

public static java.util.List<Step> sequence(java.util.List<? extends Step> 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 - This parameter is required.

addDependencyFileSet

protected void addDependencyFileSet(FileSet fs)

Add an additional FileSet to the set of file sets required by this step.

This will lead to a dependency on the producer of that file set.

Parameters:

fs - This parameter is required.

addStepDependency

public void addStepDependency(Step step)

Add a dependency on another step.

Parameters:

step - This parameter is required.

configurePrimaryOutput

protected void configurePrimaryOutput(FileSet fs)

Configure the given FileSet as the primary output of this step.

Parameters:

fs - This parameter is required.

discoverReferencedOutputs

protected void discoverReferencedOutputs(java.lang.Object structure)

Crawl the given structure for references to StepOutputs and add dependencies on all steps found.

Should be called in the constructor of subclasses based on what the user passes in as construction properties. The format of the structure passed in here does not have to correspond exactly to what gets rendered into the engine, it just needs to contain the same data.

Parameters:

structure - This parameter is required.

toString

public java.lang.String toString()

Return a string representation of this Step.

getDependencies

public java.util.List<Step> getDependencies()

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

getDependencyFileSets

public java.util.List<FileSet> getDependencyFileSets()

The list of FileSets consumed by this Step.

getId

public java.lang.String getId()

Identifier for this step.

getIsSource

public java.lang.Boolean getIsSource()

Whether or not this is a Source step.

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

getPrimaryOutput

public FileSet getPrimaryOutput()

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.

Specified by:

getPrimaryOutput in interface IFileSetProducer