StageProps Struct
Construction properties of a Pipeline Stage.
Example
ts
// 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;
declare const rule: codepipeline.Rule;
const stageProps: codepipeline.StageProps = {
stageName: 'stageName',
// the properties below are optional
actions: [action],
beforeEntry: {
conditions: [{
result: codepipeline.Result.ROLLBACK,
rules: [rule],
}],
},
onFailure: {
conditions: [{
result: codepipeline.Result.ROLLBACK,
rules: [rule],
}],
result: codepipeline.Result.ROLLBACK,
retryMode: codepipeline.RetryMode.ALL_ACTIONS,
},
onSuccess: {
conditions: [{
result: codepipeline.Result.ROLLBACK,
rules: [rule],
}],
},
transitionDisabledReason: 'transitionDisabledReason',
transitionToEnabled: false,
};
Properties
actionsoptionalIAction[]actionsoptionaltyping.List[IAction]actionsoptionalList<IAction>ActionsoptionalIAction[]Actionsoptional*[]IAction#The list of Actions to create this Stage with.
You can always add more Actions later by calling IStage#addAction.
beforeEntryoptionalConditionsbefore_entryoptionalConditionsbeforeEntryoptionalConditionsBeforeEntryoptionalConditionsBeforeEntryoptionalConditions#The method to use when a stage allows entry.
Default: No conditions are applied before stage entry
onFailureoptionalFailureConditionson_failureoptionalFailureConditionsonFailureoptionalFailureConditionsOnFailureoptionalFailureConditionsOnFailureoptionalFailureConditions#The method to use when a stage has not completed successfully.
Default: No failure conditions are applied
onSuccessoptionalConditionson_successoptionalConditionsonSuccessoptionalConditionsOnSuccessoptionalConditionsOnSuccessoptionalConditions#The method to use when a stage has succeeded.
Default: No success conditions are applied
The physical, human-readable name to assign to this Pipeline Stage.
transitionDisabledReasonoptionalstringtransition_disabled_reasonoptionalstrtransitionDisabledReasonoptionalStringTransitionDisabledReasonoptionalstringTransitionDisabledReasonoptional*string#The reason for disabling transition to this stage.
Default: 'Transition disabled'
Only applicable if transitionToEnabled is set to false.
transitionToEnabledoptionalbooleantransition_to_enabledoptionalbooltransitionToEnabledoptionalBooleanTransitionToEnabledoptionalboolTransitionToEnabledoptional*bool= true#Whether to enable transition to this stage.