Class ManualApprovalStep

A manual approval step.

Inheritance

object

Step

ManualApprovalStep

Implements

IFileSetProducer

Inherited Members

Step.Sequence(Step[])

Step.AddDependencyFileSet(FileSet)

Step.AddStepDependency(Step)

Step.ConfigurePrimaryOutput(FileSet)

Step.DiscoverReferencedOutputs(object)

Step.ToString()

Step.ConsumedStackOutputs

Step.Dependencies

Step.DependencyFileSets

Step.Id

Step.IsSource

Step.PrimaryOutput

Namespace: Amazon.CDK.Pipelines

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ManualApprovalStep : Step, IFileSetProducer

Syntax (vb)

Public Class ManualApprovalStep Inherits Step Implements IFileSetProducer

Remarks

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.

ExampleMetadata: infused

Examples

CodePipeline pipeline;

             var preprod = new MyApplicationStage(this, "PreProd");
             var prod = new MyApplicationStage(this, "Prod");

             pipeline.AddStage(preprod, new AddStageOpts {
                 Post = new [] {
                     new ShellStep("Validate Endpoint", new ShellStepProps {
                         Commands = new [] { "curl -Ssf https://my.webservice.com/" }
                     }) }
             });
             pipeline.AddStage(prod, new AddStageOpts {
                 Pre = new [] { new ManualApprovalStep("PromoteToProd") }
             });

Synopsis

Constructors

ManualApprovalStep(string, IManualApprovalStepProps?)

A manual approval step.

Properties

Comment

The comment associated with this manual approval.

Constructors

ManualApprovalStep(string, IManualApprovalStepProps?)

A manual approval step.

public ManualApprovalStep(string id, IManualApprovalStepProps? props = null)

Parameters

id string

Identifier for this step.

props IManualApprovalStepProps

Identifier for this step.

Remarks

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.

ExampleMetadata: infused

Properties

Comment

The comment associated with this manual approval.

public virtual string? Comment { get; }

Property Value

string

Remarks

Default: - No comment

Implements

IFileSetProducer