Package software.amazon.awscdk.pipelines

Interface ManualApprovalStepProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ManualApprovalStepProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:50.934Z")
@Stability(Stable)
public interface ManualApprovalStepProps
extends software.amazon.jsii.JsiiSerializable

Construction properties for a ManualApprovalStep.

Example:

 CodePipeline pipeline;
 MyApplicationStage preprod = new MyApplicationStage(this, "PreProd");
 MyApplicationStage prod = new MyApplicationStage(this, "Prod");
 Topic topic = new Topic(this, "ChangeApprovalTopic");
 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(ManualApprovalStep.Builder.create("PromoteToProd")
                 //All options below are optional
                 .comment("Please validate changes")
                 .reviewUrl("https://my.webservice.com/")
                 .notificationTopic(topic)
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ManualApprovalStepProps.Builder	builder()
default String	getComment()	The comment to display with this manual approval.
default ITopic	getNotificationTopic()	Optional SNS topic to send notifications to when an approval is pending.
default String	getReviewUrl()	The URL for review associated with this manual approval.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComment

@Stability(Stable)
@Nullable
default String getComment()

The comment to display with this manual approval.

Default: - No comment

getNotificationTopic

@Stability(Stable)
@Nullable
default ITopic getNotificationTopic()

Optional SNS topic to send notifications to when an approval is pending.

Default: - No notifications

getReviewUrl

@Stability(Stable)
@Nullable
default String getReviewUrl()

The URL for review associated with this manual approval.

Default: - No URL

builder

@Stability(Stable)
static ManualApprovalStepProps.Builder builder()

Returns:

a ManualApprovalStepProps.Builder of ManualApprovalStepProps