aws-cdk-lib.pipelines.StageDeploymentProps

interface StageDeploymentProps

LanguageType name
.NETAmazon.CDK.Pipelines.StageDeploymentProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/pipelines#StageDeploymentProps
Javasoftware.amazon.awscdk.pipelines.StageDeploymentProps
Pythonaws_cdk.pipelines.StageDeploymentProps
TypeScript (source)aws-cdk-lib » pipelines » StageDeploymentProps

Properties for a StageDeployment.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { pipelines } from 'aws-cdk-lib';

declare const stack: cdk.Stack;
declare const step: pipelines.Step;
const stageDeploymentProps: pipelines.StageDeploymentProps = {
  post: [step],
  pre: [step],
  stackSteps: [{
    stack: stack,

    // the properties below are optional
    changeSet: [step],
    post: [step],
    pre: [step],
  }],
  stageName: 'stageName',
};

Properties

NameTypeDescription
post?Step[]Additional steps to run after all of the stacks in the stage.
pre?Step[]Additional steps to run before any of the stacks in the stage.
stackSteps?StackSteps[]Instructions for additional steps that are run at the stack level.
stageName?stringStage name to use in the pipeline.

post?

Type: Step[] (optional, default: No additional steps)

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


pre?

Type: Step[] (optional, default: No additional steps)

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


stackSteps?

Type: StackSteps[] (optional, default: No additional instructions)

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


stageName?

Type: string (optional, default: Use Stage's construct ID)

Stage name to use in the pipeline.