software.amazon.awscdk.pipelines

Class ShellStepProps.Builder

java.lang.Object

software.amazon.awscdk.pipelines.ShellStepProps.Builder

Enclosing interface:

ShellStepProps

public static final class ShellStepProps.Builder
extends java.lang.Object

A builder for ShellStepProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ShellStepProps.Builder	additionalInputs(java.util.Map<java.lang.String,? extends IFileSetProducer> additionalInputs) Sets the value of ShellStepProps.getAdditionalInputs()
ShellStepProps	build() Builds the configured instance.
ShellStepProps.Builder	commands(java.util.List<java.lang.String> commands) Sets the value of ShellStepProps.getCommands()
ShellStepProps.Builder	env(java.util.Map<java.lang.String,java.lang.String> env) Sets the value of ShellStepProps.getEnv()
ShellStepProps.Builder	envFromCfnOutputs(java.util.Map<java.lang.String,? extends CfnOutput> envFromCfnOutputs) Sets the value of ShellStepProps.getEnvFromCfnOutputs()
ShellStepProps.Builder	input(IFileSetProducer input) Sets the value of ShellStepProps.getInput()
ShellStepProps.Builder	installCommands(java.util.List<java.lang.String> installCommands) Sets the value of ShellStepProps.getInstallCommands()
ShellStepProps.Builder	primaryOutputDirectory(java.lang.String primaryOutputDirectory) Sets the value of ShellStepProps.getPrimaryOutputDirectory()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

commands

public ShellStepProps.Builder commands(java.util.List<java.lang.String> commands)

Sets the value of ShellStepProps.getCommands()

Parameters:

commands - Commands to run. This parameter is required.

Returns:

this

additionalInputs

public ShellStepProps.Builder additionalInputs(java.util.Map<java.lang.String,? extends IFileSetProducer> additionalInputs)

Sets the value of ShellStepProps.getAdditionalInputs()

Parameters:

additionalInputs - Additional FileSets to put in other directories. Specifies a mapping from directory name to FileSets. During the script execution, the FileSets will be available in the directories indicated.

The directory names may be relative. For example, you can put the main input and an additional input side-by-side with the following configuration:

                         ShellStep script = ShellStep.Builder.create("MainScript")
                                 .commands(List.of("npm ci", "npm run build", "npx cdk synth"))
                                 .input(CodePipelineSource.gitHub("org/source1", "main"))
                                 .additionalInputs(Map.of(
                                         "../siblingdir", CodePipelineSource.gitHub("org/source2", "main")))
                                 .build();
                         

Returns:

this

env

public ShellStepProps.Builder env(java.util.Map<java.lang.String,java.lang.String> env)

Sets the value of ShellStepProps.getEnv()

Parameters:

env - Environment variables to set.

Returns:

this

envFromCfnOutputs

public ShellStepProps.Builder envFromCfnOutputs(java.util.Map<java.lang.String,? extends CfnOutput> envFromCfnOutputs)

Sets the value of ShellStepProps.getEnvFromCfnOutputs()

Parameters:

envFromCfnOutputs - Set environment variables based on Stack Outputs. ShellSteps following stack or stage deployments may access the CfnOutputs of those stacks to get access to --for example--automatically generated resource names or endpoint URLs.

Returns:

this

input

public ShellStepProps.Builder input(IFileSetProducer input)

Sets the value of ShellStepProps.getInput()

Parameters:

input - FileSet to run these scripts on. The files in the FileSet will be placed in the working directory when the script is executed. Use additionalInputs to download file sets to other directories as well.

Returns:

this

installCommands

public ShellStepProps.Builder installCommands(java.util.List<java.lang.String> installCommands)

Sets the value of ShellStepProps.getInstallCommands()

Parameters:

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

Returns:

this

primaryOutputDirectory

public ShellStepProps.Builder primaryOutputDirectory(java.lang.String primaryOutputDirectory)

Sets the value of ShellStepProps.getPrimaryOutputDirectory()

Parameters:

primaryOutputDirectory - The directory that will contain the primary output fileset. After running the script, the contents of the given directory will be treated as the primary output of this Step.

Returns:

this

build

public ShellStepProps build()

Builds the configured instance.

Returns:

a new instance of ShellStepProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided