WaveOptions

class aws_cdk.pipelines.WaveOptions(*, post=None, pre=None)

Bases: object

Options to pass to addWave.

Parameters
  • post (Optional[Sequence[Step]]) – Additional steps to run after all of the stages in the wave. Default: - No additional steps

  • pre (Optional[Sequence[Step]]) – Additional steps to run before any of the stages in the wave. Default: - No additional steps

ExampleMetadata

infused

Example:

pipeline = pipelines.CodePipeline(self, "Pipeline",
    synth=pipelines.ShellStep("Synth",
        input=pipelines.CodePipelineSource.connection("my-org/my-app", "main",
            connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"
        ),
        commands=["npm ci", "npm run build", "npx cdk synth"]
    ),

    # Turn this on because the pipeline uses Docker image assets
    docker_enabled_for_self_mutation=True
)

pipeline.add_wave("MyWave",
    post=[
        pipelines.CodeBuildStep("RunApproval",
            commands=["command-from-image"],
            build_environment=codebuild.BuildEnvironment(
                # The user of a Docker image asset in the pipeline requires turning on
                # 'dockerEnabledForSelfMutation'.
                build_image=codebuild.LinuxBuildImage.from_asset(self, "Image",
                    directory="./docker-image"
                )
            )
        )
    ]
)

Attributes

post

Additional steps to run after all of the stages in the wave.

Default
  • No additional steps

Return type

Optional[List[Step]]

pre

Additional steps to run before any of the stages in the wave.

Default
  • No additional steps

Return type

Optional[List[Step]]