Package software.amazon.awscdk.pipelines

Interface WaveOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
WaveOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:26.238Z") @Stability(Stable) public interface WaveOptions extends software.amazon.jsii.JsiiSerializable
Options to pass to addWave.

Example: 

 CodePipeline pipeline = CodePipeline.Builder.create(this, "Pipeline")
         .synth(ShellStep.Builder.create("Synth")
                 .input(CodePipelineSource.connection("my-org/my-app", "main", ConnectionSourceOptions.builder()
                         .connectionArn("arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41")
                         .build()))
                 .commands(List.of("npm ci", "npm run build", "npx cdk synth"))
                 .build())
         // Turn this on because the pipeline uses Docker image assets
         .dockerEnabledForSelfMutation(true)
         .build();
 pipeline.addWave("MyWave", WaveOptions.builder()
         .post(List.of(
             CodeBuildStep.Builder.create("RunApproval")
                     .commands(List.of("command-from-image"))
                     .buildEnvironment(BuildEnvironment.builder()
                             // The user of a Docker image asset in the pipeline requires turning on
                             // 'dockerEnabledForSelfMutation'.
                             .buildImage(LinuxBuildImage.fromAsset(this, "Image", DockerImageAssetProps.builder()
                                     .directory("./docker-image")
                                     .build()))
                             .build())
                     .build()))
         .build());

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    WaveOptions.Builder
    A builder for WaveOptions
    static final class 
    WaveOptions.Jsii$Proxy
    An implementation for WaveOptions

  • Method Summary

    Modifier and Type
    Method
    Description
    static WaveOptions.Builder
    builder()
     
    default List<Step>
    getPost()
    Additional steps to run after all of the stages in the wave.
    default List<Step>
    getPre()
    Additional steps to run before any of the stages in the wave.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getPost

      @Stability(Stable) @Nullable default List<Step> getPost()
      Additional steps to run after all of the stages in the wave.

      Default: - No additional steps

    • getPre

      @Stability(Stable) @Nullable default List<Step> getPre()
      Additional steps to run before any of the stages in the wave.

      Default: - No additional steps

    • builder

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