Class Step

A generic Step which can be added to a Pipeline.

Inheritance

System.Object

Step

CodePipelineSource

ConfirmPermissionsBroadening

ManualApprovalStep

ShellStep

Implements

IFileSetProducer

Namespace: Amazon.CDK.Pipelines

Assembly: Amazon.CDK.Pipelines.dll

Syntax (csharp)

public abstract class Step : DeputyBase, IFileSetProducer

Syntax (vb)

Public MustInherit Class Step
    Inherits DeputyBase
    Implements IFileSetProducer

Remarks

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

Examples

// Step A will depend on step B and step B will depend on step C
var orderedSteps = Step.Sequence(new [] {
    new ManualApprovalStep("A"),
    new ManualApprovalStep("B"),
    new ManualApprovalStep("C") });

Synopsis

Constructors

Step(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
Step(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
Step(String)

Properties

Dependencies	Return the steps this step depends on, based on the FileSets it requires.
DependencyFileSets	The list of FileSets consumed by this Step.
Id	Identifier for this step.
IsSource	Whether or not this is a Source step.
PrimaryOutput	The primary FileSet produced by this Step.

Methods

AddDependencyFileSet(FileSet)	Add an additional FileSet to the set of file sets required by this step.
AddStepDependency(Step)	Add a dependency on another step.
ConfigurePrimaryOutput(FileSet)	Configure the given FileSet as the primary output of this step.
DiscoverReferencedOutputs(Object)	Crawl the given structure for references to StepOutputs and add dependencies on all steps found.
Sequence(Step[])	Define a sequence of steps to be executed in order.
ToString()	Return a string representation of this Step.

Constructors

Step(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Step(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

Step(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Step(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Step(String)

protected Step(string id)

Parameters

id System.String

Identifier for this step.

Properties

Dependencies

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

public virtual Step[] Dependencies { get; }

Property Value

Step[]

DependencyFileSets

The list of FileSets consumed by this Step.

public virtual FileSet[] DependencyFileSets { get; }

Property Value

FileSet[]

Id

Identifier for this step.

public virtual string Id { get; }

Property Value

System.String

IsSource

Whether or not this is a Source step.

public virtual bool IsSource { get; }

Property Value

System.Boolean

Remarks

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

PrimaryOutput

The primary FileSet produced by this Step.

public virtual FileSet PrimaryOutput { get; }

Property Value

FileSet

Remarks

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

Methods

AddDependencyFileSet(FileSet)

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

protected virtual void AddDependencyFileSet(FileSet fs)

Parameters

fs FileSet

Remarks

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

AddStepDependency(Step)

Add a dependency on another step.

public virtual void AddStepDependency(Step step)

Parameters

step Step

ConfigurePrimaryOutput(FileSet)

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

protected virtual void ConfigurePrimaryOutput(FileSet fs)

Parameters

fs FileSet

DiscoverReferencedOutputs(Object)

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

protected virtual void DiscoverReferencedOutputs(object structure)

Parameters

structure System.Object

Remarks

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.

Sequence(Step[])

Define a sequence of steps to be executed in order.

public static Step[] Sequence(Step[] steps)

Parameters

steps Step[]

Returns

Step[]

Remarks

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).

ToString()

Return a string representation of this Step.

public override string ToString()

Returns

System.String

Implements

IFileSetProducer