Class ShellStep

Run shell script commands in the pipeline. This is a generic step designed to be deployment engine agnostic.

Hierarchy (view full)

Constructors

constructor

Properties

commands dependencyFileSets env envFromCfnOutputs id inputs installCommands isSource outputs

Accessors

consumedStackOutputs dependencies primaryOutput

Methods

addDependencyFileSet addOutputDirectory addStepDependency configurePrimaryOutput discoverReferencedOutputs primaryOutputDirectory toString sequence

Constructors

constructor

Properties

Readonlycommands

commands: string[]

Commands to run

ReadonlydependencyFileSets

dependencyFileSets: FileSet[]

The list of FileSets consumed by this Step

Readonlyenv

env: Record<string, string>

Environment variables to set

Default

- No environment variables

ReadonlyenvFromCfnOutputs

envFromCfnOutputs: Record<string, StackOutputReference>

Set environment variables based on Stack Outputs

Default

- No environment variables created from stack outputs

Readonlyid

id: string

Identifier for this step

Readonlyinputs

inputs: FileSetLocation[]

Input FileSets

A list of (FileSet, directory) pairs, which are a copy of the input properties. This list should not be modified directly.

ReadonlyinstallCommands

installCommands: string[]

Installation commands to run before the regular commands

For deployment engines that support it, install commands will be classified differently in the job history from the regular commands.

Default

- No installation commands

ReadonlyisSource

isSource: boolean

Whether or not this is a Source step

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

Readonlyoutputs

outputs: FileSetLocation[]

Output FileSets

A list of (FileSet, directory) pairs, which are a copy of the input properties. This list should not be modified directly.

Accessors

consumedStackOutputs

  • get consumedStackOutputs(): StackOutputReference[]

  • StackOutputReferences this step consumes.

    Returns StackOutputReference[]

dependencies

  • get dependencies(): Step[]

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

    Returns Step[]

primaryOutput

  • get primaryOutput(): undefined | FileSet

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

    Returns undefined | FileSet

Methods

ProtectedaddDependencyFileSet

  • addDependencyFileSet(fs): void

  • 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

    Returns void

addOutputDirectory

  • addOutputDirectory(directory): FileSet

  • Add an additional output FileSet based on a directory.

    After running the script, the contents of the given directory will be exported as a FileSet. Use the FileSet as the input to another step.

    Multiple calls with the exact same directory name string (not normalized) will return the same FileSet.

    Parameters

    • directory: string

    Returns FileSet

addStepDependency

  • addStepDependency(step): void

  • Add a dependency on another step.

    Parameters

    Returns void

ProtectedconfigurePrimaryOutput

  • configurePrimaryOutput(fs): void

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

    Parameters

    Returns void

ProtecteddiscoverReferencedOutputs

  • discoverReferencedOutputs(structure): void

  • 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: any

    Returns void

primaryOutputDirectory

  • primaryOutputDirectory(directory): FileSet

  • Configure the given output directory as primary output

    If no primary output has been configured yet, this directory will become the primary output of this ShellStep, otherwise this method will throw if the given directory is different than the currently configured primary output directory.

    Parameters

    • directory: string

    Returns FileSet

toString

  • toString(): string

  • Return a string representation of this Step

    Returns string

Staticsequence

  • sequence(steps): Step[]

  • 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

    Returns Step[]

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods