Class ManualApprovalStep

A manual approval step.

Inheritance

System.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(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
ManualApprovalStep(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
ManualApprovalStep(String, IManualApprovalStepProps)

Properties

Comment

The comment associated with this manual approval.

Constructors

ManualApprovalStep(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected ManualApprovalStep(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

ManualApprovalStep(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected ManualApprovalStep(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

ManualApprovalStep(String, IManualApprovalStepProps)

public ManualApprovalStep(string id, IManualApprovalStepProps props = null)

Parameters

id System.String: Identifier for this step.
props IManualApprovalStepProps: Identifier for this step.

Properties

Comment

The comment associated with this manual approval.

public virtual string Comment { get; }

Property Value

System.String

Remarks

Default: - No comment

Implements

IFileSetProducer