Interface IStageProps

Construction properties of a Pipeline Stage.

Namespace: Amazon.CDK.AWS.CodePipeline

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IStageProps

Syntax (vb)

Public Interface IStageProps

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.CodePipeline;

            Action action;
            Rule rule;

            var stageProps = new StageProps {
                StageName = "stageName",

                // the properties below are optional
                Actions = new [] { action },
                BeforeEntry = new Conditions {
                    Conditions = new [] { new Condition {
                        Result = Result.ROLLBACK,
                        Rules = new [] { rule }
                    } }
                },
                OnFailure = new FailureConditions {
                    Conditions = new [] { new Condition {
                        Result = Result.ROLLBACK,
                        Rules = new [] { rule }
                    } },
                    Result = Result.ROLLBACK,
                    RetryMode = RetryMode.ALL_ACTIONS
                },
                OnSuccess = new Conditions {
                    Conditions = new [] { new Condition {
                        Result = Result.ROLLBACK,
                        Rules = new [] { rule }
                    } }
                },
                TransitionDisabledReason = "transitionDisabledReason",
                TransitionToEnabled = false
            };

Synopsis

Properties

Actions	The list of Actions to create this Stage with.
BeforeEntry	The method to use when a stage allows entry.
OnFailure	The method to use when a stage has not completed successfully.
OnSuccess	The method to use when a stage has succeeded.
StageName	The physical, human-readable name to assign to this Pipeline Stage.
TransitionDisabledReason	The reason for disabling transition to this stage.
TransitionToEnabled	Whether to enable transition to this stage.

Properties

Actions

The list of Actions to create this Stage with.

IAction[]? Actions { get; }

Property Value

IAction[]

Remarks

You can always add more Actions later by calling IStage#addAction.

BeforeEntry

The method to use when a stage allows entry.

IConditions? BeforeEntry { get; }

Property Value

IConditions

Remarks

Default: - No conditions are applied before stage entry

OnFailure

The method to use when a stage has not completed successfully.

IFailureConditions? OnFailure { get; }

Property Value

IFailureConditions

Remarks

Default: - No failure conditions are applied

OnSuccess

The method to use when a stage has succeeded.

IConditions? OnSuccess { get; }

Property Value

IConditions

Remarks

Default: - No success conditions are applied

StageName

The physical, human-readable name to assign to this Pipeline Stage.

string StageName { get; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

TransitionDisabledReason

The reason for disabling transition to this stage.

string? TransitionDisabledReason { get; }

Property Value

string

Remarks

Only applicable if transitionToEnabled is set to false.

Default: 'Transition disabled'

TransitionToEnabled

Whether to enable transition to this stage.

bool? TransitionToEnabled { get; }

Property Value

bool?

Remarks

Default: true