# StageOptions

Extends: StageOptions
Extends: StageProps

- Source: [`aws-codepipeline/lib/pipeline.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-codepipeline/lib/pipeline.ts#L180)

## Example

```ts
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

- `actions`: [IAction](/cdk/api/v2/docs/aws-cdk-lib.aws_codepipeline.IAction.html)[] — The list of Actions to create this Stage with.

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

- `beforeEntry`: [Conditions](/cdk/api/v2/docs/aws-cdk-lib.aws_codepipeline.Conditions.html) — The method to use when a stage allows entry.

  **Default:** No conditions are applied before stage entry

- `onFailure`: [FailureConditions](/cdk/api/v2/docs/aws-cdk-lib.aws_codepipeline.FailureConditions.html) — The method to use when a stage has not completed successfully.

  **Default:** No failure conditions are applied

- `onSuccess`: [Conditions](/cdk/api/v2/docs/aws-cdk-lib.aws_codepipeline.Conditions.html) — The method to use when a stage has succeeded.

  **Default:** No success conditions are applied

- `placement`: [StagePlacement](/cdk/api/v2/docs/aws-cdk-lib.aws_codepipeline.StagePlacement.html)

- `stageName`: string (required) — The physical, human-readable name to assign to this Pipeline Stage.

- `transitionDisabledReason`: string — The reason for disabling transition to this stage.

  **Default:** 'Transition disabled'

  Only applicable
  if `transitionToEnabled` is set to `false`.

- `transitionToEnabled`: boolean = true — Whether to enable transition to this stage.
