Construction properties for a ShellStep.
Inheritance
ShellStepProps
Implements
Inherited Members
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ShellStepProps : IShellStepProps
Syntax (vb)
Public Class ShellStepProps Implements IShellStepProps
Examples
CodePipeline pipeline;
var preprod = new MyApplicationStage(this, "PreProd");
var prod = new MyApplicationStage(this, "Prod");
var topic = new Topic(this, "ChangeApprovalTopic");
pipeline.AddStage(preprod, new AddStageOpts {
Post = new [] {
new ShellStep("Validate Endpoint", new ShellStepProps {
Commands = new [] { "curl -Ssf https://my.webservice.com/" }
}) }
});
pipeline.AddStage(prod, new AddStageOpts {
Pre = new [] { new ManualApprovalStep("PromoteToProd", new ManualApprovalStepProps {
//All options below are optional
Comment = "Please validate changes",
ReviewUrl = "https://my.webservice.com/",
NotificationTopic = topic
}) }
});
Synopsis
Constructors
Properties
| AdditionalInputs | Additional FileSets to put in other directories. |
| Commands | Commands to run. |
| Env | Environment variables to set. |
| EnvFromCfnOutputs | Set environment variables based on Stack Outputs. |
| Input | FileSet to run these scripts on. |
| InstallCommands | Installation commands to run before the regular commands. |
| PrimaryOutputDirectory | The directory that will contain the primary output fileset. |
Constructors
ShellStepProps()
Construction properties for a ShellStep.
Examples
CodePipeline pipeline;
var preprod = new MyApplicationStage(this, "PreProd");
var prod = new MyApplicationStage(this, "Prod");
var topic = new Topic(this, "ChangeApprovalTopic");
pipeline.AddStage(preprod, new AddStageOpts {
Post = new [] {
new ShellStep("Validate Endpoint", new ShellStepProps {
Commands = new [] { "curl -Ssf https://my.webservice.com/" }
}) }
});
pipeline.AddStage(prod, new AddStageOpts {
Pre = new [] { new ManualApprovalStep("PromoteToProd", new ManualApprovalStepProps {
//All options below are optional
Comment = "Please validate changes",
ReviewUrl = "https://my.webservice.com/",
NotificationTopic = topic
}) }
});
Properties
AdditionalInputs
Additional FileSets to put in other directories.
public IDictionary<string, IFileSetProducer>? AdditionalInputs { get; set; }
Property Value
Commands
Env
Environment variables to set.
public IDictionary<string, string>? Env { get; set; }
Property Value
EnvFromCfnOutputs
Set environment variables based on Stack Outputs.
public IDictionary<string, CfnOutput>? EnvFromCfnOutputs { get; set; }
Property Value
Input
FileSet to run these scripts on.
public IFileSetProducer? Input { get; set; }
Property Value
InstallCommands
Installation commands to run before the regular commands.
public string[]? InstallCommands { get; set; }
Property Value
string[]
Remarks
PrimaryOutputDirectory
The directory that will contain the primary output fileset.
public string? PrimaryOutputDirectory { get; set; }