Class CdkPipeline
(deprecated) A Pipeline to deploy CDK apps.
Inherited Members
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Pipelines.dll
Syntax (csharp)
public class CdkPipeline : Construct, IConstruct, IDependable
Syntax (vb)
Public Class CdkPipeline
Inherits Construct
Implements IConstruct, IDependable
Remarks
Defines an AWS CodePipeline-based Pipeline to deploy CDK applications.
Automatically manages the following:
Stability: Deprecated
ExampleMetadata: infused
Examples
var sourceArtifact = new Artifact();
var cloudAssemblyArtifact = new Artifact();
var pipeline = new CdkPipeline(this, "MyPipeline", new CdkPipelineProps {
CloudAssemblyArtifact = cloudAssemblyArtifact,
SynthAction = SimpleSynthAction.StandardNpmSynth(new StandardNpmSynthOptions {
SourceArtifact = sourceArtifact,
CloudAssemblyArtifact = cloudAssemblyArtifact,
Environment = new BuildEnvironment {
Privileged = true
}
})
});
Synopsis
Constructors
CdkPipeline(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CdkPipeline(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CdkPipeline(Construct, String, ICdkPipelineProps) |
Properties
CodePipeline | (deprecated) The underlying CodePipeline object. |
Methods
AddApplicationStage(Stage, IAddStageOptions) | (deprecated) Add pipeline stage that will deploy the given application stage. |
AddStage(String, IBaseStageOptions) | (deprecated) Add a new, empty stage to the pipeline. |
StackOutput(CfnOutput) | (deprecated) Get the StackOutput object that holds this CfnOutput's value in this pipeline. |
Stage(String) | (deprecated) Access one of the pipeline's stages by stage name. |
Validate() | (deprecated) Validate that we don't have any stacks violating dependency order in the pipeline. |
Constructors
CdkPipeline(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CdkPipeline(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CdkPipeline(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CdkPipeline(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CdkPipeline(Construct, String, ICdkPipelineProps)
public CdkPipeline(Construct scope, string id, ICdkPipelineProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props ICdkPipelineProps
Remarks
Stability: Deprecated
Properties
CodePipeline
(deprecated) The underlying CodePipeline object.
public virtual Pipeline CodePipeline { get; }
Property Value
Remarks
You can use this to add more Stages to the pipeline, or Actions to Stages.
Stability: Deprecated
Methods
AddApplicationStage(Stage, IAddStageOptions)
(deprecated) Add pipeline stage that will deploy the given application stage.
public virtual CdkStage AddApplicationStage(Stage appStage, IAddStageOptions options = null)
Parameters
- appStage Stage
- options IAddStageOptions
Returns
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
AddStage(String, IBaseStageOptions)
(deprecated) Add a new, empty stage to the pipeline.
public virtual CdkStage AddStage(string stageName, IBaseStageOptions options = null)
Parameters
- stageName System.String
- options IBaseStageOptions
Returns
Remarks
Prefer to use addApplicationStage
if you are intended to deploy a CDK
application, but you can use this method if you want to add other kinds of
Actions to a pipeline.
Stability: Deprecated
StackOutput(CfnOutput)
(deprecated) Get the StackOutput object that holds this CfnOutput's value in this pipeline.
public virtual StackOutput StackOutput(CfnOutput cfnOutput)
Parameters
- cfnOutput CfnOutput
Returns
Remarks
StackOutput
can be used in validation actions later in the pipeline.
Stability: Deprecated
Stage(String)
(deprecated) Access one of the pipeline's stages by stage name.
public virtual IStage Stage(string stageName)
Parameters
- stageName System.String
Returns
Remarks
You can use this to add more Actions to a stage.
Stability: Deprecated
Validate()
(deprecated) Validate that we don't have any stacks violating dependency order in the pipeline.
protected override string[] Validate()
Returns
System.String[]
Overrides
Remarks
Our own convenience methods will never generate a pipeline that does that (although this is a nice verification), but a user can also add the stacks by hand.
Stability: Deprecated