Class CdkStage
(deprecated) Stage in a CdkPipeline.
Inherited Members
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Pipelines.dll
Syntax (csharp)
public class CdkStage : Construct, IConstruct, IDependable
Syntax (vb)
Public Class CdkStage
Inherits Construct
Implements IConstruct, IDependable
Remarks
You don't need to instantiate this class directly. Use
cdkPipeline.addStage()
instead.
Stability: Deprecated
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodePipeline;
using Amazon.CDK.AWS.SNS;
using Amazon.CDK.Pipelines;
Artifact artifact;
IStage stage;
IStageHost stageHost;
Topic topic;
var cdkStage = new CdkStage(this, "MyCdkStage", new CdkStageProps {
CloudAssemblyArtifact = artifact,
Host = stageHost,
PipelineStage = stage,
StageName = "stageName",
// the properties below are optional
ConfirmBroadeningPermissions = false,
SecurityNotificationTopic = topic
});
Synopsis
Constructors
CdkStage(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CdkStage(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CdkStage(Construct, String, ICdkStageProps) |
Methods
AddActions(IAction[]) | (deprecated) Add one or more CodePipeline Actions. |
AddApplication(Stage, IAddStageOptions) | (deprecated) Add all stacks in the application Stage to this stage. |
AddManualApprovalAction(IAddManualApprovalOptions) | (deprecated) Add a manual approval action. |
AddStackArtifactDeployment(CloudFormationStackArtifact, IAddStackOptions) | (deprecated) Add a deployment action based on a stack artifact. |
DeploysStack(String) | (deprecated) Whether this Stage contains an action to deploy the given stack, identified by its artifact ID. |
NextSequentialRunOrder(Nullable<Double>) | (deprecated) Return the runOrder number necessary to run the next Action in sequence with the rest. |
Constructors
CdkStage(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CdkStage(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CdkStage(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CdkStage(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CdkStage(Construct, String, ICdkStageProps)
public CdkStage(Construct scope, string id, ICdkStageProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props ICdkStageProps
Remarks
Stability: Deprecated
Methods
AddActions(IAction[])
(deprecated) Add one or more CodePipeline Actions.
public virtual void AddActions(params IAction[] actions)
Parameters
- actions IAction[]
Remarks
You need to make sure it is created with the right runOrder. Call nextSequentialRunOrder()
for every action to get actions to execute in sequence.
Stability: Deprecated
AddApplication(Stage, IAddStageOptions)
(deprecated) Add all stacks in the application Stage to this stage.
public virtual void AddApplication(Stage appStage, IAddStageOptions options = null)
Parameters
- appStage Stage
- options IAddStageOptions
Remarks
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.
Stability: Deprecated
AddManualApprovalAction(IAddManualApprovalOptions)
(deprecated) Add a manual approval action.
public virtual void AddManualApprovalAction(IAddManualApprovalOptions options = null)
Parameters
- options IAddManualApprovalOptions
Remarks
If you need more flexibility than what this method offers,
use addAction
with a ManualApprovalAction
.
Stability: Deprecated
AddStackArtifactDeployment(CloudFormationStackArtifact, IAddStackOptions)
(deprecated) Add a deployment action based on a stack artifact.
public virtual void AddStackArtifactDeployment(CloudFormationStackArtifact stackArtifact, IAddStackOptions options = null)
Parameters
- stackArtifact CloudFormationStackArtifact
- options IAddStackOptions
Remarks
Stability: Deprecated
DeploysStack(String)
(deprecated) Whether this Stage contains an action to deploy the given stack, identified by its artifact ID.
public virtual bool DeploysStack(string artifactId)
Parameters
- artifactId System.String
Returns
System.Boolean
Remarks
Stability: Deprecated
NextSequentialRunOrder(Nullable<Double>)
(deprecated) Return the runOrder number necessary to run the next Action in sequence with the rest.
public virtual double NextSequentialRunOrder(Nullable<double> count = null)
Parameters
- count System.Nullable<System.Double>
Returns
System.Double
Remarks
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.
Stability: Deprecated