StageProps

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

Bases: object

Construction properties of a Pipeline Stage.

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codepipeline as codepipeline

# action: codepipeline.Action

stage_props = codepipeline.StageProps(
    stage_name="stageName",

    # the properties below are optional
    actions=[action],
    transition_disabled_reason="transitionDisabledReason",
    transition_to_enabled=False
)

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]]

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]