Class WaveOptions

Options to pass to addWave.

Implements
Inherited Members
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class WaveOptions : IWaveOptions
Syntax (vb)
Public Class WaveOptions Implements IWaveOptions
Examples
var pipeline = new CodePipeline(this, "Pipeline", new CodePipelineProps {
                Synth = new ShellStep("Synth", new ShellStepProps {
                    Input = CodePipelineSource.Connection("my-org/my-app", "main", new ConnectionSourceOptions {
                        ConnectionArn = "arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"
                    }),
                    Commands = new [] { "npm ci", "npm run build", "npx cdk synth" }
                }),

                // Turn this on because the pipeline uses Docker image assets
                DockerEnabledForSelfMutation = true
            });

            pipeline.AddWave("MyWave", new WaveOptions {
                Post = new [] {
                    new CodeBuildStep("RunApproval", new CodeBuildStepProps {
                        Commands = new [] { "command-from-image" },
                        BuildEnvironment = new BuildEnvironment {
                            // The user of a Docker image asset in the pipeline requires turning on
                            // 'dockerEnabledForSelfMutation'.
                            BuildImage = LinuxBuildImage.FromAsset(this, "Image", new DockerImageAssetProps {
                                Directory = "./docker-image"
                            })
                        }
                    }) }
            });

Synopsis

Constructors

Properties

Post

Additional steps to run after all of the stages in the wave.

Pre

Additional steps to run before any of the stages in the wave.

Constructors

WaveOptions()

Options to pass to addWave.

Examples
var pipeline = new CodePipeline(this, "Pipeline", new CodePipelineProps {
                Synth = new ShellStep("Synth", new ShellStepProps {
                    Input = CodePipelineSource.Connection("my-org/my-app", "main", new ConnectionSourceOptions {
                        ConnectionArn = "arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"
                    }),
                    Commands = new [] { "npm ci", "npm run build", "npx cdk synth" }
                }),

                // Turn this on because the pipeline uses Docker image assets
                DockerEnabledForSelfMutation = true
            });

            pipeline.AddWave("MyWave", new WaveOptions {
                Post = new [] {
                    new CodeBuildStep("RunApproval", new CodeBuildStepProps {
                        Commands = new [] { "command-from-image" },
                        BuildEnvironment = new BuildEnvironment {
                            // The user of a Docker image asset in the pipeline requires turning on
                            // 'dockerEnabledForSelfMutation'.
                            BuildImage = LinuxBuildImage.FromAsset(this, "Image", new DockerImageAssetProps {
                                Directory = "./docker-image"
                            })
                        }
                    }) }
            });

Properties

Post

Additional steps to run after all of the stages in the wave.

public Step[]? Post { get; set; }
Property Value

Step[]

Pre

Additional steps to run before any of the stages in the wave.

public Step[]? Pre { get; set; }
Property Value

Step[]

Implements