Class ApplicationStage

Adaption of @aws-quickstart/eks-blueprints#ApplicationStage for integration with cdk-pipelines-github.

See

https://github.com/aws-quickstart/cdk-eks-blueprints/blob/main/lib/pipelines/code-pipeline.ts

Hierarchy

  • GitHubStage
    • ApplicationStage

Constructors

constructor

Properties

_assemblyBuilder account? asyncTask node parentStage? policyValidationBeta1 props? region? stageName

Accessors

artifactId assetOutdir outdir

Methods

synth toString waitForAsyncTasks isConstruct isStage of

Constructors

constructor

Properties

Readonly Internal _assemblyBuilder

_assemblyBuilder: CloudAssemblyBuilder

The cloud assembly builder that is being used for this App

Optional Readonly account

account?: string

The default account for all resources defined within this stage.

Private asyncTask

asyncTask: undefined | Promise<any> = undefined

Readonly node

node: Node

The tree node.

Optional Readonly parentStage

parentStage?: Stage

The parent stage or undefined if this is the app. *

Readonly policyValidationBeta1

policyValidationBeta1: IPolicyValidationPluginBeta1[]

Validation plugins to run during synthesis. If any plugin reports any violation, synthesis will be interrupted and the report displayed to the user.

Default

- no validation plugins are used

Optional Readonly props

props?: GitHubStageProps

Optional Readonly region

region?: string

The default region for all resources defined within this stage.

Readonly stageName

stageName: string

The name of the stage. Based on names of the parent stages separated by hypens.

Accessors

artifactId

  • get artifactId(): string

  • Artifact ID of the assembly if it is a nested stage. The root stage (app) will return an empty string.

    Derived from the construct path.

    Returns string

assetOutdir

  • get assetOutdir(): string

  • The cloud assembly asset output directory.

    Returns string

outdir

  • get outdir(): string

  • The cloud assembly output directory.

    Returns string

Methods

synth

  • Synthesize this stage into a cloud assembly.

    Once an assembly has been synthesized, it cannot be modified. Subsequent calls will return the same assembly.

    Parameters

    • Optional options: StageSynthesisOptions

    Returns CloudAssembly

toString

  • Returns a string representation of this construct.

    Returns string

waitForAsyncTasks

Static isConstruct

  • 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.

Static isStage

  • Test whether the given construct is a stage.

    Parameters

    • x: any

    Returns x is Stage

Static of

  • Return the stage this construct is contained with, if available. If called on a nested stage, returns its parent.

    Parameters

    • construct: IConstruct

    Returns undefined | Stage

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc