Package io.github.cdklabs.cdkpipelines.github

Class GitHubWorkflow

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.62.0 (build 293ac17)",
           date="2022-07-16T00:20:23.455Z")
@Stability(Stable)
public class GitHubWorkflow
extends software.amazon.awscdk.pipelines.PipelineBase
    CDK Pipelines for GitHub workflows.

    • Nested Class Summary

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

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      software.amazon.awscdk.pipelines.StageDeployment addStageWithGitHubOptions​(software.amazon.awscdk.Stage stage)
      Deploy a single Stage by itself with options for further GitHub configuration.
      software.amazon.awscdk.pipelines.StageDeployment addStageWithGitHubOptions​(software.amazon.awscdk.Stage stage, AddGitHubStageOptions options)
      Deploy a single Stage by itself with options for further GitHub configuration.
      protected void doBuildPipeline()
      Implemented by subclasses to do the actual pipeline construction.
      String getWorkflowName()  
      String getWorkflowPath()  

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

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

      • 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

      • GitHubWorkflow

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

      • GitHubWorkflow

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

      • GitHubWorkflow

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

    • Method Detail

      • addStageWithGitHubOptions

        @Stability(Stable)
@NotNull
public software.amazon.awscdk.pipelines.StageDeployment addStageWithGitHubOptions​(@NotNull
                                                                                  software.amazon.awscdk.Stage stage,
                                                                                  @Nullable
                                                                                  AddGitHubStageOptions options)
        Deploy a single Stage by itself with options for further GitHub configuration.

        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.

        Parameters:
        stage - This parameter is required.
        options -

      • addStageWithGitHubOptions

        @Stability(Stable)
@NotNull
public software.amazon.awscdk.pipelines.StageDeployment addStageWithGitHubOptions​(@NotNull
                                                                                  software.amazon.awscdk.Stage stage)
        Deploy a single Stage by itself with options for further GitHub configuration.

        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.

        Parameters:
        stage - This parameter is required.

      • doBuildPipeline

        @Stability(Stable)
protected void doBuildPipeline()
        Implemented by subclasses to do the actual pipeline construction.
        Specified by:
        doBuildPipeline in class software.amazon.awscdk.pipelines.PipelineBase

      • getWorkflowName

        @Stability(Stable)
@NotNull
public String getWorkflowName()

      • getWorkflowPath

        @Stability(Stable)
@NotNull
public String getWorkflowPath()