Class Wave

Multiple stages that are deployed in parallel.

Namespace: Amazon.CDK.Pipelines

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class Wave : DeputyBase

Syntax (vb)

Public Class Wave Inherits DeputyBase

Examples

CodePipeline pipeline;

            var europeWave = pipeline.AddWave("Europe");
            europeWave.AddStage(
            new MyApplicationStage(this, "Ireland", new StageProps {
                Env = new Environment { Region = "eu-west-1" }
            }));
            europeWave.AddStage(
            new MyApplicationStage(this, "Germany", new StageProps {
                Env = new Environment { Region = "eu-central-1" }
            }));

Synopsis

Constructors

Properties

Id	Identifier for this Wave.
Post	Additional steps that are run after all of the stages in the wave.
Pre	Additional steps that are run before any of the stages in the wave.
Stages	The stages that are deployed in this wave.

Methods

Constructors

Wave(string, IWaveProps?)

Multiple stages that are deployed in parallel.

public Wave(string id, IWaveProps? props = null)

Parameters

id string: Identifier for this Wave.
props IWaveProps: Identifier for this Wave.

Properties

Id

Identifier for this Wave.

public virtual string Id { get; }

Property Value

string

Post

Additional steps that are run after all of the stages in the wave.

public virtual Step[] Post { get; }

Property Value

Step[]

Pre

Additional steps that are run before any of the stages in the wave.

public virtual Step[] Pre { get; }

Property Value

Step[]

Stages

The stages that are deployed in this wave.

public virtual StageDeployment[] Stages { get; }

Property Value

StageDeployment[]

Methods

AddPost(params Step[])

Add an additional step to run after all of the stages in this wave.

public virtual void AddPost(params Step[] steps)

Parameters

steps Step[]

AddPre(params Step[])

Add an additional step to run before any of the stages in this wave.

public virtual void AddPre(params Step[] steps)

Parameters

steps Step[]

AddStage(Stage, IAddStageOpts?)

Add a Stage to this wave.

public virtual StageDeployment AddStage(Stage stage, IAddStageOpts? options = null)

Parameters

stage Stage
options IAddStageOpts

Returns

StageDeployment