@pulumi/pulumi 3.124.0 → 3.124.1-alpha.x26ff819

package/asset/archive.d.ts

@@ -1,22 +1,24 @@
 import { Asset } from "./asset";
 /**
- * An Archive represents a collection of named assets.
+ * An {@link Archive} represents a collection of named assets.
  */
 export declare abstract class Archive {
     /**
-     * Returns true if the given object is an instance of an Archive.  This is designed to work even when
-     * multiple copies of the Pulumi SDK have been loaded into the same process.
+     * Returns true if the given object is an {@link Archive}. This is designed
+     * to work even when multiple copies of the Pulumi SDK have been loaded into
+     * the same process.
      */
     static isInstance(obj: any): obj is Archive;
 }
 /**
- * AssetMap is a map of assets.
+ * A map of assets.
  */
 export declare type AssetMap = {
     [name: string]: Asset | Archive;
 };
 /**
- * An AssetArchive is an archive created from an in-memory collection of named assets or other archives.
+ * An {@link AssetArchive} is an archive created from an in-memory collection of
+ * named assets or other archives.
  */
 export declare class AssetArchive extends Archive {
     /**
@@ -26,8 +28,9 @@ export declare class AssetArchive extends Archive {
     constructor(assets: AssetMap | Promise<AssetMap>);
 }
 /**
- * A FileArchive is a file-based archive, or a collection of file-based assets.  This can be a raw directory or a
- * single archive file in one of the supported formats (.tar, .tar.gz, or .zip).
+ * A {@link FileArchive} is a file-based archive, or a collection of file-based
+ * assets. This can be a raw directory or a single archive file in one of the
+ * supported formats (`.tar`, `.tar.gz`, or `.zip`).
  */
 export declare class FileArchive extends Archive {
     /**
@@ -37,9 +40,11 @@ export declare class FileArchive extends Archive {
     constructor(path: string | Promise<string>);
 }
 /**
- * A RemoteArchive is a file-based archive fetched from a remote location.  The URI's scheme dictates the
- * protocol for fetching the archive's contents: `file://` is a local file (just like a FileArchive), `http://` and
- * `https://` specify HTTP and HTTPS, respectively, and specific providers may recognize custom schemes.
+ * A {@link RemoteArchive} is a file-based archive fetched from a remote
+ * location. The URI's scheme dictates the protocol for fetching the archive's
+ * contents: `file://` is a local file (just like a {@link FileArchive}),
+ * `http://` and `https://` specify HTTP and HTTPS, respectively, and specific
+ * providers may recognize custom schemes.
  */
 export declare class RemoteArchive extends Archive {
     /**

package/asset/archive.js

@@ -22,20 +22,22 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils = __importStar(require("../utils"));
 /**
- * An Archive represents a collection of named assets.
+ * An {@link Archive} represents a collection of named assets.
  */
 class Archive {
     constructor() {
         /**
          * A private field to help with RTTI that works in SxS scenarios.
+         *
          * @internal
          */
         // eslint-disable-next-line @typescript-eslint/naming-convention,no-underscore-dangle,id-blacklist,id-match
         this.__pulumiArchive = true;
     }
     /**
-     * Returns true if the given object is an instance of an Archive.  This is designed to work even when
-     * multiple copies of the Pulumi SDK have been loaded into the same process.
+     * Returns true if the given object is an {@link Archive}. This is designed
+     * to work even when multiple copies of the Pulumi SDK have been loaded into
+     * the same process.
      */
     static isInstance(obj) {
         return utils.isInstance(obj, "__pulumiArchive");
@@ -43,7 +45,8 @@ class Archive {
 }
 exports.Archive = Archive;
 /**
- * An AssetArchive is an archive created from an in-memory collection of named assets or other archives.
+ * An {@link AssetArchive} is an archive created from an in-memory collection of
+ * named assets or other archives.
  */
 class AssetArchive extends Archive {
     constructor(assets) {
@@ -53,8 +56,9 @@ class AssetArchive extends Archive {
 }
 exports.AssetArchive = AssetArchive;
 /**
- * A FileArchive is a file-based archive, or a collection of file-based assets.  This can be a raw directory or a
- * single archive file in one of the supported formats (.tar, .tar.gz, or .zip).
+ * A {@link FileArchive} is a file-based archive, or a collection of file-based
+ * assets. This can be a raw directory or a single archive file in one of the
+ * supported formats (`.tar`, `.tar.gz`, or `.zip`).
  */
 class FileArchive extends Archive {
     constructor(path) {
@@ -64,9 +68,11 @@ class FileArchive extends Archive {
 }
 exports.FileArchive = FileArchive;
 /**
- * A RemoteArchive is a file-based archive fetched from a remote location.  The URI's scheme dictates the
- * protocol for fetching the archive's contents: `file://` is a local file (just like a FileArchive), `http://` and
- * `https://` specify HTTP and HTTPS, respectively, and specific providers may recognize custom schemes.
+ * A {@link RemoteArchive} is a file-based archive fetched from a remote
+ * location. The URI's scheme dictates the protocol for fetching the archive's
+ * contents: `file://` is a local file (just like a {@link FileArchive}),
+ * `http://` and `https://` specify HTTP and HTTPS, respectively, and specific
+ * providers may recognize custom schemes.
  */
 class RemoteArchive extends Archive {
     constructor(uri) {

package/asset/archive.js.map

@@ -1 +1 @@
-{"version":3,"file":"archive.js","sourceRoot":"","sources":["../../asset/archive.ts"],"names":[],"mappings":";AAAA,2CAA2C;AAC3C,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;;;;;;;AAEjC,gDAAkC;AAGlC;;GAEG;AACH,MAAsB,OAAO;IAA7B;QACI;;;WAGG;QACH,2GAA2G;QAC3F,oBAAe,GAAY,IAAI,CAAC;IASpD,CAAC;IAPG;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,OAAO,KAAK,CAAC,UAAU,CAAU,GAAG,EAAE,iBAAiB,CAAC,CAAC;IAC7D,CAAC;CACJ;AAfD,0BAeC;AAOD;;GAEG;AACH,MAAa,YAAa,SAAQ,OAAO;IAMrC,YAAY,MAAoC;QAC5C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;CACJ;AAVD,oCAUC;AAED;;;GAGG;AACH,MAAa,WAAY,SAAQ,OAAO;IAMpC,YAAY,IAA8B;QACtC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACJ;AAVD,kCAUC;AAED;;;;GAIG;AACH,MAAa,aAAc,SAAQ,OAAO;IAMtC,YAAY,GAA6B;QACrC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;CACJ;AAVD,sCAUC"}
+{"version":3,"file":"archive.js","sourceRoot":"","sources":["../../asset/archive.ts"],"names":[],"mappings":";AAAA,2CAA2C;AAC3C,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;;;;;;;AAEjC,gDAAkC;AAGlC;;GAEG;AACH,MAAsB,OAAO;IAA7B;QACI;;;;WAIG;QACH,2GAA2G;QAC3F,oBAAe,GAAY,IAAI,CAAC;IAUpD,CAAC;IARG;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,OAAO,KAAK,CAAC,UAAU,CAAU,GAAG,EAAE,iBAAiB,CAAC,CAAC;IAC7D,CAAC;CACJ;AAjBD,0BAiBC;AAOD;;;GAGG;AACH,MAAa,YAAa,SAAQ,OAAO;IAMrC,YAAY,MAAoC;QAC5C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;CACJ;AAVD,oCAUC;AAED;;;;GAIG;AACH,MAAa,WAAY,SAAQ,OAAO;IAMpC,YAAY,IAA8B;QACtC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACJ;AAVD,kCAUC;AAED;;;;;;GAMG;AACH,MAAa,aAAc,SAAQ,OAAO;IAMtC,YAAY,GAA6B;QACrC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;CACJ;AAVD,sCAUC"}

package/asset/asset.d.ts

@@ -1,18 +1,18 @@
 /**
- * Asset represents a single blob of text or data that is managed as a first class entity.
+ * {@link Asset} represents a single blob of text or data that is managed as a
+ * first-class entity.
  */
 export declare abstract class Asset {
     /**
-     * Returns true if the given object is an instance of an Asset.  This is designed to work even when
-     * multiple copies of the Pulumi SDK have been loaded into the same process.
+     * Returns true if the given object is an {@link Asset}. This is designed to
+     * work even when multiple copies of the Pulumi SDK have been loaded into
+     * the same process.
      */
     static isInstance(obj: any): obj is Asset;
 }
 /**
- * Blob is a kind of asset produced from an in-memory blob represented as a byte array.
- */
-/**
- * FileAsset is a kind of asset produced from a given path to a file on the local filesystem.
+ * {@link FileAsset} is a kind of asset produced from a given path to a file on
+ * the local filesystem.
  */
 export declare class FileAsset extends Asset {
     /**
@@ -22,7 +22,8 @@ export declare class FileAsset extends Asset {
     constructor(path: string | Promise<string>);
 }
 /**
- * StringAsset is a kind of asset produced from an in-memory UTF8-encoded string.
+ * {@link StringAsset} is a kind of asset produced from an in-memory
+ * UTF8-encoded string.
  */
 export declare class StringAsset extends Asset {
     /**
@@ -32,9 +33,11 @@ export declare class StringAsset extends Asset {
     constructor(text: string | Promise<string>);
 }
 /**
- * RemoteAsset is a kind of asset produced from a given URI string.  The URI's scheme dictates the protocol for fetching
- * contents: `file://` specifies a local file, `http://` and `https://` specify HTTP and HTTPS, respectively.  Note that
- * specific providers may recognize alternative schemes; this is merely the base-most set that all providers support.
+ * {@link RemoteAsset} is a kind of asset produced from a given URI string. The
+ * URI's scheme dictates the protocol for fetching contents: `file://` specifies
+ * a local file, `http://` and `https://` specify HTTP and HTTPS, respectively.
+ * Note that specific providers may recognize alternative schemes; this is
+ * merely the smallest set that all providers support.
  */
 export declare class RemoteAsset extends Asset {
     /**

package/asset/asset.js

@@ -22,20 +22,23 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils = __importStar(require("../utils"));
 /**
- * Asset represents a single blob of text or data that is managed as a first class entity.
+ * {@link Asset} represents a single blob of text or data that is managed as a
+ * first-class entity.
  */
 class Asset {
     constructor() {
         /**
          * A private field to help with RTTI that works in SxS scenarios.
+         *
          * @internal
          */
         // eslint-disable-next-line @typescript-eslint/naming-convention,no-underscore-dangle,id-blacklist,id-match
         this.__pulumiAsset = true;
     }
     /**
-     * Returns true if the given object is an instance of an Asset.  This is designed to work even when
-     * multiple copies of the Pulumi SDK have been loaded into the same process.
+     * Returns true if the given object is an {@link Asset}. This is designed to
+     * work even when multiple copies of the Pulumi SDK have been loaded into
+     * the same process.
      */
     static isInstance(obj) {
         return utils.isInstance(obj, "__pulumiAsset");
@@ -43,17 +46,8 @@ class Asset {
 }
 exports.Asset = Asset;
 /**
- * Blob is a kind of asset produced from an in-memory blob represented as a byte array.
- */
-/* IDEA: enable this once Uint8Array is supported.
-export class Blob extends Asset {
-    constructor(data: Uint8Array) {
-        super();
-    }
-}
-*/
-/**
- * FileAsset is a kind of asset produced from a given path to a file on the local filesystem.
+ * {@link FileAsset} is a kind of asset produced from a given path to a file on
+ * the local filesystem.
  */
 class FileAsset extends Asset {
     constructor(path) {
@@ -63,7 +57,8 @@ class FileAsset extends Asset {
 }
 exports.FileAsset = FileAsset;
 /**
- * StringAsset is a kind of asset produced from an in-memory UTF8-encoded string.
+ * {@link StringAsset} is a kind of asset produced from an in-memory
+ * UTF8-encoded string.
  */
 class StringAsset extends Asset {
     constructor(text) {
@@ -73,9 +68,11 @@ class StringAsset extends Asset {
 }
 exports.StringAsset = StringAsset;
 /**
- * RemoteAsset is a kind of asset produced from a given URI string.  The URI's scheme dictates the protocol for fetching
- * contents: `file://` specifies a local file, `http://` and `https://` specify HTTP and HTTPS, respectively.  Note that
- * specific providers may recognize alternative schemes; this is merely the base-most set that all providers support.
+ * {@link RemoteAsset} is a kind of asset produced from a given URI string. The
+ * URI's scheme dictates the protocol for fetching contents: `file://` specifies
+ * a local file, `http://` and `https://` specify HTTP and HTTPS, respectively.
+ * Note that specific providers may recognize alternative schemes; this is
+ * merely the smallest set that all providers support.
  */
 class RemoteAsset extends Asset {
     constructor(uri) {

package/asset/asset.js.map

@@ -1 +1 @@
-{"version":3,"file":"asset.js","sourceRoot":"","sources":["../../asset/asset.ts"],"names":[],"mappings":";AAAA,2CAA2C;AAC3C,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;;;;;;;AAEjC,gDAAkC;AAElC;;GAEG;AACH,MAAsB,KAAK;IAA3B;QACI;;;WAGG;QACH,2GAA2G;QAC3F,kBAAa,GAAY,IAAI,CAAC;IASlD,CAAC;IAPG;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,OAAO,KAAK,CAAC,UAAU,CAAQ,GAAG,EAAE,eAAe,CAAC,CAAC;IACzD,CAAC;CACJ;AAfD,sBAeC;AAED;;GAEG;AACH;;;;;;EAME;AAEF;;GAEG;AACH,MAAa,SAAU,SAAQ,KAAK;IAMhC,YAAY,IAA8B;QACtC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACJ;AAVD,8BAUC;AAED;;GAEG;AACH,MAAa,WAAY,SAAQ,KAAK;IAMlC,YAAY,IAA8B;QACtC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACJ;AAVD,kCAUC;AAED;;;;GAIG;AACH,MAAa,WAAY,SAAQ,KAAK;IAMlC,YAAY,GAA6B;QACrC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;CACJ;AAVD,kCAUC"}
+{"version":3,"file":"asset.js","sourceRoot":"","sources":["../../asset/asset.ts"],"names":[],"mappings":";AAAA,2CAA2C;AAC3C,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;;;;;;;AAEjC,gDAAkC;AAElC;;;GAGG;AACH,MAAsB,KAAK;IAA3B;QACI;;;;WAIG;QACH,2GAA2G;QAC3F,kBAAa,GAAY,IAAI,CAAC;IAUlD,CAAC;IARG;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,OAAO,KAAK,CAAC,UAAU,CAAQ,GAAG,EAAE,eAAe,CAAC,CAAC;IACzD,CAAC;CACJ;AAjBD,sBAiBC;AAED;;;GAGG;AACH,MAAa,SAAU,SAAQ,KAAK;IAMhC,YAAY,IAA8B;QACtC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACJ;AAVD,8BAUC;AAED;;;GAGG;AACH,MAAa,WAAY,SAAQ,KAAK;IAMlC,YAAY,IAA8B;QACtC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACJ;AAVD,kCAUC;AAED;;;;;;GAMG;AACH,MAAa,WAAY,SAAQ,KAAK;IAMlC,YAAY,GAA6B;QACrC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;CACJ;AAVD,kCAUC"}

package/dynamic/index.d.ts

@@ -1,7 +1,7 @@
 import { Inputs } from "../output";
 import * as resource from "../resource";
 /**
- * CheckResult represents the results of a call to `ResourceProvider.check`.
+ * {@link CheckResult} represents the results of a call to {@link ResourceProvider.check}.
  */
 export interface CheckResult<Inputs = any> {
     /**
@@ -14,7 +14,8 @@ export interface CheckResult<Inputs = any> {
     readonly failures?: CheckFailure[];
 }
 /**
- * CheckFailure represents a single failure in the results of a call to `ResourceProvider.check`
+ * {@link CheckFailure} represents a single failure in the results of a call to
+ * {@link ResourceProvider.check}.
  */
 export interface CheckFailure {
     /**
@@ -27,7 +28,8 @@ export interface CheckFailure {
     readonly reason: string;
 }
 /**
- * DiffResult represents the results of a call to `ResourceProvider.diff`.
+ * {@link DiffResult} represents the results of a call to
+ * {@link ResourceProvider.diff}.
  */
 export interface DiffResult {
     /**
@@ -43,13 +45,15 @@ export interface DiffResult {
      */
     readonly stables?: string[];
     /**
-     * If true, and a replacement occurs, the resource will first be deleted before being recreated.  This is to
-     * void potential side-by-side issues with the default create before delete behavior.
+     * If true, and a replacement occurs, the resource will first be deleted
+     * before being recreated.  This is to avoid potential side-by-side issues
+     * with the default create before delete behavior.
      */
     readonly deleteBeforeReplace?: boolean;
 }
 /**
- * CreateResult represents the results of a call to `ResourceProvider.create`.
+ * {@link CreateResult} represents the results of a call to
+ * {@link ResourceProvider.create}.
  */
 export interface CreateResult<Outputs = any> {
     /**
@@ -61,6 +65,10 @@ export interface CreateResult<Outputs = any> {
      */
     readonly outs?: Outputs;
 }
+/**
+ * {@link ReadResult} represents the results of a call to
+ * {@link ResourceProvider.read}.
+ */
 export interface ReadResult<Outputs = any> {
     /**
      * The ID of the resource ready back (or blank if missing).
@@ -72,7 +80,8 @@ export interface ReadResult<Outputs = any> {
     readonly props?: Outputs;
 }
 /**
- * UpdateResult represents the results of a call to `ResourceProvider.update`.
+ * {@link UpdateResult} represents the results of a call to
+ * {@link ResourceProvider.update}.
  */
 export interface UpdateResult<Outputs = any> {
     /**
@@ -81,66 +90,89 @@ export interface UpdateResult<Outputs = any> {
     readonly outs?: Outputs;
 }
 /**
- * ResourceProvider represents an object that provides CRUD operations for a particular type of resource.
+ * {@link ResourceProvider} represents an object that provides CRUD operations
+ * for a particular type of resource.
  */
 export interface ResourceProvider<Inputs = any, Outputs = any> {
     /**
-     * Check validates that the given property bag is valid for a resource of the given type.
+     * Validates that the given property bag is valid for a resource of the given type.
      *
-     * @param olds The old input properties to use for validation.
-     * @param news The new input properties to use for validation.
+     * @param olds
+     *  The old input properties to use for validation.
+     * @param news
+     *  The new input properties to use for validation.
      */
     check?: (olds: Inputs, news: Inputs) => Promise<CheckResult<Inputs>>;
     /**
-     * Diff checks what impacts a hypothetical update will have on the resource's properties.
+     * Checks what impacts a hypothetical update will have on the resource's
+     * properties.
      *
-     * @param id The ID of the resource to diff.
-     * @param olds The old values of properties to diff.
-     * @param news The new values of properties to diff.
+     * @param id
+     *  The ID of the resource to diff.
+     * @param olds
+     *  The old values of properties to diff.
+     * @param news
+     *  The new values of properties to diff.
      */
     diff?: (id: resource.ID, olds: Outputs, news: Inputs) => Promise<DiffResult>;
     /**
-     * Create allocates a new instance of the provided resource and returns its unique ID afterwards.
-     * If this call fails, the resource must not have been created (i.e., it is "transactional").
+     * Allocates a new instance of the provided resource and returns its unique
+     * ID afterwards. If this call fails, the resource must not have been
+     * created (i.e., it is "transactional").
      *
-     * @param inputs The properties to set during creation.
+     * @param inputs
+     *  The properties to set during creation.
      */
     create: (inputs: Inputs) => Promise<CreateResult<Outputs>>;
     /**
-     * Reads the current live state associated with a resource.  Enough state must be included in the inputs to uniquely
-     * identify the resource; this is typically just the resource ID, but it may also include some properties.
+     * Reads the current live state associated with a resource. Enough state
+     * must be included in the inputs to uniquely identify the resource; this is
+     * typically just the resource ID, but it may also include some properties.
      */
     read?: (id: resource.ID, props?: Outputs) => Promise<ReadResult<Outputs>>;
     /**
-     * Update updates an existing resource with new values.
+     * Updates an existing resource with new values.
      *
-     * @param id The ID of the resource to update.
-     * @param olds The old values of properties to update.
-     * @param news The new values of properties to update.
+     * @param id
+     *  The ID of the resource to update.
+     * @param olds
+     *  The old values of properties to update.
+     * @param news
+     *  The new values of properties to update.
      */
     update?: (id: resource.ID, olds: Outputs, news: Inputs) => Promise<UpdateResult<Outputs>>;
     /**
-     * Delete tears down an existing resource with the given ID.  If it fails, the resource is assumed to still exist.
+     * Tears down an existing resource with the given ID.  If it fails,
+     * the resource is assumed to still exist.
      *
-     * @param id The ID of the resource to delete.
-     * @param props The current properties on the resource.
+     * @param id
+     *  The ID of the resource to delete.
+     * @param props
+     *  The current properties on the resource.
      */
     delete?: (id: resource.ID, props: Outputs) => Promise<void>;
 }
 /**
- * Resource represents a Pulumi Resource that incorporates an inline implementation of the Resource's CRUD operations.
+ * {@link Resource} represents a Pulumi resource that incorporates an inline
+ * implementation of the Resource's CRUD operations.
  */
 export declare abstract class Resource extends resource.CustomResource {
     /**
      * Creates a new dynamic resource.
      *
-     * @param provider The implementation of the resource's CRUD operations.
-     * @param name The name of the resource.
-     * @param props The arguments to use to populate the new resource. Must not define the reserved
-     *              property "__provider".
-     * @param opts A bag of options that control this resource's behavior.
-     * @param module The module of the resource.
-     * @param type The type of the resource.
+     * @param provider
+     *  The implementation of the resource's CRUD operations.
+     * @param name
+     *  The name of the resource.
+     * @param props
+     *  The arguments to use to populate the new resource. Must not define the
+     *  reserved property "__provider".
+     * @param opts
+     *  A bag of options that control this resource's behavior.
+     * @param module
+     *  The module of the resource.
+     * @param type
+     *  The type of the resource.
      */
     constructor(provider: ResourceProvider, name: string, props: Inputs, opts?: resource.CustomResourceOptions, module?: string, type?: string);
 }

package/dynamic/index.js

@@ -52,19 +52,26 @@ function serializeFunctionMaybeSecret(provider) {
     return new output_1.Output([], sfPromise.then((sf) => sf.text), new Promise((resolve) => resolve(true)), sfPromise.then((sf) => sf.containsSecrets), new Promise((resolve) => resolve([])));
 }
 /**
- * Resource represents a Pulumi Resource that incorporates an inline implementation of the Resource's CRUD operations.
+ * {@link Resource} represents a Pulumi resource that incorporates an inline
+ * implementation of the Resource's CRUD operations.
  */
 class Resource extends resource.CustomResource {
     /**
      * Creates a new dynamic resource.
      *
-     * @param provider The implementation of the resource's CRUD operations.
-     * @param name The name of the resource.
-     * @param props The arguments to use to populate the new resource. Must not define the reserved
-     *              property "__provider".
-     * @param opts A bag of options that control this resource's behavior.
-     * @param module The module of the resource.
-     * @param type The type of the resource.
+     * @param provider
+     *  The implementation of the resource's CRUD operations.
+     * @param name
+     *  The name of the resource.
+     * @param props
+     *  The arguments to use to populate the new resource. Must not define the
+     *  reserved property "__provider".
+     * @param opts
+     *  A bag of options that control this resource's behavior.
+     * @param module
+     *  The module of the resource.
+     * @param type
+     *  The type of the resource.
      */
     constructor(provider, name, props, opts, module, type = "Resource") {
         const providerKey = "__provider";

package/dynamic/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../dynamic/index.ts"],"names":[],"mappings":";AAAA,2CAA2C;AAC3C,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;;;;;;;AAEjC,sCAAkD;AAClD,sDAAwC;AACxC,8DAAgD;AAoJhD,MAAM,aAAa,GAAG,IAAI,OAAO,EAAmC,CAAC;AAErE,SAAS,iBAAiB,CAAC,QAA0B;IACjD,IAAI,MAAqB,CAAC;IAC1B,0CAA0C;IAC1C,IAAI,QAAQ,CAAC,qBAAqB,EAAE,EAAE;QAClC,MAAM,cAAc,GAAG,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACnD,IAAI,cAAc,EAAE;YAChB,MAAM,GAAG,cAAc,CAAC;SAC3B;aAAM;YACH,MAAM,GAAG,4BAA4B,CAAC,QAAQ,CAAC,CAAC;YAChD,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACvC;KACJ;SAAM;QACH,MAAM,GAAG,4BAA4B,CAAC,QAAQ,CAAC,CAAC;KACnD;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAS,4BAA4B,CAAC,QAA0B;IAC5D,wEAAwE;IACxE,EAAE;IACF,6HAA6H;IAC7H,MAAM,EAAE,GAA4B,OAAO,CAAC,qCAAqC,CAAC,CAAC;IAEnF,MAAM,SAAS,GAAG,EAAE,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;IAE/E,sJAAsJ;IACtJ,OAAO,IAAI,eAAM,CACb,EAAE,EACF,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,EAC/B,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EACvC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,eAAe,CAAC,EAC1C,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CACxC,CAAC;AACN,CAAC;AAED;;GAEG;AACH,MAAsB,QAAS,SAAQ,QAAQ,CAAC,cAAc;IAC1D;;;;;;;;;;OAUG;IACH,YACI,QAA0B,EAC1B,IAAY,EACZ,KAAa,EACb,IAAqC,EACrC,MAAe,EACf,OAAe,UAAU;QAEzB,MAAM,WAAW,GAAW,YAAY,CAAC;QACzC,IAAI,KAAK,CAAC,WAAW,CAAC,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;SAC5E;QACD,KAAK,CAAC,WAAW,CAAC,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAEjD,KAAK,CAAC,wBAAwB,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3F,CAAC;CACJ;AA5BD,4BA4BC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../dynamic/index.ts"],"names":[],"mappings":";AAAA,2CAA2C;AAC3C,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;;;;;;;AAEjC,sCAAkD;AAClD,sDAAwC;AACxC,8DAAgD;AA6KhD,MAAM,aAAa,GAAG,IAAI,OAAO,EAAmC,CAAC;AAErE,SAAS,iBAAiB,CAAC,QAA0B;IACjD,IAAI,MAAqB,CAAC;IAC1B,0CAA0C;IAC1C,IAAI,QAAQ,CAAC,qBAAqB,EAAE,EAAE;QAClC,MAAM,cAAc,GAAG,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACnD,IAAI,cAAc,EAAE;YAChB,MAAM,GAAG,cAAc,CAAC;SAC3B;aAAM;YACH,MAAM,GAAG,4BAA4B,CAAC,QAAQ,CAAC,CAAC;YAChD,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACvC;KACJ;SAAM;QACH,MAAM,GAAG,4BAA4B,CAAC,QAAQ,CAAC,CAAC;KACnD;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAS,4BAA4B,CAAC,QAA0B;IAC5D,wEAAwE;IACxE,EAAE;IACF,6HAA6H;IAC7H,MAAM,EAAE,GAA4B,OAAO,CAAC,qCAAqC,CAAC,CAAC;IAEnF,MAAM,SAAS,GAAG,EAAE,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;IAE/E,sJAAsJ;IACtJ,OAAO,IAAI,eAAM,CACb,EAAE,EACF,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,EAC/B,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EACvC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,eAAe,CAAC,EAC1C,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CACxC,CAAC;AACN,CAAC;AAED;;;GAGG;AACH,MAAsB,QAAS,SAAQ,QAAQ,CAAC,cAAc;IAC1D;;;;;;;;;;;;;;;;OAgBG;IACH,YACI,QAA0B,EAC1B,IAAY,EACZ,KAAa,EACb,IAAqC,EACrC,MAAe,EACf,OAAe,UAAU;QAEzB,MAAM,WAAW,GAAW,YAAY,CAAC;QACzC,IAAI,KAAK,CAAC,WAAW,CAAC,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;SAC5E;QACD,KAAK,CAAC,WAAW,CAAC,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAEjD,KAAK,CAAC,wBAAwB,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3F,CAAC;CACJ;AAlCD,4BAkCC"}

package/errors.d.ts

@@ -1,29 +1,33 @@
 import { Resource } from "./resource";
 /**
- * RunError can be used for terminating a program abruptly, but resulting in a clean exit rather
- * than the usual verbose unhandled error logic which emits the source program text and complete
- * stack trace.  This type should be rarely used.  Ideally ResourceError should always be used so
- * that as many errors as possible can be associated with a Resource.
+ * {@link RunError} can be used for terminating a program abruptly, but
+ * resulting in a clean exit rather than the usual verbose unhandled error logic
+ * which emits the source program text and complete stack trace. This type
+ * should be rarely used. Ideally {@link ResourceError} should always be used so
+ * that as many errors as possible can be associated with a resource.
  */
 export declare class RunError extends Error {
     /**
-     * Returns true if the given object is an instance of a RunError.  This is designed to work even when
-     * multiple copies of the Pulumi SDK have been loaded into the same process.
+     * Returns true if the given object is a {@link RunError}. This is designed
+     * to work even when multiple copies of the Pulumi SDK have been loaded into
+     * the same process.
      */
     static isInstance(obj: any): obj is RunError;
 }
 /**
- * ResourceError can be used for terminating a program abruptly, specifically associating the
- * problem with a Resource.  Depending on the nature of the problem, clients can choose whether or
- * not a call stack should be returned as well.  This should be very rare, and would only indicate
- * no usefulness of presenting that stack to the user.
+ * {@link ResourceError} can be used for terminating a program abruptly,
+ * specifically associating the problem with a {@link Resource}. Depending on
+ * the nature of the problem, clients can choose whether or not the call stack
+ * should be hidden as well. This should be very rare, and would only indicate
+ * that presenting the stack to the user would not be useful/be detrimental.
  */
 export declare class ResourceError extends Error {
     resource: Resource | undefined;
     hideStack?: boolean | undefined;
     /**
-     * Returns true if the given object is an instance of a ResourceError.  This is designed to work even when
-     * multiple copies of the Pulumi SDK have been loaded into the same process.
+     * Returns true if the given object is a {@link ResourceError}. This is
+     * designed to work even when multiple copies of the Pulumi SDK have been
+     * loaded into the same process.
      */
     static isInstance(obj: any): obj is ResourceError;
     constructor(message: string, resource: Resource | undefined, hideStack?: boolean | undefined);

package/errors.js

@@ -23,24 +23,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const grpc = __importStar(require("@grpc/grpc-js"));
 const utils = __importStar(require("./utils"));
 /**
- * RunError can be used for terminating a program abruptly, but resulting in a clean exit rather
- * than the usual verbose unhandled error logic which emits the source program text and complete
- * stack trace.  This type should be rarely used.  Ideally ResourceError should always be used so
- * that as many errors as possible can be associated with a Resource.
+ * {@link RunError} can be used for terminating a program abruptly, but
+ * resulting in a clean exit rather than the usual verbose unhandled error logic
+ * which emits the source program text and complete stack trace. This type
+ * should be rarely used. Ideally {@link ResourceError} should always be used so
+ * that as many errors as possible can be associated with a resource.
  */
 class RunError extends Error {
     constructor() {
         super(...arguments);
         /**
          * A private field to help with RTTI that works in SxS scenarios.
+         *
          * @internal
          */
         // eslint-disable-next-line @typescript-eslint/naming-convention,no-underscore-dangle,id-blacklist,id-match
         this.__pulumiRunError = true;
     }
     /**
-     * Returns true if the given object is an instance of a RunError.  This is designed to work even when
-     * multiple copies of the Pulumi SDK have been loaded into the same process.
+     * Returns true if the given object is a {@link RunError}. This is designed
+     * to work even when multiple copies of the Pulumi SDK have been loaded into
+     * the same process.
      */
     static isInstance(obj) {
         return utils.isInstance(obj, "__pulumiRunError");
@@ -48,10 +51,11 @@ class RunError extends Error {
 }
 exports.RunError = RunError;
 /**
- * ResourceError can be used for terminating a program abruptly, specifically associating the
- * problem with a Resource.  Depending on the nature of the problem, clients can choose whether or
- * not a call stack should be returned as well.  This should be very rare, and would only indicate
- * no usefulness of presenting that stack to the user.
+ * {@link ResourceError} can be used for terminating a program abruptly,
+ * specifically associating the problem with a {@link Resource}. Depending on
+ * the nature of the problem, clients can choose whether or not the call stack
+ * should be hidden as well. This should be very rare, and would only indicate
+ * that presenting the stack to the user would not be useful/be detrimental.
  */
 class ResourceError extends Error {
     constructor(message, resource, hideStack) {
@@ -60,14 +64,16 @@ class ResourceError extends Error {
         this.hideStack = hideStack;
         /**
          * A private field to help with RTTI that works in SxS scenarios.
+         *
          * @internal
          */
         // eslint-disable-next-line @typescript-eslint/naming-convention, no-underscore-dangle, id-blacklist, id-match
         this.__pulumResourceError = true;
     }
     /**
-     * Returns true if the given object is an instance of a ResourceError.  This is designed to work even when
-     * multiple copies of the Pulumi SDK have been loaded into the same process.
+     * Returns true if the given object is a {@link ResourceError}. This is
+     * designed to work even when multiple copies of the Pulumi SDK have been
+     * loaded into the same process.
      */
     static isInstance(obj) {
         return utils.isInstance(obj, "__pulumResourceError");

package/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../errors.ts"],"names":[],"mappings":";AAAA,2CAA2C;AAC3C,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;;;;;;;AAEjC,oDAAsC;AAGtC,+CAAiC;AAEjC;;;;;GAKG;AACH,MAAa,QAAS,SAAQ,KAAK;IAAnC;;QACI;;;WAGG;QACH,2GAA2G;QAC3F,qBAAgB,GAAY,IAAI,CAAC;IASrD,CAAC;IAPG;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,OAAO,KAAK,CAAC,UAAU,CAAW,GAAG,EAAE,kBAAkB,CAAC,CAAC;IAC/D,CAAC;CACJ;AAfD,4BAeC;AAED;;;;;GAKG;AACH,MAAa,aAAc,SAAQ,KAAK;IAgBpC,YACI,OAAe,EACR,QAA8B,EAC9B,SAAmB;QAE1B,KAAK,CAAC,OAAO,CAAC,CAAC;QAHR,aAAQ,GAAR,QAAQ,CAAsB;QAC9B,cAAS,GAAT,SAAS,CAAU;QAlB9B;;;WAGG;QACH,8GAA8G;QAC9F,yBAAoB,GAAY,IAAI,CAAC;IAgBrD,CAAC;IAdD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,OAAO,KAAK,CAAC,UAAU,CAAgB,GAAG,EAAE,sBAAsB,CAAC,CAAC;IACxE,CAAC;CASJ;AAvBD,sCAuBC;AAED,SAAgB,WAAW,CAAC,GAAU;IAClC,MAAM,IAAI,GAAS,GAAI,CAAC,IAAI,CAAC;IAC7B,OAAO,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;AAC9E,CAAC;AAHD,kCAGC"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../errors.ts"],"names":[],"mappings":";AAAA,2CAA2C;AAC3C,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;;;;;;;AAEjC,oDAAsC;AAGtC,+CAAiC;AAEjC;;;;;;GAMG;AACH,MAAa,QAAS,SAAQ,KAAK;IAAnC;;QACI;;;;WAIG;QACH,2GAA2G;QAC3F,qBAAgB,GAAY,IAAI,CAAC;IAUrD,CAAC;IARG;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,OAAO,KAAK,CAAC,UAAU,CAAW,GAAG,EAAE,kBAAkB,CAAC,CAAC;IAC/D,CAAC;CACJ;AAjBD,4BAiBC;AAED;;;;;;GAMG;AACH,MAAa,aAAc,SAAQ,KAAK;IAkBpC,YACI,OAAe,EACR,QAA8B,EAC9B,SAAmB;QAE1B,KAAK,CAAC,OAAO,CAAC,CAAC;QAHR,aAAQ,GAAR,QAAQ,CAAsB;QAC9B,cAAS,GAAT,SAAS,CAAU;QApB9B;;;;WAIG;QACH,8GAA8G;QAC9F,yBAAoB,GAAY,IAAI,CAAC;IAiBrD,CAAC;IAfD;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,OAAO,KAAK,CAAC,UAAU,CAAgB,GAAG,EAAE,sBAAsB,CAAC,CAAC;IACxE,CAAC;CASJ;AAzBD,sCAyBC;AAED,SAAgB,WAAW,CAAC,GAAU;IAClC,MAAM,IAAI,GAAS,GAAI,CAAC,IAAI,CAAC;IAC7B,OAAO,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;AAC9E,CAAC;AAHD,kCAGC"}