software.amazon.awscdk.pipelines

Class StageDeployment

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.StageDeployment

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-13T01:13:40.888Z")
public class StageDeployment
extends software.amazon.jsii.JsiiObject

Deployment of a single `Stage`.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.pipelines.*;
 Stack stack;
 Stage stage;
 Step step;
 StageDeployment stageDeployment = StageDeployment.fromStage(stage, StageDeploymentProps.builder()
         .post(List.of(step))
         .pre(List.of(step))
         .stackSteps(List.of(StackSteps.builder()
                 .stack(stack)
                 // the properties below are optional
                 .changeSet(List.of(step))
                 .post(List.of(step))
                 .pre(List.of(step))
                 .build()))
         .stageName("stageName")
         .build());
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StageDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	StageDeployment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addPost(Step... steps) Add an additional step to run after all of the stacks in this stage.
void	addPre(Step... steps) Add an additional step to run before any of the stacks in this stage.
static StageDeployment	fromStage(Stage stage) Create a new `StageDeployment` from a `Stage`.
static StageDeployment	fromStage(Stage stage, StageDeploymentProps props) Create a new `StageDeployment` from a `Stage`.
java.util.List<Step>	getPost() Additional steps that are run after all of the stacks in the stage.
java.util.List<Step>	getPre() Additional steps that are run before any of the stacks in the stage.
java.util.List<StackDeployment>	getStacks() The stacks deployed in this stage.
java.util.List<StackSteps>	getStackSteps() Instructions for additional steps that are run at stack level.
java.lang.String	getStageName() The display name of this stage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StageDeployment

protected StageDeployment(software.amazon.jsii.JsiiObjectRef objRef)

StageDeployment

protected StageDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

fromStage

public static StageDeployment fromStage(Stage stage,
                                        StageDeploymentProps props)

Create a new `StageDeployment` from a `Stage`.

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

Parameters:

stage - This parameter is required.

props -

fromStage

public static StageDeployment fromStage(Stage stage)

Create a new `StageDeployment` from a `Stage`.

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

Parameters:

stage - This parameter is required.

addPost

public void addPost(Step... steps)

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

Parameters:

steps - This parameter is required.

addPre

public void addPre(Step... steps)

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

Parameters:

steps - This parameter is required.

getPost

public java.util.List<Step> getPost()

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

getPre

public java.util.List<Step> getPre()

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

getStacks

public java.util.List<StackDeployment> getStacks()

The stacks deployed in this stage.

getStackSteps

public java.util.List<StackSteps> getStackSteps()

Instructions for additional steps that are run at stack level.

getStageName

public java.lang.String getStageName()

The display name of this stage.