software.amazon.awscdk.pipelines

Class CdkStage

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.pipelines.CdkStage

All Implemented Interfaces:

IDependable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:30:29.081Z")
 @Stability(value=Experimental)
public class CdkStage
extends Construct

(experimental) Stage in a CdkPipeline.

You don't need to instantiate this class directly. Use cdkPipeline.addStage() instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CdkStage.Builder (experimental) A fluent builder for CdkStage.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	CdkStage(software.constructs.Construct scope, String id, CdkStageProps props)
protected	CdkStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CdkStage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addActions(IAction... actions) (experimental) Add one or more CodePipeline Actions.
void	addApplication(Stage appStage) (experimental) Add all stacks in the application Stage to this stage.
void	addApplication(Stage appStage, AddStageOptions options) (experimental) Add all stacks in the application Stage to this stage.
void	addManualApprovalAction() (experimental) Add a manual approval action.
void	addManualApprovalAction(AddManualApprovalOptions options) (experimental) Add a manual approval action.
void	addStackArtifactDeployment(CloudFormationStackArtifact stackArtifact) (experimental) Add a deployment action based on a stack artifact.
void	addStackArtifactDeployment(CloudFormationStackArtifact stackArtifact, AddStackOptions options) (experimental) Add a deployment action based on a stack artifact.
Boolean	deploysStack(String artifactId) (experimental) Whether this Stage contains an action to deploy the given stack, identified by its artifact ID.
Number	nextSequentialRunOrder() (experimental) Return the runOrder number necessary to run the next Action in sequence with the rest.
Number	nextSequentialRunOrder(Number count) (experimental) Return the runOrder number necessary to run the next Action in sequence with the rest.

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CdkStage

protected CdkStage(software.amazon.jsii.JsiiObjectRef objRef)

CdkStage

protected CdkStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CdkStage

@Stability(value=Experimental)
public CdkStage(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CdkStageProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addActions

@Stability(value=Experimental)
public void addActions(@NotNull
                                                      IAction... actions)

(experimental) Add one or more CodePipeline Actions.

You need to make sure it is created with the right runOrder. Call nextSequentialRunOrder() for every action to get actions to execute in sequence.

Parameters:

actions - This parameter is required.

addApplication

@Stability(value=Experimental)
public void addApplication(@NotNull
                                                          Stage appStage,
                                                          @Nullable
                                                          AddStageOptions options)

(experimental) Add all stacks in the application Stage to this stage.

The application construct should subclass Stage and can contain any number of 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.

Parameters:

appStage - This parameter is required.

options -

addApplication

@Stability(value=Experimental)
public void addApplication(@NotNull
                                                          Stage appStage)

(experimental) Add all stacks in the application Stage to this stage.

The application construct should subclass Stage and can contain any number of 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.

Parameters:

appStage - This parameter is required.

addManualApprovalAction

@Stability(value=Experimental)
public void addManualApprovalAction(@Nullable
                                                                   AddManualApprovalOptions options)

(experimental) Add a manual approval action.

If you need more flexibility than what this method offers, use addAction with a ManualApprovalAction.

Parameters:

options -

addManualApprovalAction

@Stability(value=Experimental)
public void addManualApprovalAction()

(experimental) Add a manual approval action.

If you need more flexibility than what this method offers, use addAction with a ManualApprovalAction.

addStackArtifactDeployment

@Stability(value=Experimental)
public void addStackArtifactDeployment(@NotNull
                                                                      CloudFormationStackArtifact stackArtifact,
                                                                      @Nullable
                                                                      AddStackOptions options)

(experimental) Add a deployment action based on a stack artifact.

Parameters:

stackArtifact - This parameter is required.

options -

addStackArtifactDeployment

@Stability(value=Experimental)
public void addStackArtifactDeployment(@NotNull
                                                                      CloudFormationStackArtifact stackArtifact)

(experimental) Add a deployment action based on a stack artifact.

Parameters:

stackArtifact - This parameter is required.

deploysStack

@Stability(value=Experimental)
 @NotNull
public Boolean deploysStack(@NotNull
                                                                     String artifactId)

(experimental) Whether this Stage contains an action to deploy the given stack, identified by its artifact ID.

Parameters:

artifactId - This parameter is required.

nextSequentialRunOrder

@Stability(value=Experimental)
 @NotNull
public Number nextSequentialRunOrder(@Nullable
                                                                              Number count)

(experimental) 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.

Parameters:

count -

nextSequentialRunOrder

@Stability(value=Experimental)
 @NotNull
public Number nextSequentialRunOrder()

(experimental) 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.