StageOptions Struct
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
actionsoptionalIAction[]actionsoptionaltyping.List[IAction]actionsoptionalList<IAction>ActionsoptionalIAction[]Actionsoptional*[]IAction#The list of Actions to create this Stage with.
You can always add more Actions later by calling IStage#addAction.
beforeEntryoptionalConditionsbefore_entryoptionalConditionsbeforeEntryoptionalConditionsBeforeEntryoptionalConditionsBeforeEntryoptionalConditions#The method to use when a stage allows entry.
Default: No conditions are applied before stage entry
onFailureoptionalFailureConditionson_failureoptionalFailureConditionsonFailureoptionalFailureConditionsOnFailureoptionalFailureConditionsOnFailureoptionalFailureConditions#The method to use when a stage has not completed successfully.
Default: No failure conditions are applied
onSuccessoptionalConditionson_successoptionalConditionsonSuccessoptionalConditionsOnSuccessoptionalConditionsOnSuccessoptionalConditions#The method to use when a stage has succeeded.
Default: No success conditions are applied
placementoptionalStagePlacementplacementoptionalStagePlacementplacementoptionalStagePlacementPlacementoptionalStagePlacementPlacementoptionalStagePlacement#The physical, human-readable name to assign to this Pipeline Stage.
transitionDisabledReasonoptionalstringtransition_disabled_reasonoptionalstrtransitionDisabledReasonoptionalStringTransitionDisabledReasonoptionalstringTransitionDisabledReasonoptional*string#The reason for disabling transition to this stage.
Default: 'Transition disabled'
Only applicable if transitionToEnabled is set to false.
transitionToEnabledoptionalbooleantransition_to_enabledoptionalbooltransitionToEnabledoptionalBooleanTransitionToEnabledoptionalboolTransitionToEnabledoptional*bool= true#Whether to enable transition to this stage.