@cdk-x/core
    Preparing search index...

    Class App

    The root of the cdkx construct tree and the entry point for synthesis.

    App owns the resolver pipeline factory (one pipeline per provider, built lazily) and orchestrates the synthesis of all child Stack instances.

    const app = new App({ outdir: 'cdkx.out' });

    new Stack(app, 'k8s-stack', { provider: new KubernetesProvider({ ... }) });
    new Stack(app, 'hetzner-stack', { provider: new HetznerProvider({ ... }) });

    app.synth();
    // Produces:
    //   cdkx.out/manifest.json
    //   cdkx.out/k8s-stack.yaml
    //   cdkx.out/hetzner-stack.json

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    node outdir

    Methods

    getResolverPipeline synth toString with isApp isConstruct of

    Constructors

    Properties

    node: Node

    The tree node.

    outdir: string

    Absolute path to the output directory.

    Methods

    • Returns the resolver pipeline for a given provider.

      The pipeline is built once per provider and cached for reuse. It consists of:

      1. Global custom resolvers (from AppProps.resolvers)
      2. Provider-specific resolvers (from Provider.getResolvers())
      3. Built-in LazyResolver
      4. Built-in ImplicitTokenResolver

      This means a @cdk-x/github-actions provider can register a resolver that turns SecretRef tokens into ${{ secrets.NAME }} strings, while a @cdk-x/kubernetes provider resolves the same token to { secretKeyRef: { name, key } }.

      Parameters

      Returns ResolverPipeline

    • Synthesizes the entire construct tree.

      Traverses all Stack children in construct tree order and calls stack.synthesizer.synthesize(session) on each. Finally writes manifest.json and returns the sealed CloudAssembly.

      Returns CloudAssembly

      The immutable CloudAssembly describing the synthesis output.

    • Returns a string representation of this construct.

      Returns string

    • Applies one or more mixins to this construct.

      Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

      Parameters

      • ...mixins: IMixin[]

        The mixins to apply

      Returns IConstruct

      This construct for chaining

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

    • Finds the root App of the construct tree containing the given construct. Throws if no App is found (i.e. the construct is not rooted in an App).

      Parameters

      • construct: IConstruct

      Returns App

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods