java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.StageDeployment

All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-23T18:58:29.835Z") @Stability(Stable) 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.*;
 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());

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors

    protected

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

    protected

    StageDeployment(software.amazon.jsii.JsiiObjectRef objRef)

  • Method Summary

    void

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

    void

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

    Create a new StageDeployment from a Stage.

    Create a new StageDeployment from a Stage.

    getPost()

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

    getPre()

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

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

    getStacks()

    The stacks deployed in this stage.

    Instructions for additional steps that are run at stack level.

    The display name of this stage.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • StageDeployment

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

    • StageDeployment

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

  • Method Details

    • fromStage

      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

      @Stability(Stable) @NotNull public static StageDeployment fromStage(@NotNull 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

      @Stability(Stable) public void addPost(@NotNull Step... steps)

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

      Parameters:
      steps - This parameter is required.

    • addPre

      @Stability(Stable) public void addPre(@NotNull Step... steps)

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

      Parameters:
      steps - This parameter is required.

    • getPost

      @Stability(Stable) @NotNull public List<Step> getPost()

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

    • getPre

      @Stability(Stable) @NotNull public List<Step> getPre()

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

    • getStacks

      The stacks deployed in this stage.

    • getStackSteps

      @Stability(Stable) @NotNull public List<StackSteps> getStackSteps()

      Instructions for additional steps that are run at stack level.

    • getStageName

      @Stability(Stable) @NotNull public String getStageName()

      The display name of this stage.

    • getPrepareStep

      @Stability(Stable) @Nullable public Boolean getPrepareStep()

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