aws-cdk-lib.aws_codepipeline.StageProps

interface StageProps

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.StageProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#StageProps
Javasoftware.amazon.awscdk.services.codepipeline.StageProps
Pythonaws_cdk.aws_codepipeline.StageProps
TypeScript (source)aws-cdk-lib » aws_codepipeline » StageProps

Construction properties of a Pipeline Stage.

Example

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

declare const action: codepipeline.Action;
const stageProps: codepipeline.StageProps = {
  stageName: 'stageName',

  // the properties below are optional
  actions: [action],
  transitionDisabledReason: 'transitionDisabledReason',
  transitionToEnabled: false,
};

Properties

NameTypeDescription
stageNamestringThe physical, human-readable name to assign to this Pipeline Stage.
actions?IAction[]The list of Actions to create this Stage with.
transitionDisabledReason?stringThe reason for disabling transition to this stage.
transitionToEnabled?booleanWhether to enable transition to this stage.

stageName

Type: string

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


actions?

Type: IAction[] (optional)

The list of Actions to create this Stage with.

You can always add more Actions later by calling IStage#addAction.


transitionDisabledReason?

Type: string (optional, default: 'Transition disabled')

The reason for disabling transition to this stage.

Only applicable if transitionToEnabled is set to false.


transitionToEnabled?

Type: boolean (optional, default: true)

Whether to enable transition to this stage.