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

    Class StackOutput

    Declares a named output for a Stack.

    Stack outputs serve two purposes:

    1. They are written into the synthesized stack JSON under an "outputs" key, so the deployment engine can surface them after the stack is deployed.
    2. They are listed in manifest.json so the engine can discover cross-stack dependencies without reading each stack template.
    const server = new NtvHetznerServer(stack, 'Server', { ... });
    new StackOutput(stack, 'ServerId', {
      value: server.attrServerId,
      description: 'The Hetzner server ID',
    });

    Hierarchy

    • Construct
      • StackOutput
    Index

    Constructors

    constructor

    Properties

    description? node outputKey value

    Methods

    importValue toString with isConstruct isStackOutput

    Constructors

    Properties

    description?: string

    Optional description.

    node: Node

    The tree node.

    outputKey: string

    The export key — equal to the construct id.

    value: string | number | IResolvable

    The value to export. May be an IResolvable token.

    Methods

    • Returns an IResolvable token that can be used as a resource property in another stack. At deploy time the engine substitutes the token with the real runtime value of this output after the source stack has deployed.

      Using importValue() in a consuming stack automatically infers a stack-level dependency — no manual addDependency call is required.

      Returns IResolvable

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods