interface StageProps

Language	Type name
.NET	Amazon.CDK.AWS.CodePipeline.StageProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#StageProps
Java	software.amazon.awscdk.services.codepipeline.StageProps
Python	aws_cdk.aws_codepipeline.StageProps
TypeScript (source)	aws-cdk-lib » aws_codepipeline » StageProps

Construction properties of a Pipeline Stage.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';

declare const action: codepipeline.Action;
declare const rule: codepipeline.Rule;
const stageProps: codepipeline.StageProps = {
  stageName: 'stageName',

  // the properties below are optional
  actions: [action],
  beforeEntry: {
    conditions: [{
      result: codepipeline.Result.ROLLBACK,
      rules: [rule],
    }],
  },
  onFailure: {
    conditions: [{
      result: codepipeline.Result.ROLLBACK,
      rules: [rule],
    }],
    result: codepipeline.Result.ROLLBACK,
    retryMode: codepipeline.RetryMode.ALL_ACTIONS,
  },
  onSuccess: {
    conditions: [{
      result: codepipeline.Result.ROLLBACK,
      rules: [rule],
    }],
  },
  transitionDisabledReason: 'transitionDisabledReason',
  transitionToEnabled: false,
};

Properties

Name	Type	Description
stageName	string	The physical, human-readable name to assign to this Pipeline Stage.
actions?	IAction[]	The list of Actions to create this Stage with.
beforeEntry?	Conditions	The method to use when a stage allows entry.
onFailure?	FailureConditions	The method to use when a stage has not completed successfully.
onSuccess?	Conditions	The method to use when a stage has succeeded.
transitionDisabledReason?	string	The reason for disabling transition to this stage.
transitionToEnabled?	boolean	Whether to enable transition to this stage.

---

stageName

Type: string

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

---

actions?

Type: IAction[] (optional)

The list of Actions to create this Stage with.

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

---

beforeEntry?

Type: Conditions (optional, default: No conditions are applied before stage entry)

The method to use when a stage allows entry.

---

onFailure?

Type: FailureConditions (optional, default: No failure conditions are applied)

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

---

onSuccess?

Type: Conditions (optional, default: No success conditions are applied)

The method to use when a stage has succeeded.

---

transitionDisabledReason?

Type: string (optional, default: 'Transition disabled')

The reason for disabling transition to this stage.

Only applicable if transitionToEnabled is set to false.

---

transitionToEnabled?

Type: boolean (optional, default: true)

Whether to enable transition to this stage.