Package software.amazon.awscdk.pipelines

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());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ManualApprovalStep.Builder	A fluent builder for ManualApprovalStep.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.pipelines.IFileSetProducer

IFileSetProducer.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
	ManualApprovalStep(String id)
	ManualApprovalStep(String id, ManualApprovalStepProps props)
protected	ManualApprovalStep(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ManualApprovalStep(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	getComment()	The comment associated with this manual approval.

Methods inherited from class software.amazon.awscdk.pipelines.Step

addDependencyFileSet, addStepDependency, configurePrimaryOutput, discoverReferencedOutputs, getDependencies, getDependencyFileSets, getId, getIsSource, getPrimaryOutput, sequence, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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