software.amazon.awscdk.pipelines

Class CdkStage

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.pipelines.CdkStage

All Implemented Interfaces:

IConstruct, IDependable

Deprecated.

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.758Z")
 @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 interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CdkStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) Deprecated.
protected	CdkStage(software.amazon.jsii.JsiiObjectRef objRef) Deprecated.
	CdkStage(software.constructs.Construct scope, java.lang.String id, CdkStageProps props) 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.
java.lang.Boolean	deploysStack(java.lang.String artifactId) Deprecated.
java.lang.Number	nextSequentialRunOrder() Deprecated.
java.lang.Number	nextSequentialRunOrder(java.lang.Number count) Deprecated.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CdkStage

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

Deprecated.

CdkStage

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

Deprecated.

CdkStage

@Deprecated
public CdkStage(software.constructs.Construct scope,
                            java.lang.String id,
                            CdkStageProps props)

Deprecated.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addActions

@Deprecated
public void addActions(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

@Deprecated
public void addApplication(Stage appStage,
                                       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

@Deprecated
public void addApplication(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

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

@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

@Deprecated
public void addStackArtifactDeployment(CloudFormationStackArtifact stackArtifact,
                                                   AddStackOptions options)

Deprecated.

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

Parameters:

stackArtifact - This parameter is required.

options -

addStackArtifactDeployment

@Deprecated
public void addStackArtifactDeployment(CloudFormationStackArtifact stackArtifact)

Deprecated.

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

Parameters:

stackArtifact - This parameter is required.

deploysStack

@Deprecated
public java.lang.Boolean deploysStack(java.lang.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

@Deprecated
public java.lang.Number nextSequentialRunOrder(java.lang.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

@Deprecated
public java.lang.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.