@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-25T18:29:12.951Z")
public interface ShellStepProps
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();
Modifier and Type | Interface and Description |
---|---|
static class |
ShellStepProps.Builder
A builder for
ShellStepProps |
static class |
ShellStepProps.Jsii$Proxy
An implementation for
ShellStepProps |
Modifier and Type | Method and Description |
---|---|
static ShellStepProps.Builder |
builder() |
default java.util.Map<java.lang.String,IFileSetProducer> |
getAdditionalInputs()
Additional FileSets to put in other directories.
|
java.util.List<java.lang.String> |
getCommands()
Commands to run.
|
default java.util.Map<java.lang.String,java.lang.String> |
getEnv()
Environment variables to set.
|
default java.util.Map<java.lang.String,CfnOutput> |
getEnvFromCfnOutputs()
Set environment variables based on Stack Outputs.
|
default IFileSetProducer |
getInput()
FileSet to run these scripts on.
|
default java.util.List<java.lang.String> |
getInstallCommands()
Installation commands to run before the regular commands.
|
default java.lang.String |
getPrimaryOutputDirectory()
The directory that will contain the primary output fileset.
|
java.util.List<java.lang.String> getCommands()
default java.util.Map<java.lang.String,IFileSetProducer> getAdditionalInputs()
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();
Default: - No additional inputs
default java.util.Map<java.lang.String,java.lang.String> getEnv()
Default: - No environment variables
default java.util.Map<java.lang.String,CfnOutput> getEnvFromCfnOutputs()
ShellStep
s following stack or stage deployments may
access the CfnOutput
s of those stacks to get access to
--for example--automatically generated resource names or
endpoint URLs.
Default: - No environment variables created from stack outputs
default IFileSetProducer getInput()
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.
Default: - No input specified
default java.util.List<java.lang.String> getInstallCommands()
For deployment engines that support it, install commands will be classified
differently in the job history from the regular commands
.
Default: - No installation commands
default java.lang.String getPrimaryOutputDirectory()
After running the script, the contents of the given directory will be treated as the primary output of this Step.
Default: - No primary output
static ShellStepProps.Builder builder()
ShellStepProps.Builder
of ShellStepProps