StageDeploymentProps

class aws_cdk.pipelines.StageDeploymentProps(*, post=None, pre=None, stack_steps=None, stage_name=None)

Bases: object

Properties for a StageDeployment.

Parameters
  • post (Optional[Sequence[Step]]) – Additional steps to run after all of the stacks in the stage. Default: - No additional steps

  • pre (Optional[Sequence[Step]]) – Additional steps to run before any of the stacks in the stage. Default: - No additional steps

  • stack_steps (Optional[Sequence[Union[StackSteps, Dict[str, Any]]]]) – Instructions for additional steps that are run at the stack level. Default: - No additional instructions

  • stage_name (Optional[str]) – Stage name to use in the pipeline. Default: - Use Stage’s construct ID

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 as cdk
from aws_cdk import pipelines

# stack: cdk.Stack
# step: pipelines.Step

stage_deployment_props = pipelines.StageDeploymentProps(
    post=[step],
    pre=[step],
    stack_steps=[pipelines.StackSteps(
        stack=stack,

        # the properties below are optional
        change_set=[step],
        post=[step],
        pre=[step]
    )],
    stage_name="stageName"
)

Attributes

post

Additional steps to run after all of the stacks in the stage.

Default
  • No additional steps

Return type

Optional[List[Step]]

pre

Additional steps to run before any of the stacks in the stage.

Default
  • No additional steps

Return type

Optional[List[Step]]

stack_steps

Instructions for additional steps that are run at the stack level.

Default
  • No additional instructions

Return type

Optional[List[StackSteps]]

stage_name

Stage name to use in the pipeline.

Default
  • Use Stage’s construct ID

Return type

Optional[str]