Package software.amazon.awscdk.pipelines

Class CodePipeline

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.pipelines.PipelineBase

software.amazon.awscdk.pipelines.CodePipeline

All Implemented Interfaces:

IConstruct, IDependable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.793Z")
@Stability(Stable)
public class CodePipeline
extends PipelineBase

A CDK Pipeline that uses CodePipeline to deploy CDK apps.

This is a Pipeline with its engine property set to CodePipelineEngine, and exists for nicer ergonomics for users that don't need to switch out engines.

Example:

 // Modern API
 CodePipeline modernPipeline = CodePipeline.Builder.create(this, "Pipeline")
         .selfMutation(false)
         .synth(ShellStep.Builder.create("Synth")
                 .input(CodePipelineSource.connection("my-org/my-app", "main", ConnectionSourceOptions.builder()
                         .connectionArn("arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41")
                         .build()))
                 .commands(List.of("npm ci", "npm run build", "npx cdk synth"))
                 .build())
         .build();
 // Original API
 Artifact cloudAssemblyArtifact = new Artifact();
 CdkPipeline originalPipeline = CdkPipeline.Builder.create(this, "Pipeline")
         .selfMutating(false)
         .cloudAssemblyArtifact(cloudAssemblyArtifact)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CodePipeline.Builder	A fluent builder for CodePipeline.

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

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CodePipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CodePipeline(software.amazon.jsii.JsiiObjectRef objRef)
	CodePipeline(software.constructs.Construct scope, String id, CodePipelineProps props)

Method Summary

Modifier and Type	Method	Description
protected void	doBuildPipeline()	Implemented by subclasses to do the actual pipeline construction.
Pipeline	getPipeline()	The CodePipeline pipeline that deploys the CDK app.
IProject	getSynthProject()	The CodeBuild project that performs the Synth.

Methods inherited from class software.amazon.awscdk.pipelines.PipelineBase

addStage, addStage, addWave, addWave, buildPipeline, getCloudAssemblyFileSet, getSynth, getWaves

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

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

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 Details

CodePipeline

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

CodePipeline

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

CodePipeline

@Stability(Stable)
public CodePipeline(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CodePipelineProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

doBuildPipeline

@Stability(Stable)
protected void doBuildPipeline()

Implemented by subclasses to do the actual pipeline construction.

Specified by:

doBuildPipeline in class PipelineBase

getPipeline

@Stability(Stable)
@NotNull
public Pipeline getPipeline()

The CodePipeline pipeline that deploys the CDK app.

Only available after the pipeline has been built.

getSynthProject

@Stability(Stable)
@NotNull
public IProject getSynthProject()

The CodeBuild project that performs the Synth.

Only available after the pipeline has been built.