class ManualApprovalStep

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

Implements IFileSetProducer

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

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,
  })],
});

Initializer

new ManualApprovalStep(id: string, props?: ManualApprovalStepProps)

Parameters

• id string — Identifier for this step.
• props ManualApprovalStepProps

Properties

Name	Type	Description
consumedStackOutputs	StackOutputReference[]	StackOutputReferences this step consumes.
dependencies	Step[]	Return the steps this step depends on, based on the FileSets it requires.
dependencyFileSets	FileSet[]	The list of FileSets consumed by this Step.
id	string	Identifier for this step.
isSource	boolean	Whether or not this is a Source step.
comment?	string	The comment associated with this manual approval.
notificationTopic?	ITopic	Optional SNS topic to send notifications.
primaryOutput?	FileSet	The primary FileSet produced by this Step.
reviewUrl?	string	The URL for review associated with this manual approval.

---

consumedStackOutputs

Type: StackOutputReference[]

StackOutputReferences this step consumes.

---

dependencies

Type: Step[]

Return the steps this step depends on, based on the FileSets it requires.

---

dependencyFileSets

Type: FileSet[]

The list of FileSets consumed by this Step.

---

id

Type: string

Identifier for this step.

---

isSource

Type: boolean

Whether or not this is a Source step.

What it means to be a Source step depends on the engine.

---

comment?

Type: string (optional, default: No comment)

The comment associated with this manual approval.

---

notificationTopic?

Type: ITopic (optional, default: No notifications)

Optional SNS topic to send notifications.

---

primaryOutput?

Type: FileSet (optional)

The primary FileSet produced by this Step.

Not all steps produce an output FileSet--if they do you can substitute the Step object for the FileSet object.

---

reviewUrl?

Type: string (optional, default: No URL)

The URL for review associated with this manual approval.

Methods

Name	Description
addStepDependency(step)	Add a dependency on another step.
toString()	Return a string representation of this Step.

---

addStepDependency(step)

public addStepDependency(step: Step): void

Parameters

• step Step

Add a dependency on another step.

---

toString()

public toString(): string

Returns

• string

Return a string representation of this Step.