software.amazon.awscdk.pipelines

Class Step

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.Step

All Implemented Interfaces:

IFileSetProducer, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

CodePipelineSource, ConfirmPermissionsBroadening, ManualApprovalStep, ShellStep

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:19.756Z")
 @Stability(value=Stable)
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:

 public class MyJenkinsStep extends Step implements ICodePipelineActionFactory {
     public MyJenkinsStep(JenkinsProvider provider, FileSet input) {
         super("MyJenkinsStep");
     }
     public CodePipelineActionFactoryResult produceAction(IStage stage, ProduceActionOptions options) {
         // This is where you control what type of Action gets added to the
         // CodePipeline
         stage.addAction(JenkinsAction.Builder.create()
                 // Copy 'actionName' and 'runOrder' from the options
                 .actionName(options.getActionName())
                 .runOrder(options.getRunOrder())
                 // Jenkins-specific configuration
                 .type(JenkinsActionType.TEST)
                 .jenkinsProvider(this.provider)
                 .projectName("MyJenkinsProject")
                 // Translate the FileSet into a codepipeline.Artifact
                 .inputs(List.of(options.artifacts.toCodePipeline(this.input)))
                 .build());
         return CodePipelineActionFactoryResult.builder().runOrdersConsumed(1).build();
     }
 }
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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)
protected	Step(String id)

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.
protected void	configurePrimaryOutput(FileSet fs) Configure the given FileSet as the primary output of this step.
List<Step>	getDependencies() Return the steps this step depends on, based on the FileSets it requires.
List<FileSet>	getDependencyFileSets() The list of FileSets consumed by this Step.
String	getId() Identifier for this step.
Boolean	getIsSource() Whether or not this is a Source step.
FileSet	getPrimaryOutput() The primary FileSet produced by this Step.
String	toString() Return a string representation of this Step.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Step

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

Step

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

Step

@Stability(value=Stable)
protected Step(@NotNull
                                        String id)

Parameters:

id - Identifier for this step. This parameter is required.

Method Detail

addDependencyFileSet

@Stability(value=Stable)
protected void addDependencyFileSet(@NotNull
                                                             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.

configurePrimaryOutput

@Stability(value=Stable)
protected void configurePrimaryOutput(@NotNull
                                                               FileSet fs)

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

Parameters:

fs - This parameter is required.

toString

@Stability(value=Stable)
 @NotNull
public String toString()

Return a string representation of this Step.

Overrides:

toString in class Object

getDependencies

@Stability(value=Stable)
 @NotNull
public List<Step> getDependencies()

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

getDependencyFileSets

@Stability(value=Stable)
 @NotNull
public List<FileSet> getDependencyFileSets()

The list of FileSets consumed by this Step.

getId

@Stability(value=Stable)
 @NotNull
public String getId()

Identifier for this step.

getIsSource

@Stability(value=Stable)
 @NotNull
public Boolean getIsSource()

Whether or not this is a Source step.

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

getPrimaryOutput

@Stability(value=Stable)
 @Nullable
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