Class ManualApprovalStep

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.pipelines.Step
software.amazon.awscdk.pipelines.ManualApprovalStep
All Implemented Interfaces:
IFileSetProducer, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.834Z") @Stability(Stable) public class ManualApprovalStep extends Step
A manual approval step.

If this step is added to a Pipeline, the Pipeline will be paused waiting for a human to resume it

Only engines that support pausing the deployment will support this step type.

Example:

 CodePipeline pipeline;
 MyApplicationStage preprod = new MyApplicationStage(this, "PreProd");
 MyApplicationStage prod = new MyApplicationStage(this, "Prod");
 pipeline.addStage(preprod, AddStageOpts.builder()
         .post(List.of(
             ShellStep.Builder.create("Validate Endpoint")
                     .commands(List.of("curl -Ssf https://my.webservice.com/"))
                     .build()))
         .build());
 pipeline.addStage(prod, AddStageOpts.builder()
         .pre(List.of(
             new ManualApprovalStep("PromoteToProd")))
         .build());
 
  • Constructor Details

    • ManualApprovalStep

      protected ManualApprovalStep(software.amazon.jsii.JsiiObjectRef objRef)
    • ManualApprovalStep

      protected ManualApprovalStep(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • ManualApprovalStep

      @Stability(Stable) public ManualApprovalStep(@NotNull String id, @Nullable ManualApprovalStepProps props)
      Parameters:
      id - This parameter is required.
      props -
    • ManualApprovalStep

      @Stability(Stable) public ManualApprovalStep(@NotNull String id)
      Parameters:
      id - This parameter is required.
  • Method Details

    • getComment

      @Stability(Stable) @Nullable public String getComment()
      The comment associated with this manual approval.

      Default: - No comment