Class Wave
Multiple stages that are deployed in parallel.
Inheritance
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Pipelines.dll
Syntax (csharp)
public class Wave : DeputyBase
Syntax (vb)
Public Class Wave
Inherits DeputyBase
Remarks
ExampleMetadata: infused
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
Wave(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
Wave(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Wave(String, IWaveProps) |
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
AddPost(Step[]) | Add an additional step to run after all of the stages in this wave. |
AddPre(Step[]) | Add an additional step to run before any of the stages in this wave. |
AddStage(Stage, IAddStageOpts) | Add a Stage to this wave. |
Constructors
Wave(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected Wave(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
Wave(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected Wave(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Wave(String, IWaveProps)
public Wave(string id, IWaveProps props = null)
Parameters
- id System.String
Identifier for this Wave.
- props IWaveProps
Identifier for this Wave.
Properties
Id
Identifier for this Wave.
public virtual string Id { get; }
Property Value
System.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
Methods
AddPost(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(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
Remarks
It will be deployed in parallel with all other stages in this wave.