interface StageOptions

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

Example

import * as stepfunctions from 'aws-cdk-lib/aws-stepfunctions';
const pipeline = new codepipeline.Pipeline(this, 'MyPipeline');
const startState = new stepfunctions.Pass(this, 'StartState');
const simpleStateMachine  = new stepfunctions.StateMachine(this, 'SimpleStateMachine', {
  definition: startState,
});
const stepFunctionAction = new codepipeline_actions.StepFunctionInvokeAction({
  actionName: 'Invoke',
  stateMachine: simpleStateMachine,
  stateMachineInput: codepipeline_actions.StateMachineInput.literal({ IsHelloWorldExample: true }),
});
pipeline.addStage({
  stageName: 'StepFunctions',
  actions: [stepFunctionAction],
});

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.
placement?	StagePlacement
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.

---

placement?

Type: StagePlacement (optional)

---

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.