StageOptions

class aws_cdk.aws_codepipeline.StageOptions(*, stage_name, actions=None, transition_disabled_reason=None, transition_to_enabled=None, placement=None)

Bases: aws_cdk.aws_codepipeline.StageProps

Parameters
  • stage_name (str) – The physical, human-readable name to assign to this Pipeline Stage.

  • actions (Optional[Sequence[IAction]]) – The list of Actions to create this Stage with. You can always add more Actions later by calling {@link IStage#addAction}.

  • transition_disabled_reason (Optional[str]) – The reason for disabling transition to this stage. Only applicable if transitionToEnabled is set to false. Default: ‘Transition disabled’

  • transition_to_enabled (Optional[bool]) – Whether to enable transition to this stage. Default: true

  • placement (Optional[StagePlacement]) –

ExampleMetadata

infused

Example:

import aws_cdk.aws_stepfunctions as stepfunctions


pipeline = codepipeline.Pipeline(self, "MyPipeline")
input_artifact = codepipeline.Artifact()
start_state = stepfunctions.Pass(self, "StartState")
simple_state_machine = stepfunctions.StateMachine(self, "SimpleStateMachine",
    definition=start_state
)
step_function_action = codepipeline_actions.StepFunctionInvokeAction(
    action_name="Invoke",
    state_machine=simple_state_machine,
    state_machine_input=codepipeline_actions.StateMachineInput.file_path(input_artifact.at_path("assets/input.json"))
)
pipeline.add_stage(
    stage_name="StepFunctions",
    actions=[step_function_action]
)

Attributes

actions

The list of Actions to create this Stage with.

You can always add more Actions later by calling {@link IStage#addAction}.

Return type

Optional[List[IAction]]

placement
Return type

Optional[StagePlacement]

stage_name

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

Return type

str

transition_disabled_reason

The reason for disabling transition to this stage.

Only applicable if transitionToEnabled is set to false.

Default

‘Transition disabled’

Return type

Optional[str]

transition_to_enabled

Whether to enable transition to this stage.

Default

true

Return type

Optional[bool]