Method addMetadata

src/construct.ts:303–321

* Adds a metadata entry to this construct. * Entries are arbitrary values and will also include a stack trace to allow tracing back to * the code location for when the entry was added. It can be used, for example, to include source * mapping in CloudFormation templates to improve diagnostic

(type: string, data: any, options: MetadataOptions = { })

   * @param options options
   */
  public addMetadata(type: string, data: any, options: MetadataOptions = { }): void {
    if (data == null) {
      return;
    }

    const node = this;
    function getTrace() {
      if (options.stackTraceOverride && options.stackTraceOverride.length > 0) {
        return options.stackTraceOverride;
      }
      const shouldTrace = options.stackTrace ?? false;
      return shouldTrace ? captureStackTrace(options.traceFromFunction ?? node.addMetadata) : undefined;
    }

    if (!this._metadata) {
      this._metadata = [];
    }
    this._metadata.push({ type, data, trace: getTrace() });
  }

  /**
   * All parent scopes of this construct.