class CdkStage (construct)
Stage in a CdkPipeline.
You don't need to instantiate this class directly. Use
new CdkStage(scope: Construct, id: string, props: CdkStageProps)
|cloud||The CodePipeline Artifact with the Cloud Assembly.|
|host||Features the Stage needs from its environment.|
|pipeline||The underlying Pipeline Stage associated with thisCdkStage.|
|stage||Name of the stage that should be created.|
The CodePipeline Artifact with the Cloud Assembly.
Features the Stage needs from its environment.
The underlying Pipeline Stage associated with thisCdkStage.
Name of the stage that should be created.
|node||The construct tree node associated with this construct.|
The construct tree node associated with this construct.
|add||Add one or more CodePipeline Actions.|
|add||Add all stacks in the application Stage to this stage.|
|add||Add a manual approval action.|
|add||Add a deployment action based on a stack artifact.|
|deploys||Whether this Stage contains an action to deploy the given stack, identified by its artifact ID.|
|next||Return the runOrder number necessary to run the next Action in sequence with the rest.|
|to||Returns a string representation of this construct.|
public addActions(...actions: IAction): void
Add one or more CodePipeline Actions.
You need to make sure it is created with the right runOrder. Call
for every action to get actions to execute in sequence.
public addApplication(appStage: Stage, options?: AddStageOptions): void
Add all stacks in the application Stage to this stage.
The application construct should subclass
Stage and can contain any
Stacks inside it that may have dependency relationships
on one another.
All stacks in the application will be deployed in the appropriate order, and all assets found in the application will be added to the asset publishing stage.
Manual Approval Action(options?)
public addManualApprovalAction(options?: AddManualApprovalOptions): void
Manual Approval Options
Add a manual approval action.
If you need more flexibility than what this method offers,
addAction with a
Stack Artifact Deployment(stackArtifact, options?)
public addStackArtifactDeployment(stackArtifact: CloudFormationStackArtifact, options?: AddStackOptions): void
Add a deployment action based on a stack artifact.
public deploysStack(artifactId: string): boolean
Whether this Stage contains an action to deploy the given stack, identified by its artifact ID.
Sequential Run Order(count?)
public nextSequentialRunOrder(count?: number): number
Return the runOrder number necessary to run the next Action in sequence with the rest.
FIXME: This is here because Actions are immutable and can't be reordered after creation, nor is there a way to specify relative priorities, which is a limitation that we should take away in the base library.
public toString(): string
Returns a string representation of this construct.