aws-cdk-lib.pipelines.ShellStepProps

ShellStepProps Struct

Construction properties for a ShellStep.

ShellStepProps

used as props by

• ShellStep

Source

pipelines/lib/blueprint/shell-step.ts

Example

declare const pipeline: pipelines.CodePipeline;
const preprod = new MyApplicationStage(this, 'PreProd');
const prod = new MyApplicationStage(this, 'Prod');
const topic = new sns.Topic(this, 'ChangeApprovalTopic');

pipeline.addStage(preprod, {
  post: [
    new pipelines.ShellStep('Validate Endpoint', {
      commands: ['curl -Ssf https://my.webservice.com/'],
    }),
  ],
});
pipeline.addStage(prod, {
  pre: [new pipelines.ManualApprovalStep('PromoteToProd', {
    //All options below are optional
    comment: 'Please validate changes',
    reviewUrl: 'https://my.webservice.com/',
    notificationTopic: topic,
  })],
});

Properties

additionalInputs?optional{ [key: string]: IFileSetProducer }additional_inputs?optionaltyping.Mapping[str, IFileSetProducer]additionalInputs?optionalMap<String, IFileSetProducer>AdditionalInputs?optionalIDictionary<string, IFileSetProducer>AdditionalInputs?optional*map[string]IFileSetProducer#

Additional FileSets to put in other directories.

Default: No additional inputs

notes

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:

const script = new pipelines.ShellStep('MainScript', {
  commands: ['npm ci','npm run build','npx cdk synth'],
  input: pipelines.CodePipelineSource.gitHub('org/source1', 'main'),
  additionalInputs: {
    '../siblingdir': pipelines.CodePipelineSource.gitHub('org/source2', 'main'),
  }
});

commandsstring[]commandstyping.List[str]commandsList<String>Commandsstring[]Commands*[]*stringrequired#

Commands to run.

env?optional{ [key: string]: string }env?optionaltyping.Mapping[str, str]env?optionalMap<String, String>Env?optionalIDictionary<string, string>Env?optional*map[string]*string#

Environment variables to set.

Default: No environment variables

envFromCfnOutputs?optional{ [key: string]: CfnOutput }env_from_cfn_outputs?optionaltyping.Mapping[str, CfnOutput]envFromCfnOutputs?optionalMap<String, CfnOutput>EnvFromCfnOutputs?optionalIDictionary<string, CfnOutput>EnvFromCfnOutputs?optional*map[string]CfnOutput#

Set environment variables based on Stack Outputs.

Default: No environment variables created from 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.

input?optionalIFileSetProducerinput?optionalIFileSetProducerinput?optionalIFileSetProducerInput?optionalIFileSetProducerInput?optionalIFileSetProducer#

FileSet to run these scripts on.

Default: No input specified

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.

installCommands?optionalstring[]install_commands?optionaltyping.List[str]installCommands?optionalList<String>InstallCommands?optionalstring[]InstallCommands?optional*[]*string#

Installation commands to run before the regular commands.

Default: No installation commands

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

primaryOutputDirectory?optionalstringprimary_output_directory?optionalstrprimaryOutputDirectory?optionalStringPrimaryOutputDirectory?optionalstringPrimaryOutputDirectory?optional*string#

The directory that will contain the primary output fileset.

Default: No primary output

After running the script, the contents of the given directory will be treated as the primary output of this Step.