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

Deprecated.

This class is part of the old API. Use the API based on the `CodePipeline` class instead

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:58.502Z")
 @Stability(value=Deprecated)
 @Deprecated
public class CdkStage
extends Construct

(deprecated) Stage in a CdkPipeline.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.*;
 import software.amazon.awscdk.services.sns.*;
 import software.amazon.awscdk.pipelines.*;
 Artifact artifact;
 IStage stage;
 IStageHost stageHost;
 Topic topic;
 CdkStage cdkStage = CdkStage.Builder.create(this, "MyCdkStage")
         .cloudAssemblyArtifact(artifact)
         .host(stageHost)
         .pipelineStage(stage)
         .stageName("stageName")
         // the properties below are optional
         .confirmBroadeningPermissions(false)
         .securityNotificationTopic(topic)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CdkStage.Builder Deprecated.

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) Deprecated.
protected	CdkStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) Deprecated.
protected	CdkStage(software.amazon.jsii.JsiiObjectRef objRef) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addActions(IAction... actions) Deprecated.
void	addApplication(Stage appStage) Deprecated.
void	addApplication(Stage appStage, AddStageOptions options) Deprecated.
void	addManualApprovalAction() Deprecated.
void	addManualApprovalAction(AddManualApprovalOptions options) Deprecated.
void	addStackArtifactDeployment(CloudFormationStackArtifact stackArtifact) Deprecated.
void	addStackArtifactDeployment(CloudFormationStackArtifact stackArtifact, AddStackOptions options) Deprecated.
Boolean	deploysStack(String artifactId) Deprecated.
Number	nextSequentialRunOrder() Deprecated.
Number	nextSequentialRunOrder(Number count) Deprecated.

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)

Deprecated.

CdkStage

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

Deprecated.

CdkStage

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

Deprecated.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addActions

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

Deprecated.

(deprecated) 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=Deprecated)
 @Deprecated
public void addApplication(@NotNull
                                                                     Stage appStage,
                                                                     @Nullable
                                                                     AddStageOptions options)

Deprecated.

(deprecated) 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=Deprecated)
 @Deprecated
public void addApplication(@NotNull
                                                                     Stage appStage)

Deprecated.

(deprecated) 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=Deprecated)
 @Deprecated
public void addManualApprovalAction(@Nullable
                                                                              AddManualApprovalOptions options)

Deprecated.

(deprecated) 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=Deprecated)
 @Deprecated
public void addManualApprovalAction()

Deprecated.

(deprecated) Add a manual approval action.

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

addStackArtifactDeployment

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

Deprecated.

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

Parameters:

stackArtifact - This parameter is required.

options -

addStackArtifactDeployment

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

Deprecated.

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

Parameters:

stackArtifact - This parameter is required.

deploysStack

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

Deprecated.

(deprecated) 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=Deprecated)
 @Deprecated
 @NotNull
public Number nextSequentialRunOrder(@Nullable
                                                                                         Number count)

Deprecated.

(deprecated) 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=Deprecated)
 @Deprecated
 @NotNull
public Number nextSequentialRunOrder()

Deprecated.

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