Class GithubWorkflowPipeline

ReadonlycloudAssemblyFileSet

Readonlynode

Readonlysynth

Readonlywaves

ReadonlyworkflowFile

ReadonlyworkflowName

ReadonlyworkflowPath

_addStageFromWave

• _addStageFromWave(
      stage: Stage,
      stageDeployment: StageDeployment,
      options?: AddGitHubStageOptions,
  ): void
  Internal

  Support adding stages with GitHub options to waves - should ONLY be called internally.

  Use pipeline.addWave() and it'll call this when wave.addStage() is called.

  pipeline.addStage() will also call this, since it calls pipeline.addWave().addStage().

  Parameters

  • stage: Stage
  • stageDeployment: StageDeployment
  • Optionaloptions: AddGitHubStageOptions

  Returns void

addGitHubWave

• addGitHubWave(id: string, options?: WaveOptions): GitHubWave

  Parameters

  • id: string
  • Optionaloptions: WaveOptions

  Returns GitHubWave

addWave

• addWave(id: string, options?: WaveOptions): Wave

  Add a Wave to the pipeline, for deploying multiple Stages in parallel

  Use the return object of this method to deploy multiple stages in parallel.

  Example:

  declare const pipeline: GitHubWorkflow; // assign pipeline a value
  
  const wave = pipeline.addWave('MyWave');
  wave.addStage(new MyStage(this, 'Stage1'));
  wave.addStage(new MyStage(this, 'Stage2'));
  Copy

  Parameters

  • id: string
  • Optionaloptions: WaveOptions

  Returns Wave

buildPipeline

• buildPipeline(): void

  Send the current pipeline definition to the engine, and construct the pipeline

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

  Returns void

toString

• toString(): string

  Returns a string representation of this construct.

  Returns string

StaticisConstruct

• isConstruct(x: any): x is Construct

  Checks if x is a construct.

  Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

  Parameters

  • x: any

    Any object

  Returns x is Construct

  true if x is an object created from a class which extends Construct.

StaticisPipeline

• isPipeline(x: any): x is PipelineBase

  Return whether the given object extends PipelineBase.

  We do attribute detection since we can't reliably use 'instanceof'.

  Parameters

  • x: any

  Returns x is PipelineBase