Class StageDeployment

Deployment of a single Stage.

Inheritance

System.Object

StageDeployment

Namespace: Amazon.CDK.Pipelines

Assembly: Amazon.CDK.Pipelines.dll

Syntax (csharp)

public class StageDeployment : DeputyBase

Syntax (vb)

Public Class StageDeployment
    Inherits DeputyBase

Remarks

A Stage consists of one or more Stacks, which will be deployed in dependency order.

ExampleMetadata: fixture=_generated

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

Constructors

StageDeployment(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
StageDeployment(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

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.
Stacks	The stacks deployed in this stage.
StackSteps	Instructions for additional steps that are run at stack level.
StageName	The display name of this stage.

Methods

AddPost(Step[])	Add an additional step to run after all of the stacks in this stage.
AddPre(Step[])	Add an additional step to run before any of the stacks in this stage.
FromStage(Stage, IStageDeploymentProps)	Create a new `StageDeployment` from a `Stage`.

Constructors

StageDeployment(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected StageDeployment(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

StageDeployment(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected StageDeployment(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

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[]

Stacks

The stacks deployed in this stage.

public virtual StackDeployment[] Stacks { get; }

Property Value

StackDeployment[]

StackSteps

Instructions for additional steps that are run at stack level.

public virtual IStackSteps[] StackSteps { get; }

Property Value

IStackSteps[]

StageName

The display name of this stage.

public virtual string StageName { get; }

Property Value

System.String

Methods

AddPost(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(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

Remarks

Synthesizes the target stage, and deployes the stacks found inside in dependency order.