software.amazon.awscdk.pipelines

Class CdkPipeline

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.pipelines.CdkPipeline

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.58.0 (build f8ba112)",
           date="2022-05-11T19:24:39.779Z")
 @Stability(value=Deprecated)
 @Deprecated
public class CdkPipeline
extends Construct

(deprecated) A Pipeline to deploy CDK apps.

Defines an AWS CodePipeline-based Pipeline to deploy CDK applications.

Automatically manages the following:

• Stack dependency order.
• Asset publishing.
• Keeping the pipeline up-to-date as the CDK apps change.
• Using stack outputs later on in the pipeline.

Example:

 Artifact sourceArtifact = new Artifact();
 Artifact cloudAssemblyArtifact = new Artifact();
 CdkPipeline pipeline = CdkPipeline.Builder.create(this, "MyPipeline")
         .cloudAssemblyArtifact(cloudAssemblyArtifact)
         .synthAction(SimpleSynthAction.standardNpmSynth(StandardNpmSynthOptions.builder()
                 .sourceArtifact(sourceArtifact)
                 .cloudAssemblyArtifact(cloudAssemblyArtifact)
                 .environment(BuildEnvironment.builder()
                         .privileged(true)
                         .build())
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CdkPipeline.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
	CdkPipeline(software.constructs.Construct scope, String id, CdkPipelineProps props) Deprecated.
protected	CdkPipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) Deprecated.
protected	CdkPipeline(software.amazon.jsii.JsiiObjectRef objRef) Deprecated.

Method Summary

Modifier and Type	Method and Description
CdkStage	addApplicationStage(Stage appStage) Deprecated.
CdkStage	addApplicationStage(Stage appStage, AddStageOptions options) Deprecated.
CdkStage	addStage(String stageName) Deprecated.
CdkStage	addStage(String stageName, BaseStageOptions options) Deprecated.
Pipeline	getCodePipeline() Deprecated.
StackOutput	stackOutput(CfnOutput cfnOutput) Deprecated.
IStage	stage(String stageName) Deprecated.
protected List<String>	validate() Deprecated.

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

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

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

CdkPipeline

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

Deprecated.

CdkPipeline

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

Deprecated.

CdkPipeline

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

Deprecated.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addApplicationStage

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public CdkStage addApplicationStage(@NotNull
                                                                                        Stage appStage,
                                                                                        @Nullable
                                                                                        AddStageOptions options)

Deprecated.

(deprecated) Add pipeline stage that will deploy the given application 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 -

addApplicationStage

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public CdkStage addApplicationStage(@NotNull
                                                                                        Stage appStage)

Deprecated.

(deprecated) Add pipeline stage that will deploy the given application 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.

addStage

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public CdkStage addStage(@NotNull
                                                                             String stageName,
                                                                             @Nullable
                                                                             BaseStageOptions options)

Deprecated.

(deprecated) Add a new, empty stage to the pipeline.

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.

Parameters:

stageName - This parameter is required.

options -

addStage

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public CdkStage addStage(@NotNull
                                                                             String stageName)

Deprecated.

(deprecated) Add a new, empty stage to the pipeline.

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.

Parameters:

stageName - This parameter is required.

stackOutput

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public StackOutput stackOutput(@NotNull
                                                                                   CfnOutput cfnOutput)

Deprecated.

(deprecated) Get the StackOutput object that holds this CfnOutput's value in this pipeline.

StackOutput can be used in validation actions later in the pipeline.

Parameters:

cfnOutput - This parameter is required.

stage

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public IStage stage(@NotNull
                                                                        String stageName)

Deprecated.

(deprecated) Access one of the pipeline's stages by stage name.

You can use this to add more Actions to a stage.

Parameters:

stageName - This parameter is required.

validate

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
protected List<String> validate()

Deprecated.

(deprecated) Validate that we don't have any stacks violating dependency order in the pipeline.

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.

Overrides:

validate in class Construct

Returns:

An array of validation error messages, or an empty array if the construct is valid.

getCodePipeline

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Pipeline getCodePipeline()

Deprecated.

(deprecated) The underlying CodePipeline object.

You can use this to add more Stages to the pipeline, or Actions to Stages.