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

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:30:29.080Z")
 @Stability(value=Experimental)
public class CdkPipeline
extends Construct

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CdkPipeline.Builder (experimental) A fluent builder for CdkPipeline.

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

Method Summary

Modifier and Type	Method and Description
CdkStage	addApplicationStage(Stage appStage) (experimental) Add pipeline stage that will deploy the given application stage.
CdkStage	addApplicationStage(Stage appStage, AddStageOptions options) (experimental) Add pipeline stage that will deploy the given application stage.
CdkStage	addStage(String stageName) (experimental) Add a new, empty stage to the pipeline.
Pipeline	getCodePipeline() (experimental) The underlying CodePipeline object.
StackOutput	stackOutput(CfnOutput cfnOutput) (experimental) Get the StackOutput object that holds this CfnOutput's value in this pipeline.
IStage	stage(String stageName) (experimental) Access one of the pipeline's stages by stage name.
protected List<String>	validate() (experimental) Validate that we don't have any stacks violating dependency order in the pipeline.

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)

CdkPipeline

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

CdkPipeline

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addApplicationStage

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

(experimental) 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=Experimental)
 @NotNull
public CdkStage addApplicationStage(@NotNull
                                                                             Stage appStage)

(experimental) 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=Experimental)
 @NotNull
public CdkStage addStage(@NotNull
                                                                  String stageName)

(experimental) 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=Experimental)
 @NotNull
public StackOutput stackOutput(@NotNull
                                                                        CfnOutput cfnOutput)

(experimental) 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=Experimental)
 @NotNull
public IStage stage(@NotNull
                                                             String stageName)

(experimental) 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=Experimental)
 @NotNull
protected List<String> validate()

(experimental) 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=Experimental)
 @NotNull
public Pipeline getCodePipeline()

(experimental) The underlying CodePipeline object.

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