interface ManualApprovalStepProps

Language	Type name
.NET	Amazon.CDK.Pipelines.ManualApprovalStepProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/pipelines#ManualApprovalStepProps
Java	software.amazon.awscdk.pipelines.ManualApprovalStepProps
Python	aws_cdk.pipelines.ManualApprovalStepProps
TypeScript (source)	aws-cdk-lib » pipelines » ManualApprovalStepProps

Construction properties for a ManualApprovalStep.

Example

declare const pipeline: pipelines.CodePipeline;
const preprod = new MyApplicationStage(this, 'PreProd');
const prod = new MyApplicationStage(this, 'Prod');
const topic = new sns.Topic(this, 'ChangeApprovalTopic');

pipeline.addStage(preprod, {
  post: [
    new pipelines.ShellStep('Validate Endpoint', {
      commands: ['curl -Ssf https://my.webservice.com/'],
    }),
  ],
});
pipeline.addStage(prod, {
  pre: [new pipelines.ManualApprovalStep('PromoteToProd', {
    //All options below are optional
    comment: 'Please validate changes',
    reviewUrl: 'https://my.webservice.com/',
    notificationTopic: topic,
  })],
});

Properties

Name	Type	Description
comment?	string	The comment to display with this manual approval.
notificationTopic?	ITopic	Optional SNS topic to send notifications to when an approval is pending.
reviewUrl?	string	The URL for review associated with this manual approval.

---

comment?

Type: string (optional, default: No comment)

The comment to display with this manual approval.

---

notificationTopic?

Type: ITopic (optional, default: No notifications)

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

---

reviewUrl?

Type: string (optional, default: No URL)

The URL for review associated with this manual approval.