software.amazon.awscdk.pipelines

Class ShellStep

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.Step

software.amazon.awscdk.pipelines.ShellStep

All Implemented Interfaces:

IFileSetProducer

Direct Known Subclasses:

CodeBuildStep

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:29.615Z")
public class ShellStep
extends Step

Run shell script commands in the pipeline.

This is a generic step designed to be deployment engine agnostic.

Example:

 // Modern API
 CodePipeline modernPipeline = CodePipeline.Builder.create(this, "Pipeline")
         .selfMutation(false)
         .synth(ShellStep.Builder.create("Synth")
                 .input(CodePipelineSource.connection("my-org/my-app", "main", ConnectionSourceOptions.builder()
                         .connectionArn("arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41")
                         .build()))
                 .commands(List.of("npm ci", "npm run build", "npx cdk synth"))
                 .build())
         .build();
 // Original API
 Artifact cloudAssemblyArtifact = new Artifact();
 CdkPipeline originalPipeline = CdkPipeline.Builder.create(this, "Pipeline")
         .selfMutating(false)
         .cloudAssemblyArtifact(cloudAssemblyArtifact)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShellStep.Builder A fluent builder for ShellStep.

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

IFileSetProducer.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ShellStep(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ShellStep(software.amazon.jsii.JsiiObjectRef objRef)
	ShellStep(java.lang.String id, ShellStepProps props)

Method Summary

Modifier and Type	Method and Description
FileSet	addOutputDirectory(java.lang.String directory) Add an additional output FileSet based on a directory.
java.util.List<java.lang.String>	getCommands() Commands to run.
java.util.Map<java.lang.String,java.lang.String>	getEnv() Environment variables to set.
java.util.Map<java.lang.String,StackOutputReference>	getEnvFromCfnOutputs() Set environment variables based on Stack Outputs.
java.util.List<FileSetLocation>	getInputs() Input FileSets.
java.util.List<java.lang.String>	getInstallCommands() Installation commands to run before the regular commands.
java.util.List<FileSetLocation>	getOutputs() Output FileSets.
FileSet	primaryOutputDirectory(java.lang.String directory) Configure the given output directory as primary output.

Methods inherited from class software.amazon.awscdk.pipelines.Step

addDependencyFileSet, addStepDependency, configurePrimaryOutput, discoverReferencedOutputs, getDependencies, getDependencyFileSets, getId, getIsSource, getPrimaryOutput, sequence, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ShellStep

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

ShellStep

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

ShellStep

public ShellStep(java.lang.String id,
                 ShellStepProps props)

Parameters:

id - This parameter is required.

props - This parameter is required.

Method Detail

addOutputDirectory

public FileSet addOutputDirectory(java.lang.String directory)

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 - This parameter is required.

primaryOutputDirectory

public FileSet primaryOutputDirectory(java.lang.String directory)

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 - This parameter is required.

getCommands

public java.util.List<java.lang.String> getCommands()

Commands to run.

getEnv

public java.util.Map<java.lang.String,java.lang.String> getEnv()

Environment variables to set.

Default: - No environment variables

getEnvFromCfnOutputs

public java.util.Map<java.lang.String,StackOutputReference> getEnvFromCfnOutputs()

Set environment variables based on Stack Outputs.

Default: - No environment variables created from stack outputs

getInputs

public java.util.List<FileSetLocation> getInputs()

Input FileSets.

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

getInstallCommands

public java.util.List<java.lang.String> getInstallCommands()

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

getOutputs

public java.util.List<FileSetLocation> getOutputs()

Output FileSets.

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