Interface StagePlacement

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
StagePlacement.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.966Z") @Stability(Stable) public interface StagePlacement extends software.amazon.jsii.JsiiSerializable
Allows you to control where to place a new Stage when it's added to the Pipeline.

Note that you can provide only one of the below properties - specifying more than one will result in a validation error.

Example:

 // Insert a new Stage at an arbitrary point
 Pipeline pipeline;
 IStage anotherStage;
 IStage yetAnotherStage;
 IStage someStage = pipeline.addStage(StageOptions.builder()
         .stageName("SomeStage")
         .placement(StagePlacement.builder()
                 // note: you can only specify one of the below properties
                 .rightBefore(anotherStage)
                 .justAfter(yetAnotherStage)
                 .build())
         .build());
 

See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    A builder for StagePlacement
    static final class 
    An implementation for StagePlacement
  • Method Summary

    Modifier and Type
    Method
    Description
     
    default IStage
    Inserts the new Stage as a child of the given Stage (changing its current child Stage, if it had one).
    default IStage
    Inserts the new Stage as a parent of the given Stage (changing its current parent Stage, if it had one).

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson
  • Method Details

    • getJustAfter

      @Stability(Stable) @Nullable default IStage getJustAfter()
      Inserts the new Stage as a child of the given Stage (changing its current child Stage, if it had one).
    • getRightBefore

      @Stability(Stable) @Nullable default IStage getRightBefore()
      Inserts the new Stage as a parent of the given Stage (changing its current parent Stage, if it had one).
    • builder

      @Stability(Stable) static StagePlacement.Builder builder()
      Returns:
      a StagePlacement.Builder of StagePlacement