Class StageDeployment

Deployment of a single Stage.

Inheritance

StageDeployment

Namespace: Amazon.CDK.Pipelines

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class StageDeployment : DeputyBase

Syntax (vb)

Public Class StageDeployment Inherits DeputyBase

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Amazon.CDK.Pipelines;

             Stack stack;
             Stage stage;
             Step step;

             var stageDeployment = StageDeployment.FromStage(stage, new StageDeploymentProps {
                 Post = new [] { step },
                 Pre = new [] { step },
                 StackSteps = new [] { new StackSteps {
                     Stack = stack,

                     // the properties below are optional
                     ChangeSet = new [] { step },
                     Post = new [] { step },
                     Pre = new [] { step }
                 } },
                 StageName = "stageName"
             });

Synopsis

Properties

Post	Additional steps that are run after all of the stacks in the stage.
Pre	Additional steps that are run before any of the stacks in the stage.
PrepareStep	Determine if all stacks in stage should be deployed with prepare step or not.
StackSteps	Instructions for additional steps that are run at stack level.
Stacks	The stacks deployed in this stage.
StageName	The display name of this stage.

Methods

Properties

Post

Additional steps that are run after all of the stacks in the stage.

public virtual Step[] Post { get; }

Property Value

Step[]

Pre

Additional steps that are run before any of the stacks in the stage.

public virtual Step[] Pre { get; }

Property Value

Step[]

PrepareStep

Determine if all stacks in stage should be deployed with prepare step or not.

public virtual bool? PrepareStep { get; }

Property Value

bool?

StackSteps

Instructions for additional steps that are run at stack level.

public virtual IStackSteps[] StackSteps { get; }

Property Value

IStackSteps[]

Stacks

The stacks deployed in this stage.

public virtual StackDeployment[] Stacks { get; }

Property Value

StackDeployment[]

StageName

The display name of this stage.

public virtual string StageName { get; }

Property Value

string

Methods

AddPost(params Step[])

Add an additional step to run after all of the stacks in this stage.

public virtual void AddPost(params Step[] steps)

Parameters

steps Step[]

AddPre(params Step[])

Add an additional step to run before any of the stacks in this stage.

public virtual void AddPre(params Step[] steps)

Parameters

steps Step[]

FromStage(Stage, IStageDeploymentProps?)

Create a new StageDeployment from a Stage.

public static StageDeployment FromStage(Stage stage, IStageDeploymentProps? props = null)

Parameters

stage Stage
props IStageDeploymentProps

Returns

StageDeployment