class Wave

Language	Type name
.NET	Amazon.CDK.Pipelines.Wave
Go	github.com/aws/aws-cdk-go/awscdk/v2/pipelines#Wave
Java	software.amazon.awscdk.pipelines.Wave
Python	aws_cdk.pipelines.Wave
TypeScript (source)	aws-cdk-lib » pipelines » Wave

Multiple stages that are deployed in parallel.

Example

declare const pipeline: pipelines.CodePipeline;
const europeWave = pipeline.addWave('Europe');
europeWave.addStage(
  new MyApplicationStage(this, 'Ireland', {
    env: { region: 'eu-west-1' },
  })
);
europeWave.addStage(
  new MyApplicationStage(this, 'Germany', {
    env: { region: 'eu-central-1' },
  })
);

Initializer

new Wave(id: string, props?: WaveProps)

Parameters

• id string — Identifier for this Wave.
• props WaveProps

Properties

Name	Type	Description
id	string	Identifier for this Wave.
post	Step[]	Additional steps that are run after all of the stages in the wave.
pre	Step[]	Additional steps that are run before any of the stages in the wave.
stages	StageDeployment[]	The stages that are deployed in this wave.

---

id

Type: string

Identifier for this Wave.

---

post

Type: Step[]

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

---

pre

Type: Step[]

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

---

stages

Type: StageDeployment[]

The stages that are deployed in this wave.

Methods

Name	Description
addPost(...steps)	Add an additional step to run after all of the stages in this wave.
addPre(...steps)	Add an additional step to run before any of the stages in this wave.
addStage(stage, options?)	Add a Stage to this wave.

---

addPost(...steps)

public addPost(...steps: Step[]): void

Parameters

• steps Step

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

---

addPre(...steps)

public addPre(...steps: Step[]): void

Parameters

• steps Step

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

---

addStage(stage, options?)

public addStage(stage: Stage, options?: AddStageOpts): StageDeployment

Parameters

• stage Stage
• options AddStageOpts

Returns

• StageDeployment

Add a Stage to this wave.

It will be deployed in parallel with all other stages in this wave.