Package software.aws.awsprototypingsdk.pipeline

Class PDKPipeline

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-01T23:43:16.111Z")
@Stability(Stable)
public class PDKPipeline
extends software.amazon.awscdk.pipelines.CodePipeline
    An extension to CodePipeline which configures sane defaults for a NX Monorepo codebase.

    In addition to this, it also creates a CodeCommit repository with automated PR builds and approvals.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PDKPipeline.Builder
      A fluent builder for PDKPipeline.

      • 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 PDKPipeline​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)  
      protected PDKPipeline​(software.amazon.jsii.JsiiObjectRef objRef)  
        PDKPipeline​(software.constructs.Construct scope, String id, PDKPipelineProps props)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      software.amazon.awscdk.pipelines.StageDeployment addStage​(software.amazon.awscdk.Stage stage)
      Deploy a single Stage by itself.
      software.amazon.awscdk.pipelines.StageDeployment addStage​(software.amazon.awscdk.Stage stage, software.amazon.awscdk.pipelines.AddStageOpts options)
      Deploy a single Stage by itself.
      void buildPipeline()
      Send the current pipeline definition to the engine, and construct the pipeline.
      software.amazon.awscdk.services.codecommit.Repository getCodeRepository()  
      void suppressCDKViolations()  

      • Methods inherited from class software.amazon.awscdk.pipelines.CodePipeline

        doBuildPipeline, getPipeline, getSynthProject

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

        addWave, addWave, 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 interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Constructor Detail

      • PDKPipeline

        protected PDKPipeline​(software.amazon.jsii.JsiiObjectRef objRef)

      • PDKPipeline

        protected PDKPipeline​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • PDKPipeline

        @Stability(Stable)
public PDKPipeline​(@NotNull
                   software.constructs.Construct scope,
                   @NotNull
                   String id,
                   @NotNull
                   PDKPipelineProps props)
        Parameters:
        scope - This parameter is required.
        id - This parameter is required.
        props - This parameter is required.

    • Method Detail

      • addStage

        @Stability(Stable)
@NotNull
public software.amazon.awscdk.pipelines.StageDeployment addStage​(@NotNull
                                                                 software.amazon.awscdk.Stage stage,
                                                                 @Nullable
                                                                 software.amazon.awscdk.pipelines.AddStageOpts options)
        Deploy a single Stage by itself.

        Add a Stage to the pipeline, to be deployed in sequence with other Stages added to the pipeline. All Stacks in the stage will be deployed in an order automatically determined by their relative dependencies.

        Overrides:
        addStage in class software.amazon.awscdk.pipelines.PipelineBase
        Parameters:
        stage - This parameter is required.
        options -

      • addStage

        @Stability(Stable)
@NotNull
public software.amazon.awscdk.pipelines.StageDeployment addStage​(@NotNull
                                                                 software.amazon.awscdk.Stage stage)
        Deploy a single Stage by itself.

        Add a Stage to the pipeline, to be deployed in sequence with other Stages added to the pipeline. All Stacks in the stage will be deployed in an order automatically determined by their relative dependencies.

        Overrides:
        addStage in class software.amazon.awscdk.pipelines.PipelineBase
        Parameters:
        stage - This parameter is required.

      • buildPipeline

        @Stability(Stable)
public void buildPipeline()
        Send the current pipeline definition to the engine, and construct the pipeline.

        It is not possible to modify the pipeline after calling this method.

        Overrides:
        buildPipeline in class software.amazon.awscdk.pipelines.PipelineBase

      • suppressCDKViolations

        @Stability(Stable)
public void suppressCDKViolations()

      • getCodeRepository

        @Stability(Stable)
@NotNull
public software.amazon.awscdk.services.codecommit.Repository getCodeRepository()