Package software.amazon.awscdk.pipelines

Class CodePipeline

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.pipelines.PipelineBase
software.amazon.awscdk.pipelines.CodePipeline
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.109.0 (build c221850)", date="2025-03-14T03:25:07.306Z") @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: 

 Pipeline codePipeline;
 Artifact sourceArtifact = new Artifact("MySourceArtifact");
 CodePipeline pipeline = CodePipeline.Builder.create(this, "Pipeline")
         .codePipeline(codePipeline)
         .synth(ShellStep.Builder.create("Synth")
                 .input(CodePipelineFileSet.fromArtifact(sourceArtifact))
                 .commands(List.of("npm ci", "npm run build", "npx cdk synth"))
                 .build())
         .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.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.
    Boolean
    getSelfMutationEnabled()
    Whether SelfMutation is enabled for this CDK Pipeline.
    IProject
    getSelfMutationProject()
    The CodeBuild project that performs the SelfMutation.
    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, isPipeline

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, 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.

    • getSelfMutationEnabled

      @Stability(Stable) @NotNull public Boolean getSelfMutationEnabled()
      Whether SelfMutation is enabled for this CDK Pipeline.

    • getSelfMutationProject

      @Stability(Stable) @NotNull public IProject getSelfMutationProject()
      The CodeBuild project that performs the SelfMutation.

      Will throw an error if this is accessed before buildPipeline() is called, or if selfMutation has been disabled.

    • getSynthProject

      @Stability(Stable) @NotNull public IProject getSynthProject()
      The CodeBuild project that performs the Synth.

      Only available after the pipeline has been built.