diff --git a/content/docs/cli/commands/pulumi.md b/content/docs/cli/commands/pulumi.md index 7cde952e2471..5242d6443d70 100644 --- a/content/docs/cli/commands/pulumi.md +++ b/content/docs/cli/commands/pulumi.md @@ -75,4 +75,4 @@ For more information, please visit the project page: https://www.pulumi.com/docs * [pulumi watch](/docs/cli/commands/pulumi_watch/) - Continuously update the resources in a stack * [pulumi whoami](/docs/cli/commands/pulumi_whoami/) - Display the current logged-in user -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_about.md b/content/docs/cli/commands/pulumi_about.md index 4a4506123b36..f64425cfb98b 100644 --- a/content/docs/cli/commands/pulumi_about.md +++ b/content/docs/cli/commands/pulumi_about.md @@ -55,4 +55,4 @@ pulumi about [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_cancel.md b/content/docs/cli/commands/pulumi_cancel.md index 48a2d27ff4f9..871a48d7fb73 100644 --- a/content/docs/cli/commands/pulumi_cancel.md +++ b/content/docs/cli/commands/pulumi_cancel.md @@ -52,4 +52,4 @@ pulumi cancel [] [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_config.md b/content/docs/cli/commands/pulumi_config.md index 9565ea8b7971..892580aef117 100644 --- a/content/docs/cli/commands/pulumi_config.md +++ b/content/docs/cli/commands/pulumi_config.md @@ -58,4 +58,4 @@ pulumi config [flags] * [pulumi config set](/docs/cli/commands/pulumi_config_set/) - Set configuration value * [pulumi config set-all](/docs/cli/commands/pulumi_config_set-all/) - Set multiple configuration values -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_config_cp.md b/content/docs/cli/commands/pulumi_config_cp.md index 29e2020bc4bd..087faf9cd036 100644 --- a/content/docs/cli/commands/pulumi_config_cp.md +++ b/content/docs/cli/commands/pulumi_config_cp.md @@ -48,4 +48,4 @@ pulumi config cp [key] [flags] * [pulumi config](/docs/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_config_env.md b/content/docs/cli/commands/pulumi_config_env.md index 572de47e21a4..95bd2fbf0349 100644 --- a/content/docs/cli/commands/pulumi_config_env.md +++ b/content/docs/cli/commands/pulumi_config_env.md @@ -46,4 +46,4 @@ from a stack's configuration, use `pulumi config env init`. * [pulumi config env ls](/docs/cli/commands/pulumi_config_env_ls/) - Lists imported environments. * [pulumi config env rm](/docs/cli/commands/pulumi_config_env_rm/) - Remove environments from a stack -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_config_env_add.md b/content/docs/cli/commands/pulumi_config_env_add.md index a127279e275c..3ec6f6d44db3 100644 --- a/content/docs/cli/commands/pulumi_config_env_add.md +++ b/content/docs/cli/commands/pulumi_config_env_add.md @@ -49,4 +49,4 @@ pulumi config env add [flags] * [pulumi config env](/docs/cli/commands/pulumi_config_env/) - Manage ESC environments for a stack -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_config_env_init.md b/content/docs/cli/commands/pulumi_config_env_init.md index 431f565affd5..d6b2235e4c31 100644 --- a/content/docs/cli/commands/pulumi_config_env_init.md +++ b/content/docs/cli/commands/pulumi_config_env_init.md @@ -51,4 +51,4 @@ pulumi config env init [flags] * [pulumi config env](/docs/cli/commands/pulumi_config_env/) - Manage ESC environments for a stack -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_config_env_ls.md b/content/docs/cli/commands/pulumi_config_env_ls.md index 69fd07045691..59cce93e9f6c 100644 --- a/content/docs/cli/commands/pulumi_config_env_ls.md +++ b/content/docs/cli/commands/pulumi_config_env_ls.md @@ -46,4 +46,4 @@ pulumi config env ls [flags] * [pulumi config env](/docs/cli/commands/pulumi_config_env/) - Manage ESC environments for a stack -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_config_env_rm.md b/content/docs/cli/commands/pulumi_config_env_rm.md index aebc9c658e23..9bf61cb508f8 100644 --- a/content/docs/cli/commands/pulumi_config_env_rm.md +++ b/content/docs/cli/commands/pulumi_config_env_rm.md @@ -47,4 +47,4 @@ pulumi config env rm [flags] * [pulumi config env](/docs/cli/commands/pulumi_config_env/) - Manage ESC environments for a stack -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_config_get.md b/content/docs/cli/commands/pulumi_config_get.md index 3abf9b28f818..dcc8926994e8 100644 --- a/content/docs/cli/commands/pulumi_config_get.md +++ b/content/docs/cli/commands/pulumi_config_get.md @@ -53,4 +53,4 @@ pulumi config get [flags] * [pulumi config](/docs/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_config_refresh.md b/content/docs/cli/commands/pulumi_config_refresh.md index c33adea515c4..ad19913b3083 100644 --- a/content/docs/cli/commands/pulumi_config_refresh.md +++ b/content/docs/cli/commands/pulumi_config_refresh.md @@ -42,4 +42,4 @@ pulumi config refresh [flags] * [pulumi config](/docs/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_config_rm-all.md b/content/docs/cli/commands/pulumi_config_rm-all.md index 03e9803cdd1d..2fa0b6fee0f2 100644 --- a/content/docs/cli/commands/pulumi_config_rm-all.md +++ b/content/docs/cli/commands/pulumi_config_rm-all.md @@ -52,4 +52,4 @@ pulumi config rm-all ... [flags] * [pulumi config](/docs/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_config_rm.md b/content/docs/cli/commands/pulumi_config_rm.md index 2f2ab1cfa3df..5844c06b90e7 100644 --- a/content/docs/cli/commands/pulumi_config_rm.md +++ b/content/docs/cli/commands/pulumi_config_rm.md @@ -51,4 +51,4 @@ pulumi config rm [flags] * [pulumi config](/docs/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_config_set-all.md b/content/docs/cli/commands/pulumi_config_set-all.md index 4ef7490f22d1..9a89c952545f 100644 --- a/content/docs/cli/commands/pulumi_config_set-all.md +++ b/content/docs/cli/commands/pulumi_config_set-all.md @@ -62,4 +62,4 @@ pulumi config set-all --plaintext key1=value1 --plaintext key2=value2 --secret k * [pulumi config](/docs/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_config_set.md b/content/docs/cli/commands/pulumi_config_set.md index f2d0552f6fb8..8e4db7449067 100644 --- a/content/docs/cli/commands/pulumi_config_set.md +++ b/content/docs/cli/commands/pulumi_config_set.md @@ -57,4 +57,4 @@ pulumi config set [value] [flags] * [pulumi config](/docs/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_console.md b/content/docs/cli/commands/pulumi_console.md index fd2dae3d32b3..78434dacec7d 100644 --- a/content/docs/cli/commands/pulumi_console.md +++ b/content/docs/cli/commands/pulumi_console.md @@ -40,4 +40,4 @@ pulumi console [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_convert.md b/content/docs/cli/commands/pulumi_convert.md index 183d0974fbb5..315d4572ef99 100644 --- a/content/docs/cli/commands/pulumi_convert.md +++ b/content/docs/cli/commands/pulumi_convert.md @@ -59,4 +59,4 @@ pulumi convert [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_destroy.md b/content/docs/cli/commands/pulumi_destroy.md index 2deb790fb2fb..72c9f29de154 100644 --- a/content/docs/cli/commands/pulumi_destroy.md +++ b/content/docs/cli/commands/pulumi_destroy.md @@ -74,4 +74,4 @@ pulumi destroy [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env.md b/content/docs/cli/commands/pulumi_env.md index ef7167fc1ab3..e3a0a01644e3 100644 --- a/content/docs/cli/commands/pulumi_env.md +++ b/content/docs/cli/commands/pulumi_env.md @@ -62,4 +62,4 @@ For more information, please visit the project page: https://www.pulumi.com/docs * [pulumi env set](/docs/cli/commands/pulumi_env_set/) - Set a value within an environment. * [pulumi env version](/docs/cli/commands/pulumi_env_version/) - Manage versions -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_diff.md b/content/docs/cli/commands/pulumi_env_diff.md index 8c272a0ad688..18a029047eb3 100644 --- a/content/docs/cli/commands/pulumi_env_diff.md +++ b/content/docs/cli/commands/pulumi_env_diff.md @@ -55,4 +55,4 @@ pulumi env diff [/][@] [[[org-name/]/] [flags] * [pulumi env](/docs/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_get.md b/content/docs/cli/commands/pulumi_env_get.md index 7983558614b0..0e4454ba750e 100644 --- a/content/docs/cli/commands/pulumi_env_get.md +++ b/content/docs/cli/commands/pulumi_env_get.md @@ -51,4 +51,4 @@ pulumi env get [/][@] [flags] * [pulumi env](/docs/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_init.md b/content/docs/cli/commands/pulumi_env_init.md index 011e1390d67b..f66dd185f3d6 100644 --- a/content/docs/cli/commands/pulumi_env_init.md +++ b/content/docs/cli/commands/pulumi_env_init.md @@ -52,4 +52,4 @@ pulumi env init [/] [flags] * [pulumi env](/docs/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_ls.md b/content/docs/cli/commands/pulumi_env_ls.md index 41722786c8b1..7d8a4619e404 100644 --- a/content/docs/cli/commands/pulumi_env_ls.md +++ b/content/docs/cli/commands/pulumi_env_ls.md @@ -48,4 +48,4 @@ pulumi env ls [flags] * [pulumi env](/docs/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_open.md b/content/docs/cli/commands/pulumi_env_open.md index 0ea82677ca26..8fb992f2c956 100644 --- a/content/docs/cli/commands/pulumi_env_open.md +++ b/content/docs/cli/commands/pulumi_env_open.md @@ -50,4 +50,4 @@ pulumi env open [/][@] [property path] [fla * [pulumi env](/docs/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_rm.md b/content/docs/cli/commands/pulumi_env_rm.md index adec30b9b9eb..128c8664a107 100644 --- a/content/docs/cli/commands/pulumi_env_rm.md +++ b/content/docs/cli/commands/pulumi_env_rm.md @@ -49,4 +49,4 @@ pulumi env rm [/] [path] [flags] * [pulumi env](/docs/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_run.md b/content/docs/cli/commands/pulumi_env_run.md index b16d5c68471d..a348e3808286 100644 --- a/content/docs/cli/commands/pulumi_env_run.md +++ b/content/docs/cli/commands/pulumi_env_run.md @@ -65,4 +65,4 @@ pulumi env run [/] [flags] -- [command] * [pulumi env](/docs/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_set.md b/content/docs/cli/commands/pulumi_env_set.md index 537a749abfc0..bf1bf66aea3a 100644 --- a/content/docs/cli/commands/pulumi_env_set.md +++ b/content/docs/cli/commands/pulumi_env_set.md @@ -51,4 +51,4 @@ pulumi env set [/] [flags] * [pulumi env](/docs/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_version.md b/content/docs/cli/commands/pulumi_env_version.md index abb92ea4536b..a17ddd38f9ae 100644 --- a/content/docs/cli/commands/pulumi_env_version.md +++ b/content/docs/cli/commands/pulumi_env_version.md @@ -53,4 +53,4 @@ pulumi env version [/]@ [flags] * [pulumi env version rollback](/docs/cli/commands/pulumi_env_version_rollback/) - Roll back to a specific version * [pulumi env version tag](/docs/cli/commands/pulumi_env_version_tag/) - Manage tagged versions -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_version_history.md b/content/docs/cli/commands/pulumi_env_version_history.md index 0fabed0fec2f..f76aa04b5a74 100644 --- a/content/docs/cli/commands/pulumi_env_version_history.md +++ b/content/docs/cli/commands/pulumi_env_version_history.md @@ -50,4 +50,4 @@ pulumi env version history [/][@] [flags] * [pulumi env version](/docs/cli/commands/pulumi_env_version/) - Manage versions -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_version_retract.md b/content/docs/cli/commands/pulumi_env_version_retract.md index f499ee287a3d..b70a7aec18ae 100644 --- a/content/docs/cli/commands/pulumi_env_version_retract.md +++ b/content/docs/cli/commands/pulumi_env_version_retract.md @@ -56,4 +56,4 @@ pulumi env version retract [/]@ [flags] * [pulumi env version](/docs/cli/commands/pulumi_env_version/) - Manage versions -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_version_rollback.md b/content/docs/cli/commands/pulumi_env_version_rollback.md index fe51f6602cf4..0c1f9da63738 100644 --- a/content/docs/cli/commands/pulumi_env_version_rollback.md +++ b/content/docs/cli/commands/pulumi_env_version_rollback.md @@ -49,4 +49,4 @@ pulumi env version rollback [/]@ [flags] * [pulumi env version](/docs/cli/commands/pulumi_env_version/) - Manage versions -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_version_tag.md b/content/docs/cli/commands/pulumi_env_version_tag.md index b4616b0dbafc..2bde68ebf9be 100644 --- a/content/docs/cli/commands/pulumi_env_version_tag.md +++ b/content/docs/cli/commands/pulumi_env_version_tag.md @@ -54,4 +54,4 @@ pulumi env version tag [/]@ [@] [flags * [pulumi env version tag ls](/docs/cli/commands/pulumi_env_version_tag_ls/) - List tagged versions. * [pulumi env version tag rm](/docs/cli/commands/pulumi_env_version_tag_rm/) - Remove a tagged version. -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_version_tag_ls.md b/content/docs/cli/commands/pulumi_env_version_tag_ls.md index da3a3d153865..79d6d948e4b5 100644 --- a/content/docs/cli/commands/pulumi_env_version_tag_ls.md +++ b/content/docs/cli/commands/pulumi_env_version_tag_ls.md @@ -49,4 +49,4 @@ pulumi env version tag ls [/] [flags] * [pulumi env version tag](/docs/cli/commands/pulumi_env_version_tag/) - Manage tagged versions -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_env_version_tag_rm.md b/content/docs/cli/commands/pulumi_env_version_tag_rm.md index b08b54b2940e..ed470aec7077 100644 --- a/content/docs/cli/commands/pulumi_env_version_tag_rm.md +++ b/content/docs/cli/commands/pulumi_env_version_tag_rm.md @@ -46,4 +46,4 @@ pulumi env version tag rm [/]@ [flags] * [pulumi env version tag](/docs/cli/commands/pulumi_env_version_tag/) - Manage tagged versions -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_gen-completion.md b/content/docs/cli/commands/pulumi_gen-completion.md index da6453b3572d..b8c06ca723ff 100644 --- a/content/docs/cli/commands/pulumi_gen-completion.md +++ b/content/docs/cli/commands/pulumi_gen-completion.md @@ -39,4 +39,4 @@ pulumi gen-completion [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_import.md b/content/docs/cli/commands/pulumi_import.md index a290c5e28034..33430663f577 100644 --- a/content/docs/cli/commands/pulumi_import.md +++ b/content/docs/cli/commands/pulumi_import.md @@ -150,4 +150,4 @@ pulumi import [type] [name] [id] [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_install.md b/content/docs/cli/commands/pulumi_install.md index f859583b0b9a..76489e991236 100644 --- a/content/docs/cli/commands/pulumi_install.md +++ b/content/docs/cli/commands/pulumi_install.md @@ -21,10 +21,11 @@ pulumi install [flags] ## Options ``` - -h, --help help for install - --no-dependencies Skip installing dependencies - --no-plugins Skip installing plugins - --reinstall Reinstall a plugin even if it already exists + -h, --help help for install + --no-dependencies Skip installing dependencies + --no-plugins Skip installing plugins + --reinstall Reinstall a plugin even if it already exists + --use-language-version-tools Use language version tools to setup and install the language runtime ``` ## Options inherited from parent commands @@ -48,4 +49,4 @@ pulumi install [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_login.md b/content/docs/cli/commands/pulumi_login.md index 211ce83d054c..10ebdc961be2 100644 --- a/content/docs/cli/commands/pulumi_login.md +++ b/content/docs/cli/commands/pulumi_login.md @@ -91,4 +91,4 @@ pulumi login [] [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_logout.md b/content/docs/cli/commands/pulumi_logout.md index cce78fb07e0b..e31207f3fca4 100644 --- a/content/docs/cli/commands/pulumi_logout.md +++ b/content/docs/cli/commands/pulumi_logout.md @@ -56,4 +56,4 @@ pulumi logout [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_logs.md b/content/docs/cli/commands/pulumi_logs.md index b55bac3f3189..9362ef09c72a 100644 --- a/content/docs/cli/commands/pulumi_logs.md +++ b/content/docs/cli/commands/pulumi_logs.md @@ -54,4 +54,4 @@ pulumi logs [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_new.md b/content/docs/cli/commands/pulumi_new.md index bedae4277e43..9056cc31a8ff 100644 --- a/content/docs/cli/commands/pulumi_new.md +++ b/content/docs/cli/commands/pulumi_new.md @@ -102,4 +102,4 @@ pulumi new [template|url] [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_org.md b/content/docs/cli/commands/pulumi_org.md index 04a41b3f945b..0f9f21f71d61 100644 --- a/content/docs/cli/commands/pulumi_org.md +++ b/content/docs/cli/commands/pulumi_org.md @@ -48,4 +48,4 @@ pulumi org [flags] * [pulumi org search](/docs/cli/commands/pulumi_org_search/) - Search for resources in Pulumi Cloud * [pulumi org set-default](/docs/cli/commands/pulumi_org_set-default/) - Set the local default organization for the current backend -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_org_get-default.md b/content/docs/cli/commands/pulumi_org_get-default.md index 74db259ed8fa..caed8f87d2e0 100644 --- a/content/docs/cli/commands/pulumi_org_get-default.md +++ b/content/docs/cli/commands/pulumi_org_get-default.md @@ -47,4 +47,4 @@ pulumi org get-default [flags] * [pulumi org](/docs/cli/commands/pulumi_org/) - Manage Organization configuration -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_org_search.md b/content/docs/cli/commands/pulumi_org_search.md index ebcf42c4aa91..f4252272927e 100644 Binary files a/content/docs/cli/commands/pulumi_org_search.md and b/content/docs/cli/commands/pulumi_org_search.md differ diff --git a/content/docs/cli/commands/pulumi_org_search_ai.md b/content/docs/cli/commands/pulumi_org_search_ai.md index 633d209edd3c..84b8d54c8053 100644 Binary files a/content/docs/cli/commands/pulumi_org_search_ai.md and b/content/docs/cli/commands/pulumi_org_search_ai.md differ diff --git a/content/docs/cli/commands/pulumi_org_set-default.md b/content/docs/cli/commands/pulumi_org_set-default.md index 0f47a86ad295..ec78b907a27a 100644 --- a/content/docs/cli/commands/pulumi_org_set-default.md +++ b/content/docs/cli/commands/pulumi_org_set-default.md @@ -49,4 +49,4 @@ pulumi org set-default [NAME] [flags] * [pulumi org](/docs/cli/commands/pulumi_org/) - Manage Organization configuration -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_package.md b/content/docs/cli/commands/pulumi_package.md index 9896e1d1da1a..184c64ed4924 100644 --- a/content/docs/cli/commands/pulumi_package.md +++ b/content/docs/cli/commands/pulumi_package.md @@ -45,4 +45,4 @@ Install and configure Pulumi packages and their plugins and SDKs. * [pulumi package get-mapping](/docs/cli/commands/pulumi_package_get-mapping/) - Get the mapping information for a given key from a package * [pulumi package get-schema](/docs/cli/commands/pulumi_package_get-schema/) - Get the schema.json from a package -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_package_add.md b/content/docs/cli/commands/pulumi_package_add.md index 9e58ec98f0eb..a998a90bf56a 100644 --- a/content/docs/cli/commands/pulumi_package_add.md +++ b/content/docs/cli/commands/pulumi_package_add.md @@ -51,4 +51,4 @@ pulumi package add [provider-parameter...] [flags] * [pulumi package](/docs/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_package_gen-sdk.md b/content/docs/cli/commands/pulumi_package_gen-sdk.md index 9fca6bfd8a1e..f9e4d5d454e1 100644 --- a/content/docs/cli/commands/pulumi_package_gen-sdk.md +++ b/content/docs/cli/commands/pulumi_package_gen-sdk.md @@ -50,4 +50,4 @@ pulumi package gen-sdk [provider parameters] [flags] * [pulumi package](/docs/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_package_get-mapping.md b/content/docs/cli/commands/pulumi_package_get-mapping.md index 16f34b6eeecd..d240e10cd775 100644 --- a/content/docs/cli/commands/pulumi_package_get-mapping.md +++ b/content/docs/cli/commands/pulumi_package_get-mapping.md @@ -46,4 +46,4 @@ pulumi package get-mapping [] [flags] * [pulumi package](/docs/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_package_get-schema.md b/content/docs/cli/commands/pulumi_package_get-schema.md index 5009bc5fe4df..c3755cf67c7d 100644 --- a/content/docs/cli/commands/pulumi_package_get-schema.md +++ b/content/docs/cli/commands/pulumi_package_get-schema.md @@ -46,4 +46,4 @@ pulumi package get-schema [provider parameters] [flags] * [pulumi package](/docs/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_plugin.md b/content/docs/cli/commands/pulumi_plugin.md index 94da87771667..a5a716832829 100644 --- a/content/docs/cli/commands/pulumi_plugin.md +++ b/content/docs/cli/commands/pulumi_plugin.md @@ -55,4 +55,4 @@ For a list of available resource plugins, please see https://www.pulumi.com/regi * [pulumi plugin ls](/docs/cli/commands/pulumi_plugin_ls/) - List plugins * [pulumi plugin rm](/docs/cli/commands/pulumi_plugin_rm/) - Remove one or more plugins from the download cache -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_plugin_install.md b/content/docs/cli/commands/pulumi_plugin_install.md index e46be534564c..81e424c2a195 100644 --- a/content/docs/cli/commands/pulumi_plugin_install.md +++ b/content/docs/cli/commands/pulumi_plugin_install.md @@ -58,4 +58,4 @@ pulumi plugin install [KIND NAME [VERSION]] [flags] * [pulumi plugin](/docs/cli/commands/pulumi_plugin/) - Manage language and resource provider plugins -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_plugin_ls.md b/content/docs/cli/commands/pulumi_plugin_ls.md index df059c35ec88..c203221868b9 100644 --- a/content/docs/cli/commands/pulumi_plugin_ls.md +++ b/content/docs/cli/commands/pulumi_plugin_ls.md @@ -41,4 +41,4 @@ pulumi plugin ls [flags] * [pulumi plugin](/docs/cli/commands/pulumi_plugin/) - Manage language and resource provider plugins -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_plugin_rm.md b/content/docs/cli/commands/pulumi_plugin_rm.md index b52f71394dd3..acc480ebbb99 100644 --- a/content/docs/cli/commands/pulumi_plugin_rm.md +++ b/content/docs/cli/commands/pulumi_plugin_rm.md @@ -54,4 +54,4 @@ pulumi plugin rm [KIND [NAME [VERSION]]] [flags] * [pulumi plugin](/docs/cli/commands/pulumi_plugin/) - Manage language and resource provider plugins -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_policy.md b/content/docs/cli/commands/pulumi_policy.md index 544ee9449307..3acc3da59444 100644 --- a/content/docs/cli/commands/pulumi_policy.md +++ b/content/docs/cli/commands/pulumi_policy.md @@ -43,4 +43,4 @@ Manage resource policies * [pulumi policy rm](/docs/cli/commands/pulumi_policy_rm/) - Removes a Policy Pack from a Pulumi organization * [pulumi policy validate-config](/docs/cli/commands/pulumi_policy_validate-config/) - Validate a Policy Pack configuration -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_policy_disable.md b/content/docs/cli/commands/pulumi_policy_disable.md index bc6cb899cb2c..9a5c29769edc 100644 --- a/content/docs/cli/commands/pulumi_policy_disable.md +++ b/content/docs/cli/commands/pulumi_policy_disable.md @@ -45,4 +45,4 @@ pulumi policy disable / [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_policy_enable.md b/content/docs/cli/commands/pulumi_policy_enable.md index 8d3303762c8d..e7165b606b16 100644 --- a/content/docs/cli/commands/pulumi_policy_enable.md +++ b/content/docs/cli/commands/pulumi_policy_enable.md @@ -45,4 +45,4 @@ pulumi policy enable / [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_policy_group.md b/content/docs/cli/commands/pulumi_policy_group.md index bf99b82b7560..7ba925b8a859 100644 --- a/content/docs/cli/commands/pulumi_policy_group.md +++ b/content/docs/cli/commands/pulumi_policy_group.md @@ -36,4 +36,4 @@ Manage policy groups * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies * [pulumi policy group ls](/docs/cli/commands/pulumi_policy_group_ls/) - List all Policy Groups for a Pulumi organization -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_policy_group_ls.md b/content/docs/cli/commands/pulumi_policy_group_ls.md index 4b41688f1bc3..f324367a9396 100644 --- a/content/docs/cli/commands/pulumi_policy_group_ls.md +++ b/content/docs/cli/commands/pulumi_policy_group_ls.md @@ -44,4 +44,4 @@ pulumi policy group ls [org-name] [flags] * [pulumi policy group](/docs/cli/commands/pulumi_policy_group/) - Manage policy groups -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_policy_ls.md b/content/docs/cli/commands/pulumi_policy_ls.md index e710eb94f9e7..692e8cc1a683 100644 --- a/content/docs/cli/commands/pulumi_policy_ls.md +++ b/content/docs/cli/commands/pulumi_policy_ls.md @@ -44,4 +44,4 @@ pulumi policy ls [org-name] [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_policy_new.md b/content/docs/cli/commands/pulumi_policy_new.md index 5ea8f176c487..939839820e02 100644 --- a/content/docs/cli/commands/pulumi_policy_new.md +++ b/content/docs/cli/commands/pulumi_policy_new.md @@ -54,4 +54,4 @@ pulumi policy new [template|url] [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_policy_publish.md b/content/docs/cli/commands/pulumi_policy_publish.md index d41ab9c0618f..0211c69a2410 100644 --- a/content/docs/cli/commands/pulumi_policy_publish.md +++ b/content/docs/cli/commands/pulumi_policy_publish.md @@ -45,4 +45,4 @@ pulumi policy publish [org-name] [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_policy_rm.md b/content/docs/cli/commands/pulumi_policy_rm.md index 31336d4cb2c0..2c47a6ded630 100644 --- a/content/docs/cli/commands/pulumi_policy_rm.md +++ b/content/docs/cli/commands/pulumi_policy_rm.md @@ -44,4 +44,4 @@ pulumi policy rm / [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_policy_validate-config.md b/content/docs/cli/commands/pulumi_policy_validate-config.md index 3c1559286042..be593b6fab84 100644 --- a/content/docs/cli/commands/pulumi_policy_validate-config.md +++ b/content/docs/cli/commands/pulumi_policy_validate-config.md @@ -44,4 +44,4 @@ pulumi policy validate-config / [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_preview.md b/content/docs/cli/commands/pulumi_preview.md index 725f075213c7..62bf0b15a760 100644 --- a/content/docs/cli/commands/pulumi_preview.md +++ b/content/docs/cli/commands/pulumi_preview.md @@ -80,4 +80,4 @@ pulumi preview [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_refresh.md b/content/docs/cli/commands/pulumi_refresh.md index 1982ae53a6b3..dd4809695312 100644 --- a/content/docs/cli/commands/pulumi_refresh.md +++ b/content/docs/cli/commands/pulumi_refresh.md @@ -71,4 +71,4 @@ pulumi refresh [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_schema.md b/content/docs/cli/commands/pulumi_schema.md index 69ec0876a630..21a37e764a40 100644 --- a/content/docs/cli/commands/pulumi_schema.md +++ b/content/docs/cli/commands/pulumi_schema.md @@ -43,4 +43,4 @@ package schemas for errors. * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line * [pulumi schema check](/docs/cli/commands/pulumi_schema_check/) - Check a Pulumi package schema for errors -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_schema_check.md b/content/docs/cli/commands/pulumi_schema_check.md index 9867a6764f37..64000d851efe 100644 --- a/content/docs/cli/commands/pulumi_schema_check.md +++ b/content/docs/cli/commands/pulumi_schema_check.md @@ -47,4 +47,4 @@ pulumi schema check [flags] * [pulumi schema](/docs/cli/commands/pulumi_schema/) - Analyze package schemas -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack.md b/content/docs/cli/commands/pulumi_stack.md index 817de64f9002..09bbfd251d49 100644 --- a/content/docs/cli/commands/pulumi_stack.md +++ b/content/docs/cli/commands/pulumi_stack.md @@ -66,4 +66,4 @@ pulumi stack [flags] * [pulumi stack tag](/docs/cli/commands/pulumi_stack_tag/) - Manage stack tags * [pulumi stack unselect](/docs/cli/commands/pulumi_stack_unselect/) - Resets stack selection from the current workspace -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_change-secrets-provider.md b/content/docs/cli/commands/pulumi_stack_change-secrets-provider.md index 2fe837caaa67..8cf247810420 100644 --- a/content/docs/cli/commands/pulumi_stack_change-secrets-provider.md +++ b/content/docs/cli/commands/pulumi_stack_change-secrets-provider.md @@ -56,4 +56,4 @@ pulumi stack change-secrets-provider [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_export.md b/content/docs/cli/commands/pulumi_stack_export.md index 6df5b1e00740..52fdd6dc9887 100644 --- a/content/docs/cli/commands/pulumi_stack_export.md +++ b/content/docs/cli/commands/pulumi_stack_export.md @@ -52,4 +52,4 @@ pulumi stack export [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_graph.md b/content/docs/cli/commands/pulumi_stack_graph.md index 89b85ba0ac04..16a8d9838e84 100644 --- a/content/docs/cli/commands/pulumi_stack_graph.md +++ b/content/docs/cli/commands/pulumi_stack_graph.md @@ -54,4 +54,4 @@ pulumi stack graph [filename] [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_history.md b/content/docs/cli/commands/pulumi_stack_history.md index e115921dd789..bb2de0a6f9ad 100644 --- a/content/docs/cli/commands/pulumi_stack_history.md +++ b/content/docs/cli/commands/pulumi_stack_history.md @@ -51,4 +51,4 @@ pulumi stack history [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_import.md b/content/docs/cli/commands/pulumi_stack_import.md index d25f0e8879a7..44252fcdec00 100644 --- a/content/docs/cli/commands/pulumi_stack_import.md +++ b/content/docs/cli/commands/pulumi_stack_import.md @@ -51,4 +51,4 @@ pulumi stack import [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_init.md b/content/docs/cli/commands/pulumi_stack_init.md index 3f74f37dc27b..28fd26e1d32f 100644 --- a/content/docs/cli/commands/pulumi_stack_init.md +++ b/content/docs/cli/commands/pulumi_stack_init.md @@ -76,4 +76,4 @@ pulumi stack init [/] [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_ls.md b/content/docs/cli/commands/pulumi_stack_ls.md index 09dd0efa2d04..f1873ba8562e 100644 --- a/content/docs/cli/commands/pulumi_stack_ls.md +++ b/content/docs/cli/commands/pulumi_stack_ls.md @@ -57,4 +57,4 @@ pulumi stack ls [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_output.md b/content/docs/cli/commands/pulumi_stack_output.md index 61f71ff7b78e..aed0658feb5f 100644 --- a/content/docs/cli/commands/pulumi_stack_output.md +++ b/content/docs/cli/commands/pulumi_stack_output.md @@ -50,4 +50,4 @@ pulumi stack output [property-name] [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_rename.md b/content/docs/cli/commands/pulumi_stack_rename.md index 0efaabb916b9..72dec8a047a8 100644 --- a/content/docs/cli/commands/pulumi_stack_rename.md +++ b/content/docs/cli/commands/pulumi_stack_rename.md @@ -52,4 +52,4 @@ pulumi stack rename [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_rm.md b/content/docs/cli/commands/pulumi_stack_rm.md index db8e20f12f3e..1a5a7f6a6876 100644 --- a/content/docs/cli/commands/pulumi_stack_rm.md +++ b/content/docs/cli/commands/pulumi_stack_rm.md @@ -52,4 +52,4 @@ pulumi stack rm [] [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_select.md b/content/docs/cli/commands/pulumi_stack_select.md index 042ed72741e2..114ce102b6be 100644 --- a/content/docs/cli/commands/pulumi_stack_select.md +++ b/content/docs/cli/commands/pulumi_stack_select.md @@ -53,4 +53,4 @@ pulumi stack select [] [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_tag.md b/content/docs/cli/commands/pulumi_stack_tag.md index 09c6a80f9243..c3c59ef7dc0d 100644 --- a/content/docs/cli/commands/pulumi_stack_tag.md +++ b/content/docs/cli/commands/pulumi_stack_tag.md @@ -50,4 +50,4 @@ is updated. * [pulumi stack tag rm](/docs/cli/commands/pulumi_stack_tag_rm/) - Remove a stack tag * [pulumi stack tag set](/docs/cli/commands/pulumi_stack_tag_set/) - Set a stack tag -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_tag_get.md b/content/docs/cli/commands/pulumi_stack_tag_get.md index 52e614012851..b6e7399bb3fe 100644 --- a/content/docs/cli/commands/pulumi_stack_tag_get.md +++ b/content/docs/cli/commands/pulumi_stack_tag_get.md @@ -40,4 +40,4 @@ pulumi stack tag get [flags] * [pulumi stack tag](/docs/cli/commands/pulumi_stack_tag/) - Manage stack tags -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_tag_ls.md b/content/docs/cli/commands/pulumi_stack_tag_ls.md index 14b023992222..9e36dd7ba52e 100644 --- a/content/docs/cli/commands/pulumi_stack_tag_ls.md +++ b/content/docs/cli/commands/pulumi_stack_tag_ls.md @@ -41,4 +41,4 @@ pulumi stack tag ls [flags] * [pulumi stack tag](/docs/cli/commands/pulumi_stack_tag/) - Manage stack tags -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_tag_rm.md b/content/docs/cli/commands/pulumi_stack_tag_rm.md index 1861ed13bf55..24b4ba47879a 100644 --- a/content/docs/cli/commands/pulumi_stack_tag_rm.md +++ b/content/docs/cli/commands/pulumi_stack_tag_rm.md @@ -40,4 +40,4 @@ pulumi stack tag rm [flags] * [pulumi stack tag](/docs/cli/commands/pulumi_stack_tag/) - Manage stack tags -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_tag_set.md b/content/docs/cli/commands/pulumi_stack_tag_set.md index f26d5a8c813e..4b7b775a2067 100644 --- a/content/docs/cli/commands/pulumi_stack_tag_set.md +++ b/content/docs/cli/commands/pulumi_stack_tag_set.md @@ -40,4 +40,4 @@ pulumi stack tag set [flags] * [pulumi stack tag](/docs/cli/commands/pulumi_stack_tag/) - Manage stack tags -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_stack_unselect.md b/content/docs/cli/commands/pulumi_stack_unselect.md index e90faa7f8b4e..3917397b4cf6 100644 --- a/content/docs/cli/commands/pulumi_stack_unselect.md +++ b/content/docs/cli/commands/pulumi_stack_unselect.md @@ -48,4 +48,4 @@ pulumi stack unselect [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_state.md b/content/docs/cli/commands/pulumi_state.md index 55d3dc8accbe..693b7e562770 100644 --- a/content/docs/cli/commands/pulumi_state.md +++ b/content/docs/cli/commands/pulumi_state.md @@ -47,4 +47,4 @@ troubleshooting a stack or when performing specific edits that otherwise would r * [pulumi state unprotect](/docs/cli/commands/pulumi_state_unprotect/) - Unprotect resources in a stack's state * [pulumi state upgrade](/docs/cli/commands/pulumi_state_upgrade/) - Migrates the current backend to the latest supported version -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_state_delete.md b/content/docs/cli/commands/pulumi_state_delete.md index b75e8f35855b..88ef224b4b3a 100644 --- a/content/docs/cli/commands/pulumi_state_delete.md +++ b/content/docs/cli/commands/pulumi_state_delete.md @@ -64,4 +64,4 @@ pulumi state delete 'urn:pulumi:stage::demo::eks:index:Cluster$pulumi:providers: * [pulumi state](/docs/cli/commands/pulumi_state/) - Edit the current stack's state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_state_move.md b/content/docs/cli/commands/pulumi_state_move.md index 7caf9aac4a8e..02741ecc11e7 100644 --- a/content/docs/cli/commands/pulumi_state_move.md +++ b/content/docs/cli/commands/pulumi_state_move.md @@ -51,4 +51,4 @@ pulumi state move [flags] ... * [pulumi state](/docs/cli/commands/pulumi_state/) - Edit the current stack's state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_state_rename.md b/content/docs/cli/commands/pulumi_state_rename.md index b761a4e40be9..1628fd543996 100644 --- a/content/docs/cli/commands/pulumi_state_rename.md +++ b/content/docs/cli/commands/pulumi_state_rename.md @@ -59,4 +59,4 @@ pulumi state rename 'urn:pulumi:stage::demo::eks:index:Cluster$pulumi:providers: * [pulumi state](/docs/cli/commands/pulumi_state/) - Edit the current stack's state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_state_unprotect.md b/content/docs/cli/commands/pulumi_state_unprotect.md index e978ea89875a..0302e44885b6 100644 --- a/content/docs/cli/commands/pulumi_state_unprotect.md +++ b/content/docs/cli/commands/pulumi_state_unprotect.md @@ -50,4 +50,4 @@ pulumi state unprotect [resource URN] [flags] * [pulumi state](/docs/cli/commands/pulumi_state/) - Edit the current stack's state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_state_upgrade.md b/content/docs/cli/commands/pulumi_state_upgrade.md index a20543e42fde..5c87da639e25 100644 --- a/content/docs/cli/commands/pulumi_state_upgrade.md +++ b/content/docs/cli/commands/pulumi_state_upgrade.md @@ -47,4 +47,4 @@ pulumi state upgrade [flags] * [pulumi state](/docs/cli/commands/pulumi_state/) - Edit the current stack's state -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_up.md b/content/docs/cli/commands/pulumi_up.md index 43ce04e89d7f..18ab5117ab0c 100644 --- a/content/docs/cli/commands/pulumi_up.md +++ b/content/docs/cli/commands/pulumi_up.md @@ -83,4 +83,4 @@ pulumi up [template|url] [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_version.md b/content/docs/cli/commands/pulumi_version.md index b502771bf0b0..8dcfa8730583 100644 --- a/content/docs/cli/commands/pulumi_version.md +++ b/content/docs/cli/commands/pulumi_version.md @@ -39,4 +39,4 @@ pulumi version [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_watch.md b/content/docs/cli/commands/pulumi_watch.md index c10a92a1f90e..48c4f4f7b054 100644 --- a/content/docs/cli/commands/pulumi_watch.md +++ b/content/docs/cli/commands/pulumi_watch.md @@ -65,4 +65,4 @@ pulumi watch [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/cli/commands/pulumi_whoami.md b/content/docs/cli/commands/pulumi_whoami.md index 64458ef5e622..e5c1dbf690c2 100644 --- a/content/docs/cli/commands/pulumi_whoami.md +++ b/content/docs/cli/commands/pulumi_whoami.md @@ -46,4 +46,4 @@ pulumi whoami [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 12-Aug-2024 +###### Auto generated by spf13/cobra on 23-Aug-2024 diff --git a/content/docs/install/versions.md b/content/docs/install/versions.md index 9429fa36c448..e372d59c71a3 100644 --- a/content/docs/install/versions.md +++ b/content/docs/install/versions.md @@ -21,6 +21,7 @@ The current stable version of Pulumi is **{{< latest-version >}}**. + {{< changelog-table-row version="3.130.0" date="2024-08-23" showChecksum="true" >}} {{< changelog-table-row version="3.129.0" date="2024-08-12" showChecksum="true" >}} {{< changelog-table-row version="3.128.0" date="2024-08-05" showChecksum="true" >}} {{< changelog-table-row version="3.127.0" date="2024-07-25" showChecksum="true" >}} diff --git a/data/versions.json b/data/versions.json index 7610f56cf16a..dea767e2f685 100644 --- a/data/versions.json +++ b/data/versions.json @@ -1,4 +1,17 @@ [ + { + "version": "v3.130.0", + "date": "2024-08-23T15:23:53Z", + "downloads": { + "linux-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.130.0-linux-x64.tar.gz", + "linux-arm64": "https://get.pulumi.com/releases/sdk/pulumi-v3.130.0-linux-arm64.tar.gz", + "darwin-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.130.0-darwin-x64.tar.gz", + "darwin-arm64": "https://get.pulumi.com/releases/sdk/pulumi-v3.130.0-darwin-arm64.tar.gz", + "windows-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.130.0-windows-x64.zip" + }, + "checksums": "https://get.pulumi.com/releases/sdk/pulumi-3.130.0-checksums.txt", + "latest": true + }, { "version": "v3.129.0", "date": "2024-08-12T14:46:41Z", @@ -9,8 +22,7 @@ "darwin-arm64": "https://get.pulumi.com/releases/sdk/pulumi-v3.129.0-darwin-arm64.tar.gz", "windows-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.129.0-windows-x64.zip" }, - "checksums": "https://get.pulumi.com/releases/sdk/pulumi-3.129.0-checksums.txt", - "latest": true + "checksums": "https://get.pulumi.com/releases/sdk/pulumi-3.129.0-checksums.txt" }, { "version": "v3.128.0", diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ComponentResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ComponentResource.html index c027850af572..5841b54ec806 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ComponentResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ComponentResource.html @@ -2,7 +2,7 @@ child resources into a higher level abstraction. The component resource itself is a resource, but does not require custom CRUD operations for provisioning.

-

Type Parameters

  • TData = any

Hierarchy (view full)

Constructors

constructor +

Type Parameters

  • TData = any

Hierarchy (view full)

Constructors

constructor

Properties

urn

Methods

getData getProvider @@ -20,22 +20,22 @@
  • args: Inputs = {}

    Information passed to [initialize] method.

  • opts: ComponentResourceOptions = {}

    A bag of options that control this resource's behavior.

  • remote: boolean = false

    True if this is a remote component resource.

    -
  • Optional packageRef: Promise<undefined | string>

    • Returns ComponentResource<TData>

    Properties

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before +

  • Optional packageRef: Promise<undefined | string>

    • Returns ComponentResource<TData>

    Properties

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before and after deployments.

    -

    Methods

    Protected getData

    Methods

    Protected getData

    getProvider

    Protected initialize

    getProvider

    Protected initialize

    • initialize(args): Promise<TData>

    • Can be overridden by a subclass to asynchronously initialize data for this component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use getData.

      -

      Parameters

      Returns Promise<TData>

    Protected registerOutputs

    Protected registerOutputs

    • registerOutputs(outputs?): void

    • Registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

      Component resources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.

      -

      Parameters

      Returns void

    Static isInstance

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorurngetDatagetProviderinitializeregisterOutputsisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is ComponentResource<any>

    Settings

    Member Visibility

    Theme

    On This Page

    constructorurngetDatagetProviderinitializeregisterOutputsisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/Config.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/Config.html index fa02b50242fd..34244f6431d8 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/Config.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/Config.html @@ -3,7 +3,7 @@ variables that otherwise share the same key. For example, a bag whose name is pulumi:foo, with keys a, b, and c, is entirely separate from a bag whose name is pulumi:bar with the same simple key names. Each key has a fully qualified names, such as pulumi:foo:a, ..., and pulumi:bar:a, respectively.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    name

    Methods

    get getBoolean @@ -21,64 +21,64 @@ requireSecretBoolean requireSecretNumber requireSecretObject -

    Constructors

    constructor

    Properties

    Readonly name

    name: string

    name is the configuration bag's logical name and uniquely identifies it. The default is the name of the current +

    Constructors

    constructor

    Properties

    Readonly name

    name: string

    name is the configuration bag's logical name and uniquely identifies it. The default is the name of the current project.

    -

    Methods

    get

    • get<K>(key, opts?): undefined | K

    • get loads an optional configuration value by its key, or undefined if it doesn't exist.

      +

    Methods

    get

    • get<K>(key, opts?): undefined | K

    • get loads an optional configuration value by its key, or undefined if it doesn't exist.

      Type Parameters

      • K extends string = string

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: StringConfigOptions<K>

        An options bag to constrain legal values.

        -

      Returns undefined | K

    getBoolean

    • getBoolean(key): undefined | boolean

    • getBoolean loads an optional configuration value, as a boolean, by its key, or undefined if it doesn't exist. +

    Returns undefined | K

    getBoolean

    • getBoolean(key): undefined | boolean

    • getBoolean loads an optional configuration value, as a boolean, by its key, or undefined if it doesn't exist. If the configuration value isn't a legal boolean, this function will throw an error.

      Parameters

      • key: string

        The key to lookup.

        -

      Returns undefined | boolean

    getNumber

    • getNumber(key, opts?): undefined | number

    • getNumber loads an optional configuration value, as a number, by its key, or undefined if it doesn't exist. +

    Returns undefined | boolean

    getNumber

    • getNumber(key, opts?): undefined | number

    • getNumber loads an optional configuration value, as a number, by its key, or undefined if it doesn't exist. If the configuration value isn't a legal number, this function will throw an error.

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: NumberConfigOptions

        An options bag to constrain legal values.

        -

      Returns undefined | number

    getObject

    • getObject<T>(key): undefined | T

    • getObject loads an optional configuration value, as an object, by its key, or undefined if it doesn't exist. +

    Returns undefined | number

    getObject

    • getObject<T>(key): undefined | T

    • getObject loads an optional configuration value, as an object, by its key, or undefined if it doesn't exist. This routine simply JSON parses and doesn't validate the shape of the contents.

      Type Parameters

      • T

      Parameters

      • key: string

        The key to lookup.

        -

      Returns undefined | T

    getSecret

    • getSecret<K>(key, opts?): undefined | Output<K>

    • getSecret loads an optional configuration value by its key, marking it as a secret, or undefined if it +

    Returns undefined | T

    getSecret

    • getSecret<K>(key, opts?): undefined | Output<K>

    • getSecret loads an optional configuration value by its key, marking it as a secret, or undefined if it doesn't exist.

      Type Parameters

      • K extends string = string

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: StringConfigOptions<K>

        An options bag to constrain legal values.

        -

      Returns undefined | Output<K>

    getSecretBoolean

    • getSecretBoolean(key): undefined | OutputInstance<boolean>

    • getSecretBoolean loads an optional configuration value, as a boolean, by its key, making it as a secret +

    Returns undefined | Output<K>

    getSecretBoolean

    • getSecretBoolean(key): undefined | OutputInstance<boolean>

    • getSecretBoolean loads an optional configuration value, as a boolean, by its key, making it as a secret or undefined if it doesn't exist. If the configuration value isn't a legal boolean, this function will throw an error.

      Parameters

      • key: string

        The key to lookup.

        -

      Returns undefined | OutputInstance<boolean>

    getSecretNumber

    • getSecretNumber(key, opts?): undefined | OutputInstance<number>

    • getSecretNumber loads an optional configuration value, as a number, by its key, marking it as a secret +

    Returns undefined | OutputInstance<boolean>

    getSecretNumber

    • getSecretNumber(key, opts?): undefined | OutputInstance<number>

    • getSecretNumber loads an optional configuration value, as a number, by its key, marking it as a secret or undefined if it doesn't exist. If the configuration value isn't a legal number, this function will throw an error.

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: NumberConfigOptions

        An options bag to constrain legal values.

        -

      Returns undefined | OutputInstance<number>

    getSecretObject

    • getSecretObject<T>(key): undefined | Output<T>

    • getSecretObject loads an optional configuration value, as an object, by its key, marking it as a secret +

    Returns undefined | OutputInstance<number>

    getSecretObject

    • getSecretObject<T>(key): undefined | Output<T>

    • getSecretObject loads an optional configuration value, as an object, by its key, marking it as a secret or undefined if it doesn't exist. This routine simply JSON parses and doesn't validate the shape of the contents.

      Type Parameters

      • T

      Parameters

      • key: string

        The key to lookup.

        -

      Returns undefined | Output<T>

    require

    • require<K>(key, opts?): K

    • require loads a configuration value by its given key. If it doesn't exist, an error is thrown.

      +

    Returns undefined | Output<T>

    require

    • require<K>(key, opts?): K

    • require loads a configuration value by its given key. If it doesn't exist, an error is thrown.

      Type Parameters

      • K extends string = string

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: StringConfigOptions<K>

        An options bag to constrain legal values.

        -

      Returns K

    requireBoolean

    • requireBoolean(key): boolean

    • requireBoolean loads a configuration value, as a boolean, by its given key. If it doesn't exist, or the +

    Returns K

    requireBoolean

    • requireBoolean(key): boolean

    • requireBoolean loads a configuration value, as a boolean, by its given key. If it doesn't exist, or the configuration value is not a legal boolean, an error is thrown.

      Parameters

      • key: string

        The key to lookup.

        -

      Returns boolean

    requireNumber

    • requireNumber(key, opts?): number

    • requireNumber loads a configuration value, as a number, by its given key. If it doesn't exist, or the +

    Returns boolean

    requireNumber

    • requireNumber(key, opts?): number

    • requireNumber loads a configuration value, as a number, by its given key. If it doesn't exist, or the configuration value is not a legal number, an error is thrown.

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: NumberConfigOptions

        An options bag to constrain legal values.

        -

      Returns number

    requireObject

    • requireObject<T>(key): T

    • requireObject loads a configuration value as a JSON string and deserializes the JSON into a JavaScript object. If +

    Returns number

    requireObject

    • requireObject<T>(key): T

    • requireObject loads a configuration value as a JSON string and deserializes the JSON into a JavaScript object. If it doesn't exist, or the configuration value is not a legal JSON string, an error is thrown.

      Type Parameters

      • T

      Parameters

      • key: string

        The key to lookup.

        -

      Returns T

    requireSecret

    • requireSecret<K>(key, opts?): Output<K>

    • require loads a configuration value by its given key, marking it as a secret. If it doesn't exist, an error +

    Returns T

    requireSecret

    • requireSecret<K>(key, opts?): Output<K>

    • require loads a configuration value by its given key, marking it as a secret. If it doesn't exist, an error is thrown.

      Type Parameters

      • K extends string = string

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: StringConfigOptions<K>

        An options bag to constrain legal values.

        -

      Returns Output<K>

    requireSecretBoolean

    • requireSecretBoolean(key): OutputInstance<boolean>

    • requireSecretBoolean loads a configuration value, as a boolean, by its given key, marking it as a secret. +

    Returns Output<K>

    requireSecretBoolean

    • requireSecretBoolean(key): OutputInstance<boolean>

    • requireSecretBoolean loads a configuration value, as a boolean, by its given key, marking it as a secret. If it doesn't exist, or the configuration value is not a legal boolean, an error is thrown.

      Parameters

      • key: string

        The key to lookup.

        -

      Returns OutputInstance<boolean>

    requireSecretNumber

    • requireSecretNumber(key, opts?): OutputInstance<number>

    • requireSecretNumber loads a configuration value, as a number, by its given key, marking it as a secret. +

    Returns OutputInstance<boolean>

    requireSecretNumber

    • requireSecretNumber(key, opts?): OutputInstance<number>

    • requireSecretNumber loads a configuration value, as a number, by its given key, marking it as a secret. If it doesn't exist, or the configuration value is not a legal number, an error is thrown.

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: NumberConfigOptions

        An options bag to constrain legal values.

        -

      Returns OutputInstance<number>

    requireSecretObject

    • requireSecretObject<T>(key): Output<T>

    • requireSecretObject loads a configuration value as a JSON string and deserializes the JSON into a JavaScript +

    Returns OutputInstance<number>

    requireSecretObject

    • requireSecretObject<T>(key): Output<T>

    • requireSecretObject loads a configuration value as a JSON string and deserializes the JSON into a JavaScript object, marking it as a secret. If it doesn't exist, or the configuration value is not a legal JSON string, an error is thrown.

      Type Parameters

      • T

      Parameters

      • key: string

        The key to lookup.

        -

      Returns Output<T>

    Settings

    Member Visibility

    Theme

    On This Page

    constructornamegetgetBooleangetNumbergetObjectgetSecretgetSecretBooleangetSecretNumbergetSecretObjectrequirerequireBooleanrequireNumberrequireObjectrequireSecretrequireSecretBooleanrequireSecretNumberrequireSecretObject

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Output<T>

    Settings

    Member Visibility

    Theme

    On This Page

    constructornamegetgetBooleangetNumbergetObjectgetSecretgetSecretBooleangetSecretNumbergetSecretObjectrequirerequireBooleanrequireNumberrequireObjectrequireSecretrequireSecretBooleanrequireSecretNumberrequireSecretObject

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/CustomResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/CustomResource.html index dacdbc448ddf..a4be8d1945db 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/CustomResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/CustomResource.html @@ -3,7 +3,7 @@ physical entity. The engine understands how to diff and perform partial updates of them, and these CRUD operations are implemented in a dynamically loaded plugin for the defining package.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    id urn

    Methods

    getProvider @@ -21,12 +21,12 @@
  • Optional props: Inputs

    The arguments to use to populate the new resource.

  • opts: CustomResourceOptions = {}

    A bag of options that control this resource's behavior.

  • dependency: boolean = false

    True if this is a synthetic resource used internally for dependency tracking.

    -
  • Optional packageRef: Promise<undefined | string>

    • Returns CustomResource

    Properties

    Readonly id

    id: Output<string>

    The provider-assigned unique ID for this managed resource. It is set +

  • Optional packageRef: Promise<undefined | string>

    • Returns CustomResource

    Properties

    Readonly id

    id: Output<string>

    The provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

    -

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before +

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before and after deployments.

    -

    Methods

    getProvider

    Static isInstance

    Methods

    getProvider

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is CustomResource

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/DependencyProviderResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/DependencyProviderResource.html index ae1c05cee992..72806c1b699e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/DependencyProviderResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/DependencyProviderResource.html @@ -1,18 +1,18 @@ DependencyProviderResource | @pulumi/pulumi

    Class DependencyProviderResource

    A DependencyProviderResource is a resource that is used by the provider SDK as a stand-in for a provider that is only used for its reference. Its only valid properties are its URN and ID.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    id urn

    Methods

    getProvider isInstance register -

    Constructors

    constructor

    Properties

    Readonly id

    id: Output<string>

    The provider-assigned unique ID for this managed resource. It is set +

    Constructors

    constructor

    Properties

    Readonly id

    id: Output<string>

    The provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

    -

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before +

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before and after deployments.

    -

    Methods

    getProvider

    Static isInstance

    Methods

    getProvider

    Static isInstance

    Static register

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstanceregister

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is CustomResource

    Static register

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstanceregister

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/DependencyResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/DependencyResource.html index ffef56dbacfa..fcf26d17b27d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/DependencyResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/DependencyResource.html @@ -1,17 +1,17 @@ DependencyResource | @pulumi/pulumi

    Class DependencyResource

    A DependencyResource is a resource that is used to indicate that an Output has a dependency on a particular resource. These resources are only created when dealing with remote component resources.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    id urn

    Methods

    getProvider isInstance -

    Constructors

    constructor

    Properties

    Readonly id

    id: Output<string>

    The provider-assigned unique ID for this managed resource. It is set +

    Constructors

    constructor

    Properties

    Readonly id

    id: Output<string>

    The provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

    -

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before +

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before and after deployments.

    -

    Methods

    getProvider

    Static isInstance

    Methods

    getProvider

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is CustomResource

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ProviderResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ProviderResource.html index 1429ef1d68ba..ecf5840017e9 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ProviderResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ProviderResource.html @@ -1,7 +1,7 @@ ProviderResource | @pulumi/pulumi

    Class ProviderResourceAbstract

    ProviderResource is a resource that implements CRUD operations for other custom resources. These resources are managed similarly to other resources, including the usual diffing and update semantics.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    id urn

    Methods

    getProvider @@ -13,12 +13,12 @@
  • Optional props: Inputs

    The configuration to use for this provider.

  • opts: ResourceOptions = {}

    A bag of options that control this provider's behavior.

  • dependency: boolean = false

    True if this is a synthetic resource used internally for dependency tracking.

    -
  • Optional packageRef: Promise<undefined | string>

    • Returns ProviderResource

    Properties

    Readonly id

    id: Output<string>

    The provider-assigned unique ID for this managed resource. It is set +

  • Optional packageRef: Promise<undefined | string>

    • Returns ProviderResource

    Properties

    Readonly id

    id: Output<string>

    The provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

    -

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before +

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before and after deployments.

    -

    Methods

    getProvider

    Static isInstance

    Methods

    getProvider

    Static isInstance

    Static register

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstanceregister

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is CustomResource

    Static register

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstanceregister

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/Resource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/Resource.html index c6720c114ea5..b13230bb00a3 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/Resource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/Resource.html @@ -1,6 +1,6 @@ Resource | @pulumi/pulumi

    Class ResourceAbstract

    Resource represents a class whose CRUD operations are implemented by a provider plugin.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    urn

    Methods

    getProvider isInstance @@ -16,7 +16,7 @@
  • opts: ResourceOptions = {}

    A bag of options that control this resource's behavior.

  • remote: boolean = false

    True if this is a remote component resource.

  • dependency: boolean = false

    True if this is a synthetic resource used internally for dependency tracking.

    -
  • Optional packageRef: Promise<undefined | string>

    • Returns Resource

    Properties

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before +

  • Optional packageRef: Promise<undefined | string>

    • Returns Resource

    Properties

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before and after deployments.

    -

    Methods

    getProvider

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    getProvider

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ResourceError.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ResourceError.html index 3b155c1b8236..69086b63e1d8 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ResourceError.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ResourceError.html @@ -3,11 +3,11 @@ 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.

    -

    Hierarchy

    • Error
      • ResourceError

    Constructors

    constructor +

    Hierarchy

    • Error
      • ResourceError

    Constructors

    constructor

    Properties

    hideStack? resource

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Optional hideStack

    hideStack?: boolean

    resource

    resource: undefined | Resource

    Methods

    Static isInstance

    Constructors

    constructor

    Properties

    Optional hideStack

    hideStack?: boolean

    resource

    resource: undefined | Resource

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorhideStackresourceisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is ResourceError

    Settings

    Member Visibility

    Theme

    On This Page

    constructorhideStackresourceisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/RunError.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/RunError.html index daa7d84acdd5..5949d05fc0a0 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/RunError.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/RunError.html @@ -3,9 +3,9 @@ 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.

    -

    Hierarchy

    • Error
      • RunError

    Constructors

    constructor +

    Hierarchy

    • Error
      • RunError

    Constructors

    constructor

    Methods

    isInstance

    Constructors

    constructor

    • new RunError(message?): RunError

    • Parameters

      • Optional message: string

      Returns RunError

    Methods

    Static isInstance

    • isInstance(obj): obj is RunError

    • Returns true if the given object is a RunError. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

      -

      Parameters

      • obj: any

      Returns obj is RunError

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is RunError

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/StackReference.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/StackReference.html index 20ec6dd5c1e3..17ee7fb32a70 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/StackReference.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/StackReference.html @@ -1,7 +1,7 @@ StackReference | @pulumi/pulumi

    Class StackReference

    Manages a reference to a Pulumi stack. The referenced stack's outputs are available via the StackReference.outputs property or the StackReference.output method.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    id name outputs @@ -21,37 +21,37 @@

    Parameters

    • name: string

      The unique name of the stack reference.

    • Optional args: StackReferenceArgs

      The arguments to use to populate this resource's properties.

    • Optional opts: CustomResourceOptions

      A bag of options that control this resource's behavior.

      -

    Returns StackReference

    Properties

    Readonly id

    id: Output<string>

    The provider-assigned unique ID for this managed resource. It is set +

    Returns StackReference

    Properties

    Readonly id

    id: Output<string>

    The provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

    -

    Readonly name

    name: Output<string>

    The name of the referenced stack.

    -

    Readonly outputs

    outputs: Output<{
        [name: string]: any;
    }>

    The outputs of the referenced stack.

    -

    Type declaration

    • [name: string]: any

    Readonly secretOutputNames

    secretOutputNames: Output<string[]>

    The names of any stack outputs which contain secrets.

    -

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before +

    Readonly name

    name: Output<string>

    The name of the referenced stack.

    +

    Readonly outputs

    outputs: Output<{
        [name: string]: any;
    }>

    The outputs of the referenced stack.

    +

    Type declaration

    • [name: string]: any

    Readonly secretOutputNames

    secretOutputNames: Output<string[]>

    The names of any stack outputs which contain secrets.

    +

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before and after deployments.

    -

    Methods

    getOutput

    Methods

    getOutput

    getOutputDetails

    Returns Output<any>

    getOutputDetails

    getOutputValue

    • getOutputValue(name): Promise<any>

    • Fetches the value promptly of the named stack output. May return +

    Returns Promise<StackReferenceOutputDetails>

    getOutputValue

    • getOutputValue(name): Promise<any>

    • Fetches the value promptly of the named stack output. May return undefined if the value is not known for some reason.

      This operation is not supported (and will throw) if the named stack output is a secret.

      Parameters

      • name: string

        The name of the stack output to fetch.

        -

      Returns Promise<any>

    getProvider

    requireOutput

    • requireOutput(name): Output<any>

    • Fetches the value of the named stack output, or throws an error if the +

    Returns Promise<any>

    getProvider

    requireOutput

    requireOutputValue

    • requireOutputValue(name): Promise<any>

    • Fetches the value promptly of the named stack output. Throws an error if +

    Returns Output<any>

    requireOutputValue

    • requireOutputValue(name): Promise<any>

    • Fetches the value promptly of the named stack output. Throws an error if the stack output is not found.

      This operation is not supported (and will throw) if the named stack output is a secret.

      Parameters

      • name: string

        The name of the stack output to fetch.

        -

      Returns Promise<any>

    Static isInstance

    Returns Promise<any>

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridnameoutputssecretOutputNamesurngetOutputgetOutputDetailsgetOutputValuegetProviderrequireOutputrequireOutputValueisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is CustomResource

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridnameoutputssecretOutputNamesurngetOutputgetOutputDetailsgetOutputValuegetProviderrequireOutputrequireOutputValueisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.Archive.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.Archive.html index 0f1351bf4fec..546dbfa6e38e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.Archive.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.Archive.html @@ -1,7 +1,7 @@ Archive | @pulumi/pulumi

    Class ArchiveAbstract

    An Archive represents a collection of named assets.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Methods

    isInstance

    Constructors

    constructor

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Archive

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.Asset.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.Asset.html index b471c9eb4d72..931af702278a 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.Asset.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.Asset.html @@ -1,8 +1,8 @@ Asset | @pulumi/pulumi

    Class AssetAbstract

    Asset represents a single blob of text or data that is managed as a first-class entity.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Methods

    isInstance

    Constructors

    constructor

    Methods

    Static isInstance

    • isInstance(obj): obj is Asset

    • Returns true if the given object is an Asset. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

      -

      Parameters

      • obj: any

      Returns obj is Asset

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Asset

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.AssetArchive.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.AssetArchive.html index b71b4155aa79..301a6910f809 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.AssetArchive.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.AssetArchive.html @@ -1,10 +1,10 @@ AssetArchive | @pulumi/pulumi

    Class AssetArchive

    An AssetArchive is an archive created from an in-memory collection of named assets or other archives.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    assets

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Readonly assets

    assets: Promise<AssetMap>

    A map of names to assets.

    -

    Methods

    Static isInstance

    • isInstance(obj): obj is Archive

    • Returns true if the given object is an Archive. This is designed +

    Constructors

    constructor

    Properties

    Readonly assets

    assets: Promise<AssetMap>

    A map of names to assets.

    +

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorassetsisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Archive

    Settings

    Member Visibility

    Theme

    On This Page

    constructorassetsisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.FileArchive.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.FileArchive.html index 0e9c0c3b04f3..caea9a696fc8 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.FileArchive.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.FileArchive.html @@ -1,11 +1,11 @@ FileArchive | @pulumi/pulumi

    Class FileArchive

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    path

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Readonly path

    path: Promise<string>

    The path to the asset file.

    -

    Methods

    Static isInstance

    • isInstance(obj): obj is Archive

    • Returns true if the given object is an Archive. This is designed +

    Constructors

    constructor

    Properties

    Readonly path

    path: Promise<string>

    The path to the asset file.

    +

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpathisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Archive

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpathisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.FileAsset.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.FileAsset.html index a4a533e6a44c..880e4fb282a7 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.FileAsset.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.FileAsset.html @@ -1,10 +1,10 @@ FileAsset | @pulumi/pulumi

    Class FileAsset

    FileAsset is a kind of asset produced from a given path to a file on the local filesystem.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    path

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Readonly path

    path: Promise<string>

    The path to the asset file.

    -

    Methods

    Static isInstance

    • isInstance(obj): obj is Asset

    • Returns true if the given object is an Asset. This is designed to +

    Constructors

    constructor

    Properties

    Readonly path

    path: Promise<string>

    The path to the asset file.

    +

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpathisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Asset

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpathisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteArchive.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteArchive.html index 29b8bc1424ff..ab9ddae5e68a 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteArchive.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteArchive.html @@ -3,11 +3,11 @@ 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.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    uri

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Readonly uri

    uri: Promise<string>

    The URI where the archive lives.

    -

    Methods

    Static isInstance

    • isInstance(obj): obj is Archive

    • Returns true if the given object is an Archive. This is designed +

    Constructors

    constructor

    Properties

    Readonly uri

    uri: Promise<string>

    The URI where the archive lives.

    +

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoruriisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Archive

    Settings

    Member Visibility

    Theme

    On This Page

    constructoruriisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteAsset.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteAsset.html index a5fef7593fc6..83b2d00a955a 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteAsset.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteAsset.html @@ -3,11 +3,11 @@ 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.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    uri

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Readonly uri

    uri: Promise<string>

    The URI where the asset lives.

    -

    Methods

    Static isInstance

    • isInstance(obj): obj is Asset

    • Returns true if the given object is an Asset. This is designed to +

    Constructors

    constructor

    Properties

    Readonly uri

    uri: Promise<string>

    The URI where the asset lives.

    +

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoruriisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Asset

    Settings

    Member Visibility

    Theme

    On This Page

    constructoruriisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.StringAsset.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.StringAsset.html index 9ada78a75967..8bb00b30728c 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.StringAsset.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.StringAsset.html @@ -1,10 +1,10 @@ StringAsset | @pulumi/pulumi

    Class StringAsset

    StringAsset is a kind of asset produced from an in-memory UTF8-encoded string.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    text

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Readonly text

    text: Promise<string>

    The string contents.

    -

    Methods

    Static isInstance

    • isInstance(obj): obj is Asset

    • Returns true if the given object is an Asset. This is designed to +

    Constructors

    constructor

    Properties

    Readonly text

    text: Promise<string>

    The string contents.

    +

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructortextisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Asset

    Settings

    Member Visibility

    Theme

    On This Page

    constructortextisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.CommandError.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.CommandError.html index 25a715cb9be2..c5d99869b3db 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.CommandError.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.CommandError.html @@ -1,2 +1,2 @@ CommandError | @pulumi/pulumi

    Class CommandErrorAlpha

    An error resulting from the invocation of a Pulumi command.

    -

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.ConcurrentUpdateError.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.ConcurrentUpdateError.html index 76e39849e350..a5dd822d0dd3 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.ConcurrentUpdateError.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.ConcurrentUpdateError.html @@ -1,3 +1,3 @@ ConcurrentUpdateError | @pulumi/pulumi

    Class ConcurrentUpdateError

    An error thrown when attempting to update a stack that is already being updated.

    -

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.LocalWorkspace.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.LocalWorkspace.html index 6d2a21db34bc..980a1ef25f33 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.LocalWorkspace.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.LocalWorkspace.html @@ -10,7 +10,7 @@ file, and setting config on a Stack will modify the relevant Pulumi.<stack>.yaml file. This is identical to the behavior of Pulumi CLI driven workspaces.

    -

    Implements

    Properties

    envVars +

    Implements

    Properties

    envVars program? pulumiHome? secretsProvider? @@ -55,152 +55,152 @@ createStack selectStack

    Properties

    envVars

    envVars: {
        [key: string]: string;
    }

    Environment values scoped to the current workspace. These will be supplied to every Pulumi command.

    -

    Type declaration

    • [key: string]: string

    Optional program

    program?: PulumiFn

    The inline program PulumiFn to be used for preview/update +

    Type declaration

    • [key: string]: string

    Optional program

    program?: PulumiFn

    The inline program PulumiFn to be used for preview/update operations if any. If none is specified, the stack will refer to ProjectSettings for this information.

    -

    Optional Readonly pulumiHome

    pulumiHome?: string

    The directory override for CLI metadata if set. This customizes the +

    Optional Readonly pulumiHome

    pulumiHome?: string

    The directory override for CLI metadata if set. This customizes the location of $PULUMI_HOME where metadata is stored and plugins are installed.

    -

    Optional Readonly secretsProvider

    secretsProvider?: string

    The secrets provider to use for encryption and decryption of stack secrets. +

    Optional Readonly secretsProvider

    secretsProvider?: string

    The secrets provider to use for encryption and decryption of stack secrets. See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providers

    -

    Readonly workDir

    workDir: string

    The working directory to run Pulumi CLI commands in.

    -

    Accessors

    pulumiCommand

    pulumiVersion

    Readonly workDir

    workDir: string

    The working directory to run Pulumi CLI commands in.

    +

    Accessors

    pulumiCommand

    pulumiVersion

    Methods

    addEnvironments

    Methods

    addEnvironments

    • addEnvironments(stackName, ...environments): Promise<void>

    • Adds environments to the end of a stack's import list. Imported environments are merged in order per the ESC merge rules. The list of environments behaves as if it were the import list in an anonymous environment.

      Parameters

      • stackName: string

        The stack to operate on

      • Rest ...environments: string[]

        The names of the environments to add to the stack's configuration

        -

      Returns Promise<void>

    createStack

    • createStack(stackName): Promise<void>

    • Creates and sets a new stack with the stack name, failing if one already +

    Returns Promise<void>

    createStack

    exportStack

    • exportStack(stackName): Promise<Deployment>

    • Exports the deployment state of the stack. This can be combined with +

    Returns Promise<void>

    exportStack

    getAllConfig

    • getAllConfig(stackName): Promise<ConfigMap>

    • Returns the config map for the specified stack name, scoped to the +

    Returns Promise<Deployment>

    getAllConfig

    getConfig

    • getConfig(stackName, key, path?): Promise<ConfigValue>

    • Returns the value associated with the specified stack name and key, +

    Returns Promise<ConfigMap>

    getConfig

    • getConfig(stackName, key, path?): Promise<ConfigValue>

    • Returns the value associated with the specified stack name and key, scoped to the current workspace. LocalWorkspace reads this config from the matching Pulumi.stack.yaml file.

      Parameters

      • stackName: string

        The stack to read config from

      • key: string

        The key to use for the config lookup

      • Optional path: boolean

        The key contains a path to a property in a map or list to get

        -

      Returns Promise<ConfigValue>

    getTag

    • getTag(stackName, key): Promise<string>

    • Returns the value associated with the specified stack name and key, +

    Returns Promise<ConfigValue>

    getTag

    • getTag(stackName, key): Promise<string>

    • Returns the value associated with the specified stack name and key, scoped to the LocalWorkspace.

      Parameters

      • stackName: string

        The stack to read tag metadata from.

      • key: string

        The key to use for the tag lookup.

        -

      Returns Promise<string>

    importStack

    • importStack(stackName, state): Promise<void>

    • Imports the given deployment state into a pre-existing stack. This can be +

    Returns Promise<string>

    importStack

    installPlugin

    • installPlugin(name, version, kind?): Promise<void>

    • Installs a plugin in the workspace, for example to use cloud providers +

    Returns Promise<void>

    installPlugin

    • installPlugin(name, version, kind?): Promise<void>

    • Installs a plugin in the workspace, for example to use cloud providers like AWS or GCP.

      Parameters

      • name: string

        The name of the plugin.

      • version: string

        The version of the plugin e.g. "v1.0.0".

      • kind: string = "resource"

        The kind of plugin, defaults to "resource"

        -

      Returns Promise<void>

    installPluginFromServer

    • installPluginFromServer(name, version, server): Promise<void>

    • Installs a plugin in the workspace from a third party server.

      +

    Returns Promise<void>

    installPluginFromServer

    • installPluginFromServer(name, version, server): Promise<void>

    • Installs a plugin in the workspace from a third party server.

      Parameters

      • name: string

        The name of the plugin.

      • version: string

        The version of the plugin e.g. "v1.0.0".

      • server: string

        The server to install the plugin from

        -

      Returns Promise<void>

    listEnvironments

    • listEnvironments(stackName): Promise<string[]>

    • Returns the list of environments associated with the specified stack name.

      +

    Returns Promise<void>

    listEnvironments

    listPlugins

    listStacks

    • listStacks(opts?): Promise<StackSummary[]>

    • Returns all stacks from the underlying backend based on the provided +

    Returns Promise<string[]>

    listPlugins

    listStacks

    listTags

    • listTags(stackName): Promise<TagMap>

    • Returns the tag map for the specified stack, scoped to the current +

    Returns Promise<StackSummary[]>

    listTags

    postCommandCallback

    • postCommandCallback(_): Promise<void>

    • A hook executed after every command. Called with the stack name. An +

    Returns Promise<TagMap>

    postCommandCallback

    projectSettings

    projectSettings

    refreshConfig

    refreshConfig

    removeAllConfig

    • removeAllConfig(stackName, keys, path?): Promise<void>

    • Removes all values in the provided key list for the specified stack name +

    Returns Promise<ConfigMap>

    removeAllConfig

    • removeAllConfig(stackName, keys, path?): Promise<void>

    • Removes all values in the provided key list for the specified stack name Will remove any matching values in the Pulumi.<stack>.yaml file in Workspace.WorkDir().

      Parameters

      • stackName: string

        The stack to operate on

      • keys: string[]

        The list of keys to remove from the underlying config

      • Optional path: boolean

        The keys contain a path to a property in a map or list to remove

        -

      Returns Promise<void>

    removeConfig

    • removeConfig(stackName, key, path?): Promise<void>

    • Removes the specified key-value pair on the provided stack name. Will +

    Returns Promise<void>

    removeConfig

    • removeConfig(stackName, key, path?): Promise<void>

    • Removes the specified key-value pair on the provided stack name. Will remove any matching values in the Pulumi.<stack>.yaml file in Workspace.WorkDir().

      Parameters

      • stackName: string

        The stack to operate on

      • key: string

        The config key to remove

      • Optional path: boolean

        The key contains a path to a property in a map or list to remove

        -

      Returns Promise<void>

    removeEnvironment

    • removeEnvironment(stackName, environment): Promise<void>

    • Removes an environment from a stack's import list.

      +

    Returns Promise<void>

    removeEnvironment

    removePlugin

    • removePlugin(name?, versionRange?, kind?): Promise<void>

    • Removes a plugin from the workspace matching the specified name and version.

      +

    Returns Promise<void>

    removePlugin

    • removePlugin(name?, versionRange?, kind?): Promise<void>

    • Removes a plugin from the workspace matching the specified name and version.

      Parameters

      • Optional name: string

        The optional name of the plugin.

      • Optional versionRange: string

        An optional semver range to check when removing plugins matching the given name e.g. "1.0.0", ">1.0.0".

      • kind: string = "resource"

        The kind of plugin, defaults to "resource".

        -

      Returns Promise<void>

    removeStack

    • removeStack(stackName, opts?): Promise<void>

    • Deletes the stack and all associated configuration and history.

      +

    Returns Promise<void>

    removeStack

    removeTag

    • removeTag(stackName, key): Promise<void>

    • Removes the specified key-value pair on the stack with the given name.

      +
    • Optional opts: RemoveOptions

    Returns Promise<void>

    removeTag

    saveProjectSettings

    • saveProjectSettings(settings): Promise<void>

    • Overwrites the settings object in the current project. There can only be +

    Returns Promise<void>

    saveProjectSettings

    saveStackSettings

    • saveStackSettings(stackName, settings): Promise<void>

    • Overwrites the settings object for the stack matching the specified stack +

    Returns Promise<void>

    saveStackSettings

    selectStack

    • selectStack(stackName): Promise<void>

    • Selects and sets an existing stack matching the stack name, failing if +

    Returns Promise<void>

    selectStack

    serializeArgsForOp

    • serializeArgsForOp(_): Promise<string[]>

    • A hook to provide additional args to every CLI commands before they are +

    Returns Promise<void>

    serializeArgsForOp

    • serializeArgsForOp(_): Promise<string[]>

    • A hook to provide additional args to every CLI commands before they are executed. Provided with stack name, this function returns a list of arguments to append to an invoked command (e.g. ["--config=...", ...]) Presently, LocalWorkspace does not utilize this extensibility point.

      -

      Parameters

      • _: string

      Returns Promise<string[]>

    setAllConfig

    setAllConfig

    • setAllConfig(stackName, config, path?): Promise<void>

    • Sets all values in the provided config map for the specified stack name. LocalWorkspace writes the config to the matching Pulumi.<stack>.yaml file in Workspace.WorkDir().

      Parameters

      • stackName: string

        The stack to operate on

      • config: ConfigMap

        The ConfigMap to upsert against the existing config

      • Optional path: boolean

        The keys contain a path to a property in a map or list to set

        -

      Returns Promise<void>

    setConfig

    • setConfig(stackName, key, value, path?): Promise<void>

    • Sets the specified key-value pair on the provided stack name. LocalWorkspace writes this value to the matching Pulumi.<stack>.yaml +

    Returns Promise<void>

    setConfig

    • setConfig(stackName, key, value, path?): Promise<void>

    • Sets the specified key-value pair on the provided stack name. LocalWorkspace writes this value to the matching Pulumi.<stack>.yaml file in Workspace.WorkDir().

      Parameters

      • stackName: string

        The stack to operate on

      • key: string

        The config key to set

      • value: ConfigValue

        The value to set

      • Optional path: boolean

        The key contains a path to a property in a map or list to set

        -

      Returns Promise<void>

    setTag

    • setTag(stackName, key, value): Promise<void>

    • Sets the specified key-value pair on the stack with the given name.

      +

    Returns Promise<void>

    setTag

    • setTag(stackName, key, value): Promise<void>

    • Sets the specified key-value pair on the stack with the given name.

      Parameters

      • stackName: string

        The stack to operate on.

      • key: string

        The tag key to set.

      • value: string

        The tag value to set.

        -

      Returns Promise<void>

    stack

    stackOutputs

    • stackOutputs(stackName): Promise<OutputMap>

    • Gets the current set of Stack outputs from the last Stack.up.

      +

    Returns Promise<void>

    stack

    stackOutputs

    stackSettings

    • stackSettings(stackName): Promise<StackSettings>

    • Returns the settings object for the stack matching the specified stack +

    Returns Promise<OutputMap>

    stackSettings

    whoAmI

    Static create

    • create(opts): Promise<LocalWorkspace>

    • Creates a workspace using the specified options. Used for maximal control and customization +

    Returns Promise<StackSettings>

    whoAmI

    Static create

    Static createOrSelectStack

    Returns Promise<LocalWorkspace>

    Static createOrSelectStack

    Returns Promise<automation.Stack>

  • createOrSelectStack(args, opts?): Promise<automation.Stack>

  • Creates or selects an existing Stack with a LocalWorkspace utilizing the specified inline Pulumi CLI program. This program is fully debuggable and runs in process. If no Project option is specified, default project settings will be created on behalf of the user. Similarly, unless a workDir option is specified, the working @@ -217,7 +217,7 @@

    Parameters

    • args: InlineProgramArgs

      A set of arguments to initialize a Stack with and inline PulumiFn program that runs in process.

    • Optional opts: LocalWorkspaceOptions

      Additional customizations to be applied to the Workspace.

      -

    Returns Promise<automation.Stack>

    • Static createStack

    Returns Promise<automation.Stack>

    Static createStack

    Returns Promise<automation.Stack>

  • createStack(args, opts?): Promise<automation.Stack>

  • Creates a Stack with a LocalWorkspace utilizing the specified inline (in process) Pulumi program. This program is fully debuggable and runs in process. If no Project option is specified, default project settings will be created on behalf of the user. @@ -234,7 +234,7 @@

    Parameters

    Returns Promise<automation.Stack>

    • Static selectStack

    Returns Promise<automation.Stack>

    Static selectStack

    Returns Promise<automation.Stack>

  • selectStack(args, opts?): Promise<automation.Stack>

  • Selects an existing Stack with a LocalWorkspace utilizing the specified inline (in process) Pulumi program. This program is fully debuggable and runs in process. If no Project option is specified, default project settings will be created on behalf of the user. @@ -251,4 +251,4 @@

    Parameters

    • args: InlineProgramArgs

      A set of arguments to initialize a Stack with and inline PulumiFn program that runs in process.

    • Optional opts: LocalWorkspaceOptions

      Additional customizations to be applied to the Workspace.

      -

    Returns Promise<automation.Stack>

    • Settings

    Member Visibility

    Theme

    On This Page

    envVarsprogrampulumiHomesecretsProviderworkDirpulumiCommandpulumiVersionaddEnvironmentscreateStackexportStackgetAllConfiggetConfiggetTagimportStackinstallPlugininstallPluginFromServerlistEnvironmentslistPluginslistStackslistTagspostCommandCallbackprojectSettingsrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremovePluginremoveStackremoveTagsaveProjectSettingssaveStackSettingsselectStackserializeArgsForOpsetAllConfigsetConfigsetTagstackstackOutputsstackSettingswhoAmIcreatecreateOrSelectStackcreateStackselectStack

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<automation.Stack>

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsprogrampulumiHomesecretsProviderworkDirpulumiCommandpulumiVersionaddEnvironmentscreateStackexportStackgetAllConfiggetConfiggetTagimportStackinstallPlugininstallPluginFromServerlistEnvironmentslistPluginslistStackslistTagspostCommandCallbackprojectSettingsrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremovePluginremoveStackremoveTagsaveProjectSettingssaveStackSettingsselectStackserializeArgsForOpsetAllConfigsetConfigsetTagstackstackOutputsstackSettingswhoAmIcreatecreateOrSelectStackcreateStackselectStack

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.PulumiCommand.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.PulumiCommand.html index 6f339c86d12a..cbc514e7f0f3 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.PulumiCommand.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.PulumiCommand.html @@ -1,8 +1,8 @@ -PulumiCommand | @pulumi/pulumi

    Class PulumiCommand

    Properties

    command +PulumiCommand | @pulumi/pulumi

    Class PulumiCommand

    Properties

    command version

    Methods

    get install -

    Properties

    Readonly command

    command: string

    Readonly version

    version: null | SemVer

    Methods

    Static get

    • get(opts?): Promise<PulumiCommand>

    • Get a new Pulumi instance that uses the installation in opts.root. +

    Properties

    Readonly command

    command: string

    Readonly version

    version: null | SemVer

    Methods

    Static get

    • get(opts?): Promise<PulumiCommand>

    • Get a new Pulumi instance that uses the installation in opts.root. Defaults to using the pulumi binary found in $PATH if no installation root is specified. If opts.version is specified, it validates that the CLI is compatible with the requested version and throws an error if @@ -11,5 +11,5 @@ opts.skipVersionCheck to true. Note that the environment variable always takes precedence. If it is set it is not possible to re-enable the validation with opts.skipVersionCheck.

      -

      Parameters

      Returns Promise<PulumiCommand>

    Static install

    Settings

    Member Visibility

    Theme

    On This Page

    commandversiongetinstall

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<PulumiCommand>

    Static install

    Settings

    Member Visibility

    Theme

    On This Page

    commandversiongetinstall

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.RemoteStack.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.RemoteStack.html index b2a45938c2db..5295fa2cc40d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.RemoteStack.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.RemoteStack.html @@ -1,6 +1,6 @@ RemoteStack | @pulumi/pulumi

    Class RemoteStack

    RemoteStack is an isolated, independently configurable instance of a Pulumi program that is operated on remotely.

    -

    Accessors

    name +

    Accessors

    name

    Methods

    cancel destroy exportStack @@ -11,34 +11,34 @@ refresh up

    Accessors

    name

    Methods

    cancel

    Methods

    cancel

    • cancel(): Promise<void>

    • Stops a stack's currently running update. It returns an error if no update is currently running. Note that this operation is very dangerous, and may leave the stack in an inconsistent state if a resource operation was pending when the update was canceled. This command is not supported for DIY backends.

      -

      Returns Promise<void>

    destroy

    destroy

    exportStack

    • exportStack(): Promise<Deployment>

    • Exports the deployment state of the stack. This can be combined with +

    Returns Promise<DestroyResult>

    exportStack

    history

    history

    importStack

    importStack

    outputs

    preview

    • preview(opts?): Promise<PreviewResult>

    • Performs a dry-run update to a stack, returning pending changes. This +

    Returns Promise<void>

    outputs

    preview

    refresh

    refresh

    up

    • up(opts?): Promise<UpResult>

    • Creates or updates the resources in a stack by executing the program in +

    Returns Promise<RefreshResult>

    up

    Settings

    Member Visibility

    Theme

    On This Page

    namecanceldestroyexportStackhistoryimportStackoutputspreviewrefreshup

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    namecanceldestroyexportStackhistoryimportStackoutputspreviewrefreshup

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.RemoteWorkspace.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.RemoteWorkspace.html index 057a147ee843..5c1943b115a7 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.RemoteWorkspace.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.RemoteWorkspace.html @@ -1,6 +1,6 @@ RemoteWorkspace | @pulumi/pulumi

    Class RemoteWorkspace

    RemoteWorkspace is the execution context containing a single remote Pulumi project.

    -

    Methods

    createOrSelectStack +

    Methods

    createOrSelectStack createStack selectStack

    Methods

    Static createOrSelectStack

    Static createStack

    Returns Promise<RemoteStack>

    Static createStack

    Static selectStack

    Returns Promise<RemoteStack>

    Static selectStack

    Settings

    Member Visibility

    Theme

    On This Page

    createOrSelectStackcreateStackselectStack

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<RemoteStack>

    Settings

    Member Visibility

    Theme

    On This Page

    createOrSelectStackcreateStackselectStack

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.Stack.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.Stack.html index a4f04063a913..1e322dfc2ae3 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.Stack.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.Stack.html @@ -4,7 +4,7 @@ Stacks are commonly used to denote different phases of development (such as development, staging and production) or feature branches (such as feature-x-dev, jane-feature-x-dev).

    -

    Properties

    name +

    Properties

    name workspace

    Methods

    addEnvironments cancel @@ -35,86 +35,86 @@ createOrSelect select

    Properties

    Readonly name

    name: string

    The name identifying the stack.

    -

    Readonly workspace

    workspace: Workspace

    The Workspace the stack was created from.

    -

    Methods

    addEnvironments

    Readonly workspace

    workspace: Workspace

    The Workspace the stack was created from.

    +

    Methods

    addEnvironments

    • addEnvironments(...environments): Promise<void>

    • Adds environments to the end of a stack's import list. Imported environments are merged in order per the ESC merge rules. The list of environments behaves as if it were the import list in an anonymous environment.

      Parameters

      • Rest ...environments: string[]

        The names of the environments to add to the stack's configuration

        -

      Returns Promise<void>

    cancel

    • cancel(): Promise<void>

    • Stops a stack's currently running update. It returns an error if no +

    Returns Promise<void>

    cancel

    • cancel(): Promise<void>

    • Stops a stack's currently running update. It returns an error if no update is currently running. Note that this operation is very dangerous, and may leave the stack in an inconsistent state if a resource operation was pending when the update was canceled. This command is not supported for DIY backends.

      -

      Returns Promise<void>

    destroy

    destroy

    exportStack

    • exportStack(): Promise<Deployment>

    • Exports the deployment state of the stack. This can be combined with +

    Returns Promise<DestroyResult>

    exportStack

    getAllConfig

    getConfig

    getAllConfig

    getConfig

    • getConfig(key, path?): Promise<ConfigValue>

    • Returns the config value associated with the specified key.

      Parameters

      • key: string

        The key to use for the config lookup

      • Optional path: boolean

        The key contains a path to a property in a map or list to get

        -

      Returns Promise<ConfigValue>

    getTag

    • getTag(key): Promise<string>

    • Returns the tag value associated with specified key.

      +

    Returns Promise<ConfigValue>

    getTag

    • getTag(key): Promise<string>

    • Returns the tag value associated with specified key.

      Parameters

      • key: string

        The key to use for the tag lookup.

        -

      Returns Promise<string>

    history

    • history(pageSize?, page?, showSecrets?): Promise<UpdateSummary[]>

    • Returns a list summarizing all previous and current results from Stack +

    Returns Promise<string>

    history

    • history(pageSize?, page?, showSecrets?): Promise<UpdateSummary[]>

    • Returns a list summarizing all previous and current results from Stack lifecycle operations (up/preview/refresh/destroy).

      -

      Parameters

      • Optional pageSize: number
      • Optional page: number
      • Optional showSecrets: boolean

      Returns Promise<UpdateSummary[]>

    import

    import

    importStack

    • importStack(state): Promise<void>

    • Imports the specified deployment state into a pre-existing stack. This +

    Returns Promise<ImportResult>

    importStack

    info

    listEnvironments

    listTags

    outputs

    preview

    • preview(opts?): Promise<PreviewResult>

    • Performs a dry-run update to a stack, returning pending changes.

      +

    Returns Promise<void>

    info

    listEnvironments

    listTags

    outputs

    preview

    refresh

    refresh

    refreshConfig

    removeAllConfig

    • removeAllConfig(keys, path?): Promise<void>

    • Removes the specified config keys from the stack in the associated workspace.

      +

    Returns Promise<RefreshResult>

    refreshConfig

    removeAllConfig

    • removeAllConfig(keys, path?): Promise<void>

    • Removes the specified config keys from the stack in the associated workspace.

      Parameters

      • keys: string[]

        The config keys to remove.

      • Optional path: boolean

        The keys contain a path to a property in a map or list to remove.

        -

      Returns Promise<void>

    removeConfig

    • removeConfig(key, path?): Promise<void>

    • Removes the specified config key from the stack in the associated workspace.

      +

    Returns Promise<void>

    removeConfig

    • removeConfig(key, path?): Promise<void>

    • Removes the specified config key from the stack in the associated workspace.

      Parameters

      • key: string

        The config key to remove.

      • Optional path: boolean

        The key contains a path to a property in a map or list to remove.

        -

      Returns Promise<void>

    removeEnvironment

    • removeEnvironment(environment): Promise<void>

    • Removes an environment from a stack's import list.

      +

    Returns Promise<void>

    removeEnvironment

    • removeEnvironment(environment): Promise<void>

    • Removes an environment from a stack's import list.

      Parameters

      • environment: string

        The name of the environment to remove from the stack's configuration

        -

      Returns Promise<void>

    removeTag

    • removeTag(key): Promise<void>

    • Removes the specified tag key-value pair from the stack in the associated +

    Returns Promise<void>

    removeTag

    • removeTag(key): Promise<void>

    • Removes the specified tag key-value pair from the stack in the associated workspace.

      Parameters

      • key: string

        The tag key to remove.

        -

      Returns Promise<void>

    setAllConfig

    • setAllConfig(config, path?): Promise<void>

    • Sets all specified config values on the stack in the associated +

    Returns Promise<void>

    setAllConfig

    • setAllConfig(config, path?): Promise<void>

    • Sets all specified config values on the stack in the associated workspace.

      Parameters

      • config: ConfigMap

        The map of config key-value pairs to set.

      • Optional path: boolean

        The keys contain a path to a property in a map or list to set.

        -

      Returns Promise<void>

    setConfig

    • setConfig(key, value, path?): Promise<void>

    • Sets a config key-value pair on the stack in the associated Workspace.

      +

    Returns Promise<void>

    setConfig

    • setConfig(key, value, path?): Promise<void>

    • Sets a config key-value pair on the stack in the associated Workspace.

      Parameters

      • key: string

        The key to set.

      • value: ConfigValue

        The config value to set.

      • Optional path: boolean

        The key contains a path to a property in a map or list to set.

        -

      Returns Promise<void>

    setTag

    • setTag(key, value): Promise<void>

    • Sets a tag key-value pair on the stack in the associated workspace.

      +

    Returns Promise<void>

    setTag

    • setTag(key, value): Promise<void>

    • Sets a tag key-value pair on the stack in the associated workspace.

      Parameters

      • key: string

        The tag key to set.

      • value: string

        The tag value to set.

        -

      Returns Promise<void>

    up

    • up(opts?): Promise<UpResult>

    • Creates or updates the resources in a stack by executing the program in +

    Returns Promise<void>

    up

    Static create

    Static create

    Static createOrSelect

    • createOrSelect(name, workspace): Promise<automation.Stack>

    • Creates a new stack using the given workspace and stack name if the stack +

    Returns Promise<automation.Stack>

    Static createOrSelect

    • createOrSelect(name, workspace): Promise<automation.Stack>

    • Creates a new stack using the given workspace and stack name if the stack does not already exist, or falls back to selecting the existing stack. If the stack does not exist, it will be created and selected.

      Parameters

      • name: string

        The name identifying the Stack.

      • workspace: Workspace

        The Workspace the stack will be created from.

        -

      Returns Promise<automation.Stack>

    Static select

    • select(name, workspace): Promise<automation.Stack>

    • Selects stack using the given workspace and stack name. It returns an +

    Returns Promise<automation.Stack>

    Static select

    Settings

    Member Visibility

    Theme

    On This Page

    nameworkspaceaddEnvironmentscanceldestroyexportStackgetAllConfiggetConfiggetTaghistoryimportimportStackinfolistEnvironmentslistTagsoutputspreviewrefreshrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremoveTagsetAllConfigsetConfigsetTagupcreatecreateOrSelectselect

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<automation.Stack>

    Settings

    Member Visibility

    Theme

    On This Page

    nameworkspaceaddEnvironmentscanceldestroyexportStackgetAllConfiggetConfiggetTaghistoryimportimportStackinfolistEnvironmentslistTagsoutputspreviewrefreshrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremoveTagsetAllConfigsetConfigsetTagupcreatecreateOrSelectselect

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.StackAlreadyExistsError.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.StackAlreadyExistsError.html index 253a3ed2d0fd..2e93ab488e9c 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.StackAlreadyExistsError.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.StackAlreadyExistsError.html @@ -1,2 +1,2 @@ StackAlreadyExistsError | @pulumi/pulumi

    Class StackAlreadyExistsError

    An error thrown when attempting to create a stack that already exists.

    -

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.StackNotFoundError.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.StackNotFoundError.html index 5e61b880f105..1b0501c95447 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.StackNotFoundError.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/automation.StackNotFoundError.html @@ -1,2 +1,2 @@ StackNotFoundError | @pulumi/pulumi

    Class StackNotFoundError

    An error thrown when attempting to select a stack that does not exist.

    -

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/dynamic.Resource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/dynamic.Resource.html index 1da89f8b1b11..55038f455707 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/dynamic.Resource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/dynamic.Resource.html @@ -1,6 +1,6 @@ Resource | @pulumi/pulumi

    Class ResourceAbstract

    Resource represents a Pulumi resource that incorporates an inline implementation of the Resource's CRUD operations.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    id urn

    Methods

    getProvider @@ -13,12 +13,12 @@
  • Optional opts: CustomResourceOptions

    A bag of options that control this resource's behavior.

  • Optional module: string

    The module of the resource.

  • type: string = "Resource"

    The type of the resource.

    -

    • Returns dynamic.Resource

    Properties

    Readonly id

    id: Output<string>

    The provider-assigned unique ID for this managed resource. It is set +

    Returns dynamic.Resource

    Properties

    Readonly id

    id: Output<string>

    The provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

    -

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before +

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before and after deployments.

    -

    Methods

    getProvider

    Static isInstance

    Methods

    getProvider

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is CustomResource

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/runtime.Stack.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/runtime.Stack.html index e3ffb28390c8..c6e343799e95 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/runtime.Stack.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/runtime.Stack.html @@ -1,7 +1,7 @@ Stack | @pulumi/pulumi

    Class Stack

    Stack is the root resource for a Pulumi stack. Before invoking the init callback, it registers itself as the root resource with the Pulumi engine.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    outputs urn

    Methods

    getData @@ -9,24 +9,24 @@ initialize registerOutputs isInstance -

    Constructors

    constructor

    Properties

    Readonly outputs

    outputs: Output<Inputs>

    The outputs of this stack, if the init callback exited normally.

    -

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before +

    Constructors

    constructor

    Properties

    Readonly outputs

    outputs: Output<Inputs>

    The outputs of this stack, if the init callback exited normally.

    +

    Readonly urn

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before and after deployments.

    -

    Methods

    Protected getData

    Methods

    Protected getData

    getProvider

    initialize

    getProvider

    initialize

    Protected registerOutputs

    • registerOutputs(outputs?): void

    • Registers synthetic outputs that a component has initialized, usually by +

    Returns Promise<Inputs>

    Protected registerOutputs

    • registerOutputs(outputs?): void

    • Registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

      Component resources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.

      -

      Parameters

      Returns void

    Static isInstance

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoroutputsurngetDatagetProviderinitializeregisterOutputsisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is ComponentResource<any>

    Settings

    Member Visibility

    Theme

    On This Page

    constructoroutputsurngetDatagetProviderinitializeregisterOutputsisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/runtime.StreamInvokeResponse.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/runtime.StreamInvokeResponse.html index 3b448a0c2d77..12c3028961c8 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/runtime.StreamInvokeResponse.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/runtime.StreamInvokeResponse.html @@ -1,7 +1,7 @@ StreamInvokeResponse | @pulumi/pulumi

    Class StreamInvokeResponse<T>

    StreamInvokeResponse represents a (potentially infinite) streaming response to streamInvoke, with facilities to gracefully cancel and clean up the stream.

    -

    Type Parameters

    • T

    Implements

    • AsyncIterable<T>

    Constructors

    constructor +

    Type Parameters

    • T

    Implements

    • AsyncIterable<T>

    Constructors

    constructor

    Methods

    [asyncIterator] cancel -

    Constructors

    constructor

    Methods

    [asyncIterator]

    cancel

    Settings

    Member Visibility

    Theme

    On This Page

    constructor[asyncIterator]cancel

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Methods

    [asyncIterator]

    cancel

    Settings

    Member Visibility

    Theme

    On This Page

    constructor[asyncIterator]cancel

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/enums/automation.DiffKind.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/enums/automation.DiffKind.html index dd993da34bc8..cfad6840c40d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/enums/automation.DiffKind.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/enums/automation.DiffKind.html @@ -1,15 +1,15 @@ DiffKind | @pulumi/pulumi

    Enumeration DiffKind

    A DiffKind describes the kind of difference between two values reported in a diff.

    -

    Enumeration Members

    add +

    Enumeration Members

    add addReplace delete deleteReplace update updateReplace

    Enumeration Members

    add

    add: "add"

    Indicates that the property was added.

    -

    addReplace

    addReplace: "add-replace"

    Indicates that the property was added and requires that the resource be replaced.

    -

    delete

    delete: "delete"

    Indicates that the property was deleted.

    -

    deleteReplace

    deleteReplace: "delete-replace"

    Indicates that the property was deleted and requires that the resource be replaced.

    -

    update

    update: "update"

    Indicates that the property was updated.

    -

    updateReplace

    updateReplace: "update-replace"

    Indicates that the property was updated and requires that the resource be replaced.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    addaddReplacedeletedeleteReplaceupdateupdateReplace

    Generated using TypeDoc

    \ No newline at end of file +

    addReplace

    addReplace: "add-replace"

    Indicates that the property was added and requires that the resource be replaced.

    +

    delete

    delete: "delete"

    Indicates that the property was deleted.

    +

    deleteReplace

    deleteReplace: "delete-replace"

    Indicates that the property was deleted and requires that the resource be replaced.

    +

    update

    update: "update"

    Indicates that the property was updated.

    +

    updateReplace

    updateReplace: "update-replace"

    Indicates that the property was updated and requires that the resource be replaced.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    addaddReplacedeletedeleteReplaceupdateupdateReplace

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/all.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/all.html index 4c7393a54ce3..475611224a29 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/all.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/all.html @@ -6,4 +6,4 @@

    In this example, taking a dependency on d3 means a resource will depend on all the resources of d1 and d2.

    -

    Type Parameters

    • T

    Parameters

    Returns Output<Record<string, Unwrap<T>>>

  • all<T1, T2, T3, T4, T5, T6, T7, T8>(values): Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>, Unwrap<T6>, Unwrap<T7>, Unwrap<T8>]>

  • Type Parameters

    • T1
    • T2
    • T3
    • T4
    • T5
    • T6
    • T7
    • T8

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>, Unwrap<T6>, Unwrap<T7>, Unwrap<T8>]>

  • all<T1, T2, T3, T4, T5, T6, T7>(values): Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>, Unwrap<T6>, Unwrap<T7>]>

  • Type Parameters

    • T1
    • T2
    • T3
    • T4
    • T5
    • T6
    • T7

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>, Unwrap<T6>, Unwrap<T7>]>

  • all<T1, T2, T3, T4, T5, T6>(values): Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>, Unwrap<T6>]>

  • Type Parameters

    • T1
    • T2
    • T3
    • T4
    • T5
    • T6

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>, Unwrap<T6>]>

  • all<T1, T2, T3, T4, T5>(values): Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>]>

  • Type Parameters

    • T1
    • T2
    • T3
    • T4
    • T5

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>]>

  • all<T1, T2, T3, T4>(values): Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>]>

  • Type Parameters

    • T1
    • T2
    • T3
    • T4

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>]>

  • all<T1, T2, T3>(values): Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>]>

  • Type Parameters

    • T1
    • T2
    • T3

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>]>

  • all<T1, T2>(values): Output<[Unwrap<T1>, Unwrap<T2>]>

  • Type Parameters

    • T1
    • T2

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>]>

  • all<T>(ds): Output<Unwrap<T>[]>

  • Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T>[]>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    Returns Output<Record<string, Unwrap<T>>>

  • all<T1, T2, T3, T4, T5, T6, T7, T8>(values): Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>, Unwrap<T6>, Unwrap<T7>, Unwrap<T8>]>

  • Type Parameters

    • T1
    • T2
    • T3
    • T4
    • T5
    • T6
    • T7
    • T8

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>, Unwrap<T6>, Unwrap<T7>, Unwrap<T8>]>

  • all<T1, T2, T3, T4, T5, T6, T7>(values): Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>, Unwrap<T6>, Unwrap<T7>]>

  • Type Parameters

    • T1
    • T2
    • T3
    • T4
    • T5
    • T6
    • T7

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>, Unwrap<T6>, Unwrap<T7>]>

  • all<T1, T2, T3, T4, T5, T6>(values): Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>, Unwrap<T6>]>

  • Type Parameters

    • T1
    • T2
    • T3
    • T4
    • T5
    • T6

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>, Unwrap<T6>]>

  • all<T1, T2, T3, T4, T5>(values): Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>]>

  • Type Parameters

    • T1
    • T2
    • T3
    • T4
    • T5

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>, Unwrap<T5>]>

  • all<T1, T2, T3, T4>(values): Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>]>

  • Type Parameters

    • T1
    • T2
    • T3
    • T4

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>, Unwrap<T4>]>

  • all<T1, T2, T3>(values): Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>]>

  • Type Parameters

    • T1
    • T2
    • T3

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>, Unwrap<T3>]>

  • all<T1, T2>(values): Output<[Unwrap<T1>, Unwrap<T2>]>

  • Type Parameters

    • T1
    • T2

    Parameters

    Returns Output<[Unwrap<T1>, Unwrap<T2>]>

  • all<T>(ds): Output<Unwrap<T>[]>

  • Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T>[]>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/allAliases.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/allAliases.html index 2c6d355e3611..f30f6db6a1d4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/allAliases.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/allAliases.html @@ -4,4 +4,4 @@ the parent. If there are N child aliases, and M parent aliases, there will be (M+1)(N+1)-1 total aliases, or, as calculated in the logic below, N+(M(1+N)).

    -

    Parameters

    • childAliases: Input<string | Alias>[]
    • childName: string
    • childType: string
    • parent: Resource
    • parentName: string

    Returns Output<URN>[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • childAliases: Input<string | Alias>[]
    • childName: string
    • childType: string
    • parent: Resource
    • parentName: string

    Returns Output<URN>[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/automation.fullyQualifiedStackName.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/automation.fullyQualifiedStackName.html index d3d972daf704..f1b8b080700c 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/automation.fullyQualifiedStackName.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/automation.fullyQualifiedStackName.html @@ -10,4 +10,4 @@

    Parameters

    • org: string

      The org (or user) that contains the Stack.

    • project: string

      The project that parents the Stack.

    • stack: string

      The name of the Stack.

      -

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/concat.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/concat.html index 1e3c4e9faee6..e5b386bc39f1 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/concat.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/concat.html @@ -4,4 +4,4 @@ values. Use this function like so:

         // 'server' and 'loadBalancer' are both resources that expose [Output] properties.
         let val: Output<string> = pulumi.concat("http://", server.hostname, ":", loadBalancer.port);
    -

    Parameters

    • Rest ...params: any[]

    Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • Rest ...params: any[]

    Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/containsUnknowns.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/containsUnknowns.html index 70e50b44ebdb..baef858f3051 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/containsUnknowns.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/containsUnknowns.html @@ -1,2 +1,2 @@ containsUnknowns | @pulumi/pulumi

    Function containsUnknowns

    • containsUnknowns(value): boolean

    • Returns true if the given value is or contains unknown values.

      -

      Parameters

      • value: any

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • value: any

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/createUrn.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/createUrn.html index 8a2ad02027dc..cbaf75c65b5e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/createUrn.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/createUrn.html @@ -1,3 +1,3 @@ createUrn | @pulumi/pulumi

    Function createUrn

    • createUrn(name, type, parent?, project?, stack?): Output<string>

    • createUrn computes a URN from the combination of a resource name, resource type, optional parent, optional project and optional stack.

      -

      Parameters

      • name: Input<string>
      • type: Input<string>
      • Optional parent: Resource | Input<string>
      • Optional project: string
      • Optional stack: string

      Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • name: Input<string>
    • type: Input<string>
    • Optional parent: Resource | Input<string>
    • Optional project: string
    • Optional stack: string

    Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getAllResources.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getAllResources.html index fd7d64785a58..ff71be4837d5 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getAllResources.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getAllResources.html @@ -1 +1 @@ -getAllResources | @pulumi/pulumi

    Function getAllResources

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +getAllResources | @pulumi/pulumi

    Function getAllResources

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getOrganization.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getOrganization.html index 782202a02883..668332167e4c 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getOrganization.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getOrganization.html @@ -1,2 +1,2 @@ getOrganization | @pulumi/pulumi

    Function getOrganization

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getProject.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getProject.html index 3e7292a6f8e3..bdaef7d8ad92 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getProject.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getProject.html @@ -1,2 +1,2 @@ getProject | @pulumi/pulumi

    Function getProject

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getStack.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getStack.html index 5fde2881ed77..b70f924ec5ce 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getStack.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getStack.html @@ -1,2 +1,2 @@ getStack | @pulumi/pulumi

    Function getStack

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/interpolate.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/interpolate.html index f54eaf530e70..ef2d06a9ac2d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/interpolate.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/interpolate.html @@ -4,4 +4,4 @@

    As with concat, the placeholders between ${} can be any Inputs: promises, outputs, or just plain JavaScript values.

    -

    Parameters

    • literals: TemplateStringsArray
    • Rest ...placeholders: any[]

    Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • literals: TemplateStringsArray
    • Rest ...placeholders: any[]

    Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/isGrpcError.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/isGrpcError.html index 22253768be5a..fc97be232f34 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/isGrpcError.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/isGrpcError.html @@ -1 +1 @@ -isGrpcError | @pulumi/pulumi

    Function isGrpcError

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isGrpcError | @pulumi/pulumi

    Function isGrpcError

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/isSecret.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/isSecret.html index fda0062521af..0b2fb9705731 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/isSecret.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/isSecret.html @@ -1,3 +1,3 @@ isSecret | @pulumi/pulumi

    Function isSecret

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/isUnknown.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/isUnknown.html index ecfdbe6aa101..011f226e14bc 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/isUnknown.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/isUnknown.html @@ -1,2 +1,2 @@ isUnknown | @pulumi/pulumi

    Function isUnknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • val: any

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/iterable.groupBy.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/iterable.groupBy.html index 6399ff2c4f30..9cfc5e1a654d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/iterable.groupBy.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/iterable.groupBy.html @@ -8,4 +8,4 @@

    and whose selector is roughly (e) => [e.s, e.n], the resulting object will be

    { "a": [1, 2], "b": [1] }
    -

    Type Parameters

    • T
    • V

    Parameters

    Returns Output<{
        [key: string]: V[];
    }>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T
    • V

    Parameters

    Returns Output<{
        [key: string]: V[];
    }>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/iterable.toObject.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/iterable.toObject.html index 9a62edd6f38f..b786f62f7663 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/iterable.toObject.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/iterable.toObject.html @@ -7,4 +7,4 @@

    and whose selector is roughly (e) => [e.s, e.n], the resulting object will be

    { "a": 1, "b": 2, "c": 3 }
    -

    Type Parameters

    • T
    • V

    Parameters

    Returns Output<{
        [key: string]: V;
    }>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T
    • V

    Parameters

    Returns Output<{
        [key: string]: V;
    }>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/jsonParse.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/jsonParse.html index eec543e9b00a..7ac13eeb9b64 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/jsonParse.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/jsonParse.html @@ -1,2 +1,2 @@ jsonParse | @pulumi/pulumi

    Function jsonParse

    • jsonParse(text, reviver?): Output<any>

    • jsonParse Uses JSON.parse to deserialize the given Input JSON string into a value.

      -

      Parameters

      • text: Input<string>
      • Optional reviver: ((this, key, value) => any)
          • (this, key, value): any

          • Parameters

            • this: any
            • key: string
            • value: any

            Returns any

      Returns Output<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • text: Input<string>
    • Optional reviver: ((this, key, value) => any)
        • (this, key, value): any

        • Parameters

          • this: any
          • key: string
          • value: any

          Returns any

    Returns Output<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/jsonStringify.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/jsonStringify.html index b19fc09597ac..41fddc4aa501 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/jsonStringify.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/jsonStringify.html @@ -1,3 +1,3 @@ jsonStringify | @pulumi/pulumi

    Function jsonStringify

    • jsonStringify(obj, replacer?, space?): Output<string>

    • jsonStringify uses JSON.stringify to serialize the given Input value into a JSON string.

      -

      Parameters

      • obj: any
      • Optional replacer: ((this, key, value) => any)
          • (this, key, value): any

          • Parameters

            • this: any
            • key: string
            • value: any

            Returns any

      • Optional space: string | number

      Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any
    • Optional replacer: ((this, key, value) => any)
        • (this, key, value): any

        • Parameters

          • this: any
          • key: string
          • value: any

          Returns any

    • Optional space: string | number

    Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.debug.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.debug.html index b4cb233f312a..9bd0ffadd74d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.debug.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.debug.html @@ -1,2 +1,2 @@ debug | @pulumi/pulumi

    Function debug

    • debug(msg, resource?, streamId?, ephemeral?): Promise<void>

    • Logs a debug-level message that is generally hidden from end-users.

      -

      Parameters

      • msg: string
      • Optional resource: Resource
      • Optional streamId: number
      • Optional ephemeral: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • msg: string
    • Optional resource: Resource
    • Optional streamId: number
    • Optional ephemeral: boolean

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.error.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.error.html index a35568d370f7..dd671ab1118d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.error.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.error.html @@ -1,3 +1,3 @@ error | @pulumi/pulumi

    Function error

    • error(msg, resource?, streamId?, ephemeral?): Promise<void>

    • Logs a fatal condition. Consider raising an exception after calling error to stop the Pulumi program.

      -

      Parameters

      • msg: string
      • Optional resource: Resource
      • Optional streamId: number
      • Optional ephemeral: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • msg: string
    • Optional resource: Resource
    • Optional streamId: number
    • Optional ephemeral: boolean

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.hasErrors.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.hasErrors.html index 991f7d722901..f431caabad56 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.hasErrors.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.hasErrors.html @@ -1,2 +1,2 @@ hasErrors | @pulumi/pulumi

    Function hasErrors

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.info.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.info.html index c4a2c552dbd5..72d0a2227d72 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.info.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.info.html @@ -1,3 +1,3 @@ info | @pulumi/pulumi

    Function info

    • info(msg, resource?, streamId?, ephemeral?): Promise<void>

    • Logs an informational message that is generally printed to standard output during resource operations.

      -

      Parameters

      • msg: string
      • Optional resource: Resource
      • Optional streamId: number
      • Optional ephemeral: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • msg: string
    • Optional resource: Resource
    • Optional streamId: number
    • Optional ephemeral: boolean

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.warn.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.warn.html index 6ceb42b46382..07216141615c 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.warn.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/log.warn.html @@ -1,3 +1,3 @@ warn | @pulumi/pulumi

    Function warn

    • warn(msg, resource?, streamId?, ephemeral?): Promise<void>

    • Logs a warning to indicate that something went wrong, but not catastrophically so.

      -

      Parameters

      • msg: string
      • Optional resource: Resource
      • Optional streamId: number
      • Optional ephemeral: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • msg: string
    • Optional resource: Resource
    • Optional streamId: number
    • Optional ephemeral: boolean

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/mergeOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/mergeOptions.html index b2b24b25ac72..14b4ae387fb5 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/mergeOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/mergeOptions.html @@ -17,4 +17,4 @@ always treated as collections, even if only a single value was provided.

    -

    Parameters

    Returns CustomResourceOptions

  • mergeOptions(opts1, opts2): ComponentResourceOptions

  • Parameters

    Returns ComponentResourceOptions

  • mergeOptions(opts1, opts2): ResourceOptions

  • Parameters

    Returns ResourceOptions

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns CustomResourceOptions

  • mergeOptions(opts1, opts2): ComponentResourceOptions

  • Parameters

    Returns ComponentResourceOptions

  • mergeOptions(opts1, opts2): ResourceOptions

  • Parameters

    Returns ResourceOptions

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/output-2.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/output-2.html index 9b38758ad057..f8b510ebbf78 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/output-2.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/output-2.html @@ -3,4 +3,4 @@

    The expected way to use this function is like so:

         var transformed = pulumi.output(someVal).apply(unwrapped => {
             // Do whatever you want now.  'unwrapped' will contain no outputs/promises inside
             // here, so you can easily do whatever sort of transformation is most convenient.
         });

         // the result can be passed to another Resource.  The dependency information will be
         // properly maintained.
         var someResource = new SomeResource(name, { data: transformed ... });
    -

    Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T>>

  • output<T>(val): Output<Unwrap<T | undefined>>

  • Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T | undefined>>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T>>

  • output<T>(val): Output<Unwrap<T | undefined>>

  • Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T | undefined>>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/provider.main.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/provider.main.html index 00554300c01c..569303192f7f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/provider.main.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/provider.main.html @@ -1 +1 @@ -main | @pulumi/pulumi

    Function main

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +main | @pulumi/pulumi

    Function main

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.allConfig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.allConfig.html index 477adcc1a520..a4d35dd5cd99 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.allConfig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.allConfig.html @@ -1,2 +1,2 @@ allConfig | @pulumi/pulumi

    Function allConfig

    • allConfig(): {
          [key: string]: string;
      }

    • Returns a copy of the full configuration map.

      -

      Returns {
          [key: string]: string;
      }

      • [key: string]: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns {
        [key: string]: string;
    }

    • [key: string]: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.awaitStackRegistrations.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.awaitStackRegistrations.html index 574c619c23ab..d9ee8290bd46 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.awaitStackRegistrations.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.awaitStackRegistrations.html @@ -1,2 +1,2 @@ awaitStackRegistrations | @pulumi/pulumi

    Function awaitStackRegistrations

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.cacheDynamicProviders.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.cacheDynamicProviders.html index edc69653812b..7939d212fa64 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.cacheDynamicProviders.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.cacheDynamicProviders.html @@ -1,3 +1,3 @@ cacheDynamicProviders | @pulumi/pulumi

    Function cacheDynamicProviders

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.call.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.call.html index 505238fd567a..542473d35f42 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.call.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.call.html @@ -1,2 +1,2 @@ call | @pulumi/pulumi

    Function call

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    • tok: string
    • props: Inputs
    • Optional res: Resource
    • Optional packageRef: Promise<undefined | string>

    Returns Output<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.computeCodePaths.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.computeCodePaths.html index 3167c02ebb3a..9337685cad4e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.computeCodePaths.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.computeCodePaths.html @@ -14,6 +14,6 @@ library code that is determining what is needed for a cloud-lambda. i.e. the aws.serverless.Function or azure.serverless.FunctionApp libraries. In general, other clients should not need to use this helper.

    -

    Parameters

    Returns Promise<Map<string, Asset | Archive>>

  • computeCodePaths(extraIncludePaths?, extraIncludePackages?, extraExcludePackages?): Promise<Map<string, Asset | Archive>>

  • Parameters

    • Optional extraIncludePaths: string[]
    • Optional extraIncludePackages: string[]
    • Optional extraExcludePackages: string[]

    Returns Promise<Map<string, Asset | Archive>>

    Deprecated

    Use the computeCodePaths overload that takes a +

    Parameters

    Returns Promise<Map<string, Asset | Archive>>

  • computeCodePaths(extraIncludePaths?, extraIncludePackages?, extraExcludePackages?): Promise<Map<string, Asset | Archive>>

  • Parameters

    • Optional extraIncludePaths: string[]
    • Optional extraIncludePackages: string[]
    • Optional extraExcludePackages: string[]

    Returns Promise<Map<string, Asset | Archive>>

    Deprecated

    Use the computeCodePaths overload that takes a CodePathOptions instead.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.deserializeProperties.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.deserializeProperties.html index 797617197130..8b4af74d51b5 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.deserializeProperties.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.deserializeProperties.html @@ -1,2 +1,2 @@ deserializeProperties | @pulumi/pulumi

    Function deserializeProperties

    • deserializeProperties(outputsStruct, keepUnknowns?): Inputs

    • Fetches the raw outputs and deserializes them from a gRPC call result.

      -

      Parameters

      • outputsStruct: Struct
      • Optional keepUnknowns: boolean

      Returns Inputs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • outputsStruct: Struct
    • Optional keepUnknowns: boolean

    Returns Inputs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.deserializeProperty.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.deserializeProperty.html index 2a1d9862fe15..da3bff98d71d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.deserializeProperty.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.deserializeProperty.html @@ -1,3 +1,3 @@ deserializeProperty | @pulumi/pulumi

    Function deserializeProperty

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • prop: any
    • Optional keepUnknowns: boolean

    Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.disconnect.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.disconnect.html index 60cfe35a17d2..bf924d0c20f0 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.disconnect.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.disconnect.html @@ -1,4 +1,4 @@ disconnect | @pulumi/pulumi

    Function disconnect

    • disconnect(): Promise<void>

    • Permanently disconnects from the server, closing the connections. It waits for the existing RPC queue to drain. If any RPCs come in afterwards, however, they will crash the process.

      -

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.disconnectSync.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.disconnectSync.html index 66dbab919a85..0eb3efce0f9e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.disconnectSync.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.disconnectSync.html @@ -1,4 +1,4 @@ disconnectSync | @pulumi/pulumi

    Function disconnectSync

    • disconnectSync(): void

    • Permanently disconnects from the server, closing the connections. Unlike disconnect. it does not wait for the existing RPC queue to drain. Any RPCs that come in after this call will crash the process.

      -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getCallbacks.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getCallbacks.html index 200fb8de9771..070a1d2abcc6 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getCallbacks.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getCallbacks.html @@ -1,2 +1,2 @@ getCallbacks | @pulumi/pulumi

    Function getCallbacks

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns ICallbackServer | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getConfig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getConfig.html index 54e9c6c8d216..7b139c9179aa 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getConfig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getConfig.html @@ -1,2 +1,2 @@ getConfig | @pulumi/pulumi

    Function getConfig

    • getConfig(k): string | undefined

    • Returns a configuration variable's value, or undefined if it is unset.

      -

      Parameters

      • k: string

      Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • k: string

    Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getEngine.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getEngine.html index 05b92ab57f62..bc1a70325688 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getEngine.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getEngine.html @@ -1,3 +1,3 @@ getEngine | @pulumi/pulumi

    Function getEngine

    • getEngine(): engrpc.IEngineClient | undefined

    • Returns the current engine, if any, for RPC communications back to the resource engine.

      -

      Returns engrpc.IEngineClient | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns engrpc.IEngineClient | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getMaximumListeners.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getMaximumListeners.html index 1e80e74ccadf..5a5defe65ba1 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getMaximumListeners.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getMaximumListeners.html @@ -1,2 +1,2 @@ getMaximumListeners | @pulumi/pulumi

    Function getMaximumListeners

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getMonitor.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getMonitor.html index 6bca747f573d..1f71b5c81ad0 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getMonitor.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getMonitor.html @@ -1,3 +1,3 @@ getMonitor | @pulumi/pulumi

    Function getMonitor

    • getMonitor(): resrpc.IResourceMonitorClient | undefined

    • Returns the current resource monitoring service client for RPC communications.

      -

      Returns resrpc.IResourceMonitorClient | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns resrpc.IResourceMonitorClient | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getOrganization.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getOrganization.html index c6640fc0bbab..caf2da24cc21 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getOrganization.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getOrganization.html @@ -1,2 +1,2 @@ getOrganization | @pulumi/pulumi

    Function getOrganization

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getProject.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getProject.html index 9e118248d7be..a3a3abdf67e0 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getProject.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getProject.html @@ -1,2 +1,2 @@ getProject | @pulumi/pulumi

    Function getProject

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getResource.html index 9ae5580c7254..8a86c15d8a09 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getResource.html @@ -1,2 +1,2 @@ getResource | @pulumi/pulumi

    Function getResource

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getResourceModule.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getResourceModule.html index c6dcd18a4697..27480867da78 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getResourceModule.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getResourceModule.html @@ -1 +1 @@ -getResourceModule | @pulumi/pulumi

    Function getResourceModule

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +getResourceModule | @pulumi/pulumi

    Function getResourceModule

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getResourcePackage.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getResourcePackage.html index ba27b32b7f53..987f84cd2798 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getResourcePackage.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getResourcePackage.html @@ -1 +1 @@ -getResourcePackage | @pulumi/pulumi

    Function getResourcePackage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +getResourcePackage | @pulumi/pulumi

    Function getResourcePackage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getStack.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getStack.html index d366cad98756..1f2a670c6889 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getStack.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getStack.html @@ -1,2 +1,2 @@ getStack | @pulumi/pulumi

    Function getStack

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getStackResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getStackResource.html index 46d38c04cb38..1c984a9ac8f2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getStackResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.getStackResource.html @@ -1 +1 @@ -getStackResource | @pulumi/pulumi

    Function getStackResource

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +getStackResource | @pulumi/pulumi

    Function getStackResource

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.hasEngine.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.hasEngine.html index 90f857d7a5c8..c2ff04b003d0 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.hasEngine.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.hasEngine.html @@ -1,2 +1,2 @@ hasEngine | @pulumi/pulumi

    Function hasEngine

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.hasMonitor.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.hasMonitor.html index c3262020403b..f228a14bc2f2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.hasMonitor.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.hasMonitor.html @@ -1,2 +1,2 @@ hasMonitor | @pulumi/pulumi

    Function hasMonitor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.invoke.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.invoke.html index dd76218a182d..cc4bedbc7a1f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.invoke.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.invoke.html @@ -35,4 +35,4 @@

    All of these contain async values that would prevent `invoke from being able to operate synchronously.

    -

    Parameters

    • tok: string
    • props: Inputs
    • opts: InvokeOptions = {}
    • Optional packageRef: Promise<undefined | string>

    Returns Promise<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • tok: string
    • props: Inputs
    • opts: InvokeOptions = {}
    • Optional packageRef: Promise<undefined | string>

    Returns Promise<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.invokeSingle.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.invokeSingle.html index 1367f3d5a452..be06db6ccf80 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.invokeSingle.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.invokeSingle.html @@ -1 +1 @@ -invokeSingle | @pulumi/pulumi

    Function invokeSingle

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +invokeSingle | @pulumi/pulumi

    Function invokeSingle

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isDryRun.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isDryRun.html index 26ae8b5a59d0..c46195bd3090 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isDryRun.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isDryRun.html @@ -1,4 +1,4 @@ isDryRun | @pulumi/pulumi

    Function isDryRun

    • isDryRun(): boolean

    • Returns true if we are currently doing a preview.

      When writing unit tests, you can set this flag via either setMocks or _setIsDryRun.

      -

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isLegacyApplyEnabled.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isLegacyApplyEnabled.html index 365f194e1b48..aca5dfa61760 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isLegacyApplyEnabled.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isLegacyApplyEnabled.html @@ -1,3 +1,3 @@ isLegacyApplyEnabled | @pulumi/pulumi

    Function isLegacyApplyEnabled

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isQueryMode.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isQueryMode.html index e02690141120..5e1a272ef15b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isQueryMode.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isQueryMode.html @@ -1,2 +1,2 @@ isQueryMode | @pulumi/pulumi

    Function isQueryMode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isRpcSecret.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isRpcSecret.html index 6bf98b53f0c5..2500db1ee16b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isRpcSecret.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.isRpcSecret.html @@ -1,3 +1,3 @@ isRpcSecret | @pulumi/pulumi

    Function isRpcSecret

    • isRpcSecret(obj): boolean

    • Returns true if the given object is a wrapped secret value (i.e. it's an object with the special key set).

      -

      Parameters

      • obj: any

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.listResourceOutputs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.listResourceOutputs.html index 2e7764e5aa7e..b109195ebec7 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.listResourceOutputs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.listResourceOutputs.html @@ -6,4 +6,4 @@

    Type Parameters

    Parameters

    • Optional typeFilter: ((o) => o is U)

      A type guard that specifies which resource types to list outputs of.

        • (o): o is U

        • Parameters

          • o: any

          Returns o is U

    • Optional stackName: string

      Name of stack to retrieve resource outputs for. Defaults to the current stack.

      -

    Returns query.AsyncQueryable<ResolvedResource<U>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns query.AsyncQueryable<ResolvedResource<U>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.mapAliasesForRequest.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.mapAliasesForRequest.html index 5334921596ce..372b74d5dd5b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.mapAliasesForRequest.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.mapAliasesForRequest.html @@ -1 +1 @@ -mapAliasesForRequest | @pulumi/pulumi

    Function mapAliasesForRequest

    • mapAliasesForRequest(aliases, parentURN?): Promise<aliasproto.Alias[]>

    • Parameters

      • aliases: undefined | (string | Alias)[]
      • Optional parentURN: string

      Returns Promise<aliasproto.Alias[]>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +mapAliasesForRequest | @pulumi/pulumi

    Function mapAliasesForRequest

    • mapAliasesForRequest(aliases, parentURN?): Promise<aliasproto.Alias[]>

    • Parameters

      • aliases: undefined | (string | Alias)[]
      • Optional parentURN: string

      Returns Promise<aliasproto.Alias[]>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.readResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.readResource.html index d35c0270c431..14993e94da5c 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.readResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.readResource.html @@ -1,4 +1,4 @@ readResource | @pulumi/pulumi

    Function readResource

    • readResource(res, parent, t, name, props, opts, sourcePosition?, packageRef?): void

    • Reads an existing custom resource's state from the resource monitor. Note that resources read in this way will not be part of the resulting stack's state, as they are presumed to belong to another.

      -

      Parameters

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerInvokeTransform.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerInvokeTransform.html index f81f37bbaed6..adecd8566cde 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerInvokeTransform.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerInvokeTransform.html @@ -1,2 +1,2 @@ registerInvokeTransform | @pulumi/pulumi

    Function registerInvokeTransform

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResource.html index 48f2a0fe928f..f17b6bf4a4b5 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResource.html @@ -3,4 +3,4 @@ the deployment has completed. All properties will be initialized to property objects that the registration operation will resolve at the right time (or remain unresolved for deployments).

    -

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourceModule.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourceModule.html index f31212809ef8..aaf3d93e93b6 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourceModule.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourceModule.html @@ -1,4 +1,4 @@ registerResourceModule | @pulumi/pulumi

    Function registerResourceModule

    • registerResourceModule(pkg, mod, module): void

    • Registers a resource module that will be used to construct resources for any URNs matching the module name and version that are deserialized by the current instance of the Pulumi JavaScript SDK.

      -

      Parameters

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourceOutputs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourceOutputs.html index b0892111e135..d8f586dc6bf2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourceOutputs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourceOutputs.html @@ -1,3 +1,3 @@ registerResourceOutputs | @pulumi/pulumi

    Function registerResourceOutputs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourcePackage.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourcePackage.html index 9718d03e3c91..dcadcc3532e2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourcePackage.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourcePackage.html @@ -1,4 +1,4 @@ registerResourcePackage | @pulumi/pulumi

    Function registerResourcePackage

    • registerResourcePackage(pkg, resourcePackage): void

    • Registers a resource package that will be used to construct providers for any URNs matching the package name and version that are deserialized by the current instance of the Pulumi JavaScript SDK.

      -

      Parameters

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourceTransform.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourceTransform.html index 53e5e9221246..98d38253e993 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourceTransform.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResourceTransform.html @@ -1,3 +1,3 @@ registerResourceTransform | @pulumi/pulumi

    Function registerResourceTransform

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerStackTransform.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerStackTransform.html index 84cba8dd9d1a..a4ac02bcc5ea 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerStackTransform.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerStackTransform.html @@ -1,4 +1,4 @@ registerStackTransform | @pulumi/pulumi

    Function registerStackTransform

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerStackTransformation.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerStackTransformation.html index 1216bd251550..8b5813ce74ae 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerStackTransformation.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerStackTransformation.html @@ -1,3 +1,3 @@ registerStackTransformation | @pulumi/pulumi

    Function registerStackTransformation

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.resetOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.resetOptions.html index 707938eec9ae..9228243f2dd2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.resetOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.resetOptions.html @@ -1,3 +1,3 @@ resetOptions | @pulumi/pulumi

    Function resetOptions

    • resetOptions(project, stack, parallel, engineAddr, monitorAddr, preview, organization): void

    • Resets NodeJS runtime global state (such as RPC clients), and sets NodeJS runtime option environment variables to the specified values.

      -

      Parameters

      • project: string
      • stack: string
      • parallel: number
      • engineAddr: string
      • monitorAddr: string
      • preview: boolean
      • organization: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • project: string
    • stack: string
    • parallel: number
    • engineAddr: string
    • monitorAddr: string
    • preview: boolean
    • organization: string

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.resolveProperties.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.resolveProperties.html index 686bc1928439..d43821a38e28 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.resolveProperties.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.resolveProperties.html @@ -5,4 +5,4 @@ w.r.t. knowns/unknowns: this function assumes that any undefined value in allPropsrepresents an unknown value that was returned by an engine operation.

    -

    Parameters

    • res: Resource
    • resolvers: Record<string, ((v, isKnown, isSecret, deps?, err?) => void)>
    • t: string
    • name: string
    • allProps: any
    • deps: Record<string, Resource[]>
    • Optional err: Error
    • Optional keepUnknowns: boolean

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • res: Resource
    • resolvers: Record<string, ((v, isKnown, isSecret, deps?, err?) => void)>
    • t: string
    • name: string
    • allProps: any
    • deps: Record<string, Resource[]>
    • Optional err: Error
    • Optional keepUnknowns: boolean

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.rpcKeepAlive.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.rpcKeepAlive.html index 23c49ba2cb54..e8edffe8c198 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.rpcKeepAlive.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.rpcKeepAlive.html @@ -1,4 +1,4 @@ rpcKeepAlive | @pulumi/pulumi

    Function rpcKeepAlive

    • rpcKeepAlive(): (() => void)

    • Registers a pending call to ensure that we don't prematurely disconnect from the server. It returns a function that, when invoked, signals that the RPC has completed.

      -

      Returns (() => void)

        • (): void

        • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns (() => void)

      • (): void

      • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.runInPulumiStack.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.runInPulumiStack.html index ee0e90ef9ae7..977c0456edc4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.runInPulumiStack.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.runInPulumiStack.html @@ -1,4 +1,4 @@ runInPulumiStack | @pulumi/pulumi

    Function runInPulumiStack

    • runInPulumiStack(init): Promise<Inputs | undefined>

    • Creates a new Pulumi stack resource and executes the callback inside of it. Any outputs returned by the callback will be stored as output properties on this resulting Stack object.

      -

      Parameters

      • init: (() => Promise<any>)
          • (): Promise<any>

          • Returns Promise<any>

      Returns Promise<Inputs | undefined>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • init: (() => Promise<any>)
        • (): Promise<any>

        • Returns Promise<any>

    Returns Promise<Inputs | undefined>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serialize.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serialize.html index c33cd7d5c674..1a7cfeca28b4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serialize.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serialize.html @@ -1,2 +1,2 @@ serialize | @pulumi/pulumi

    Function serialize

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeFunction.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeFunction.html index e27abb8d8412..8d63200e354c 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeFunction.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeFunction.html @@ -21,4 +21,4 @@

    Parameters

    • func: Function

      The JavaScript function to serialize.

    • args: SerializeFunctionArgs = {}

      Arguments to use to control the serialization of the JavaScript function.

      -

    Returns Promise<SerializedFunction>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<SerializedFunction>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeFunctionAsync.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeFunctionAsync.html index 02aa36bf3ce0..e1cea34e93b5 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeFunctionAsync.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeFunctionAsync.html @@ -1,2 +1,2 @@ serializeFunctionAsync | @pulumi/pulumi

    Function serializeFunctionAsync

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeProperties.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeProperties.html index a2ad8dfa125c..6418a8e26257 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeProperties.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeProperties.html @@ -1,3 +1,3 @@ serializeProperties | @pulumi/pulumi

    Function serializeProperties

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Record<string, any>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeProperty.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeProperty.html index dc74b66c81a4..89353121b0e9 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeProperty.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeProperty.html @@ -1,4 +1,4 @@ serializeProperty | @pulumi/pulumi

    Function serializeProperty

    • serializeProperty(ctx, prop, dependentResources, opts?): Promise<any>

    • Serializes properties deeply. This understands how to wait on any unresolved promises, as appropriate, in addition to translating certain "special" values so that they are ready to go on the wire.

      -

      Parameters

      Returns Promise<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeResourceProperties.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeResourceProperties.html index 289ddb9b4b04..c9690fba3e08 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeResourceProperties.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeResourceProperties.html @@ -1,4 +1,4 @@ serializeResourceProperties | @pulumi/pulumi

    Function serializeResourceProperties

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<[Record<string, any>, Map<string, Set<Resource>>]>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setAllConfig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setAllConfig.html index 86d9e95b1959..f6026a0b5b4d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setAllConfig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setAllConfig.html @@ -1,2 +1,2 @@ setAllConfig | @pulumi/pulumi

    Function setAllConfig

    • setAllConfig(c, secretKeys?): void

    • Overwrites the configuration map.

      -

      Parameters

      • c: {
            [key: string]: string;
        }
        • [key: string]: string
      • Optional secretKeys: string[]

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • c: {
          [key: string]: string;
      }
      • [key: string]: string
    • Optional secretKeys: string[]

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setConfig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setConfig.html index 7001c5d189f5..4e40832578f2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setConfig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setConfig.html @@ -1,2 +1,2 @@ setConfig | @pulumi/pulumi

    Function setConfig

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • k: string
    • v: string

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setMockOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setMockOptions.html index fdf7fb32cdf6..526c1a5ee3f9 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setMockOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setMockOptions.html @@ -1 +1 @@ -setMockOptions | @pulumi/pulumi

    Function setMockOptions

    • setMockOptions(mockMonitor, project?, stack?, preview?, organization?): void

    • Parameters

      • mockMonitor: any
      • Optional project: string
      • Optional stack: string
      • Optional preview: boolean
      • Optional organization: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +setMockOptions | @pulumi/pulumi

    Function setMockOptions

    • setMockOptions(mockMonitor, project?, stack?, preview?, organization?): void

    • Parameters

      • mockMonitor: any
      • Optional project: string
      • Optional stack: string
      • Optional preview: boolean
      • Optional organization: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setMocks.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setMocks.html index c35650bdfbad..83f7ed743eb3 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setMocks.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setMocks.html @@ -4,4 +4,4 @@
  • Optional stack: string

    If provided, the name of the Pulumi stack. Defaults to "stack".

  • Optional preview: boolean

    If provided, indicates whether or not the program is running a preview. Defaults to false.

  • Optional organization: string

    If provided, the name of the Pulumi organization. Defaults to nothing.

    -

    • Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setRootResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setRootResource.html index f42ac9b0778b..fafac1aa8f4d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setRootResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.setRootResource.html @@ -1,3 +1,3 @@ setRootResource | @pulumi/pulumi

    Function setRootResource

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.streamInvoke.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.streamInvoke.html index 9fbc49691ad8..125e83a6a7bb 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.streamInvoke.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.streamInvoke.html @@ -1 +1 @@ -streamInvoke | @pulumi/pulumi

    Function streamInvoke

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +streamInvoke | @pulumi/pulumi

    Function streamInvoke

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.suppressUnhandledGrpcRejections.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.suppressUnhandledGrpcRejections.html index 229aa7a40e78..01f82d2ec6bf 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.suppressUnhandledGrpcRejections.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.suppressUnhandledGrpcRejections.html @@ -1,3 +1,3 @@ suppressUnhandledGrpcRejections | @pulumi/pulumi

    Function suppressUnhandledGrpcRejections

    • suppressUnhandledGrpcRejections<T>(p): Promise<T>

    • Silences any unhandled promise rejections that occur due to gRPC errors. The input promise may still be rejected.

      -

      Type Parameters

      • T

      Parameters

      • p: Promise<T>

      Returns Promise<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    • p: Promise<T>

    Returns Promise<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.terminateRpcs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.terminateRpcs.html index db8b0f85c411..0778f6f44a1f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.terminateRpcs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.terminateRpcs.html @@ -1 +1 @@ -terminateRpcs | @pulumi/pulumi

    Function terminateRpcs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +terminateRpcs | @pulumi/pulumi

    Function terminateRpcs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.transferProperties.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.transferProperties.html index b36d3378983b..3776e0502e99 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.transferProperties.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.transferProperties.html @@ -9,4 +9,4 @@ registerResource RPC call comes back, the values that the engine actualy produced will be used to resolve all the unresolved promised placed on onto.

    -

    Parameters

    Returns OutputResolvers

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns OutputResolvers

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.unwrapRpcSecret.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.unwrapRpcSecret.html index 9bc8515e5ff7..e6ba5c79afb4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.unwrapRpcSecret.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.unwrapRpcSecret.html @@ -1,3 +1,3 @@ unwrapRpcSecret | @pulumi/pulumi

    Function unwrapRpcSecret

    • unwrapRpcSecret(obj): any

    • Returns the underlying value for a secret, or the value itself if it was not a secret.

      -

      Parameters

      • obj: any

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/secret.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/secret.html index 98c728c88663..caf3d3e2efef 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/secret.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/secret.html @@ -1,3 +1,3 @@ secret | @pulumi/pulumi

    Function secret

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T>>

  • secret<T>(val): Output<Unwrap<T | undefined>>

  • Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T | undefined>>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/unsecret.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/unsecret.html index 1105492ed4d1..f10af5546e01 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/unsecret.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/unsecret.html @@ -1,3 +1,3 @@ unsecret | @pulumi/pulumi

    Function unsecret

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    Returns Output<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/Alias.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/Alias.html index e36b3fa06b23..6e0d91c8db29 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/Alias.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/Alias.html @@ -15,20 +15,20 @@

    aliases: [{ parent: pulumi.rootStackResource }]

    This form is self-descriptive and makes the intent clearer than using:

    aliases: [{ parent: undefined }]

    -
    interface Alias {
        name?: Input<string>;
        parent?: Resource | Input<string>;
        project?: Input<string>;
        stack?: Input<string>;
        type?: Input<string>;
    }

    Properties

    name? +
    interface Alias {
        name?: Input<string>;
        parent?: Resource | Input<string>;
        project?: Input<string>;
        stack?: Input<string>;
        type?: Input<string>;
    }

    Properties

    name? parent? project? stack? type?

    Properties

    Optional name

    name?: Input<string>

    The previous name of the resource. If not provided, the current name of the resource is used.

    -

    Optional parent

    parent?: Resource | Input<string>

    The previous parent of the resource. If not provided (i.e. { name: "foo" }), the current parent of the resource is used (opts.parent if +

    Optional parent

    parent?: Resource | Input<string>

    The previous parent of the resource. If not provided (i.e. { name: "foo" }), the current parent of the resource is used (opts.parent if provided, else the implicit stack resource parent).

    To specify no original parent, use { parent: pulumi.rootStackResource }.

    -

    Optional project

    project?: Input<string>

    The previous project of the resource. If not provided, defaults to +

    Optional project

    project?: Input<string>

    The previous project of the resource. If not provided, defaults to pulumi.getProject().

    -

    Optional stack

    stack?: Input<string>

    The previous stack of the resource. If not provided, defaults to +

    Optional stack

    stack?: Input<string>

    The previous stack of the resource. If not provided, defaults to pulumi.getStack().

    -

    Optional type

    type?: Input<string>

    The previous type of the resource. If not provided, the current type of +

    Optional type

    type?: Input<string>

    The previous type of the resource. If not provided, the current type of the resource is used.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    nameparentprojectstacktype

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    nameparentprojectstacktype

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ComponentResourceOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ComponentResourceOptions.html index 339591e62a8a..1236d18c3713 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ComponentResourceOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ComponentResourceOptions.html @@ -1,6 +1,6 @@ ComponentResourceOptions | @pulumi/pulumi

    Interface ComponentResourceOptions

    ComponentResourceOptions is a bag of optional settings that control a component resource's behavior.

    -
    interface ComponentResourceOptions {
        aliases?: Input<string | Alias>[];
        customTimeouts?: CustomTimeouts;
        deletedWith?: Resource;
        dependsOn?: Input<Resource> | Input<Input<Resource>[]>;
        id?: Input<string>;
        ignoreChanges?: string[];
        parent?: Resource;
        pluginDownloadURL?: string;
        protect?: boolean;
        provider?: ProviderResource;
        providers?: Record<string, ProviderResource> | ProviderResource[];
        replaceOnChanges?: string[];
        retainOnDelete?: boolean;
        transformations?: ResourceTransformation[];
        transforms?: ResourceTransform[];
        urn?: string;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    aliases? +
    interface ComponentResourceOptions {
        aliases?: Input<string | Alias>[];
        customTimeouts?: CustomTimeouts;
        deletedWith?: Resource;
        dependsOn?: Input<Resource> | Input<Input<Resource>[]>;
        id?: Input<string>;
        ignoreChanges?: string[];
        parent?: Resource;
        pluginDownloadURL?: string;
        protect?: boolean;
        provider?: ProviderResource;
        providers?: Record<string, ProviderResource> | ProviderResource[];
        replaceOnChanges?: string[];
        retainOnDelete?: boolean;
        transformations?: ResourceTransformation[];
        transforms?: ResourceTransform[];
        urn?: string;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    aliases? customTimeouts? deletedWith? dependsOn? @@ -18,38 +18,38 @@ urn? version?

    Properties

    Optional aliases

    aliases?: Input<string | Alias>[]

    An optional list of aliases to treat this resource as matching.

    -

    Optional customTimeouts

    customTimeouts?: CustomTimeouts

    An optional customTimeouts configuration block.

    -

    Optional deletedWith

    deletedWith?: Resource

    If set, the providers Delete method will not be called for this resource +

    Optional customTimeouts

    customTimeouts?: CustomTimeouts

    An optional customTimeouts configuration block.

    +

    Optional deletedWith

    deletedWith?: Resource

    If set, the providers Delete method will not be called for this resource if specified is being deleted as well.

    -

    Optional dependsOn

    dependsOn?: Input<Resource> | Input<Input<Resource>[]>

    An optional additional explicit dependencies on other resources.

    -

    Optional id

    id?: Input<string>

    An optional existing ID to load, rather than create.

    -

    Optional ignoreChanges

    ignoreChanges?: string[]

    Ignore changes to any of the specified properties.

    -

    Optional parent

    parent?: Resource

    An optional parent resource to which this resource belongs.

    -

    Optional pluginDownloadURL

    pluginDownloadURL?: string

    An option to specify the URL from which to download this resources +

    Optional dependsOn

    dependsOn?: Input<Resource> | Input<Input<Resource>[]>

    An optional additional explicit dependencies on other resources.

    +

    Optional id

    id?: Input<string>

    An optional existing ID to load, rather than create.

    +

    Optional ignoreChanges

    ignoreChanges?: string[]

    Ignore changes to any of the specified properties.

    +

    Optional parent

    parent?: Resource

    An optional parent resource to which this resource belongs.

    +

    Optional pluginDownloadURL

    pluginDownloadURL?: string

    An option to specify the URL from which to download this resources associated plugin. This version overrides the URL information inferred from the current package and should rarely be used.

    -

    Optional protect

    protect?: boolean

    When set to true, protect ensures this resource cannot be deleted.

    -

    Optional provider

    provider?: ProviderResource

    An optional provider to use for this resource's CRUD operations. If no provider is supplied, +

    Optional protect

    protect?: boolean

    When set to true, protect ensures this resource cannot be deleted.

    +

    Optional provider

    provider?: ProviderResource

    An optional provider to use for this resource's CRUD operations. If no provider is supplied, the default provider for the resource's package will be used. The default provider is pulled from the parent's provider bag (see also ComponentResourceOptions.providers).

    If this is a [ComponentResourceOptions] do not provide both [provider] and [providers]

    -

    Optional providers

    providers?: Record<string, ProviderResource> | ProviderResource[]

    An optional set of providers to use for child resources. Either keyed by +

    Optional providers

    providers?: Record<string, ProviderResource> | ProviderResource[]

    An optional set of providers to use for child resources. Either keyed by package name (e.g. "aws"), or just provided as an array. In the latter case, the package name will be retrieved from the provider itself.

    Note: only a list should be used. Mapping keys are not respected.

    -

    Optional replaceOnChanges

    replaceOnChanges?: string[]

    Changes to any of these property paths will force a replacement. If this list includes "*", changes to any +

    Optional replaceOnChanges

    replaceOnChanges?: string[]

    Changes to any of these property paths will force a replacement. If this list includes "*", changes to any properties will force a replacement. Initialization errors from previous deployments will require replacement instead of update only if "*" is passed.

    -

    Optional retainOnDelete

    retainOnDelete?: boolean

    If set to True, the providers Delete method will not be called for this resource.

    -

    Optional transformations

    transformations?: ResourceTransformation[]

    Optional list of transformations to apply to this resource during construction. The +

    Optional retainOnDelete

    retainOnDelete?: boolean

    If set to True, the providers Delete method will not be called for this resource.

    +

    Optional transformations

    transformations?: ResourceTransformation[]

    Optional list of transformations to apply to this resource during construction. The transformations are applied in order, and are applied prior to transformation applied to parents walking from the resource up to the stack.

    -

    Optional transforms

    transforms?: ResourceTransform[]

    Optional list of transforms to apply to this resource during construction. The +

    Optional transforms

    transforms?: ResourceTransform[]

    Optional list of transforms to apply to this resource during construction. The transforms are applied in order, and are applied prior to transforms applied to parents walking from the resource up to the stack.

    This property is experimental.

    -

    Optional urn

    urn?: string

    The URN of a previously-registered resource of this type to read from the engine.

    -

    Optional version

    version?: string

    An optional version, corresponding to the version of the provider plugin that should be used when operating on +

    Optional urn

    urn?: string

    The URN of a previously-registered resource of this type to read from the engine.

    +

    Optional version

    version?: string

    An optional version, corresponding to the version of the provider plugin that should be used when operating on this resource. This version overrides the version information inferred from the current package and should rarely be used.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    aliasescustomTimeoutsdeletedWithdependsOnidignoreChangesparentpluginDownloadURLprotectproviderprovidersreplaceOnChangesretainOnDeletetransformationstransformsurnversion

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    aliasescustomTimeoutsdeletedWithdependsOnidignoreChangesparentpluginDownloadURLprotectproviderprovidersreplaceOnChangesretainOnDeletetransformationstransformsurnversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/CustomResourceOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/CustomResourceOptions.html index 19d3483c3f0c..7b4274084d1a 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/CustomResourceOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/CustomResourceOptions.html @@ -1,6 +1,6 @@ CustomResourceOptions | @pulumi/pulumi

    Interface CustomResourceOptions

    CustomResourceOptions is a bag of optional settings that control a custom resource's behavior.

    -
    interface CustomResourceOptions {
        additionalSecretOutputs?: string[];
        aliases?: Input<string | Alias>[];
        customTimeouts?: CustomTimeouts;
        deleteBeforeReplace?: boolean;
        deletedWith?: Resource;
        dependsOn?: Input<Resource> | Input<Input<Resource>[]>;
        id?: Input<string>;
        ignoreChanges?: string[];
        import?: string;
        parent?: Resource;
        pluginDownloadURL?: string;
        protect?: boolean;
        provider?: ProviderResource;
        replaceOnChanges?: string[];
        retainOnDelete?: boolean;
        transformations?: ResourceTransformation[];
        transforms?: ResourceTransform[];
        urn?: string;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    additionalSecretOutputs? +
    interface CustomResourceOptions {
        additionalSecretOutputs?: string[];
        aliases?: Input<string | Alias>[];
        customTimeouts?: CustomTimeouts;
        deleteBeforeReplace?: boolean;
        deletedWith?: Resource;
        dependsOn?: Input<Resource> | Input<Input<Resource>[]>;
        id?: Input<string>;
        ignoreChanges?: string[];
        import?: string;
        parent?: Resource;
        pluginDownloadURL?: string;
        protect?: boolean;
        provider?: ProviderResource;
        replaceOnChanges?: string[];
        retainOnDelete?: boolean;
        transformations?: ResourceTransformation[];
        transforms?: ResourceTransform[];
        urn?: string;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    additionalSecretOutputs? aliases? customTimeouts? deleteBeforeReplace? @@ -23,42 +23,42 @@ This augments the list that the resource provider and Pulumi engine already determine based on inputs to your resource. It can be used to mark certain ouputs as a secrets on a per resource basis.

    -

    Optional aliases

    aliases?: Input<string | Alias>[]

    An optional list of aliases to treat this resource as matching.

    -

    Optional customTimeouts

    customTimeouts?: CustomTimeouts

    An optional customTimeouts configuration block.

    -

    Optional deleteBeforeReplace

    deleteBeforeReplace?: boolean

    When set to true, indicates that this resource should be deleted before +

    Optional aliases

    aliases?: Input<string | Alias>[]

    An optional list of aliases to treat this resource as matching.

    +

    Optional customTimeouts

    customTimeouts?: CustomTimeouts

    An optional customTimeouts configuration block.

    +

    Optional deleteBeforeReplace

    deleteBeforeReplace?: boolean

    When set to true, indicates that this resource should be deleted before its replacement is created when replacement is necessary.

    -

    Optional deletedWith

    deletedWith?: Resource

    If set, the providers Delete method will not be called for this resource +

    Optional deletedWith

    deletedWith?: Resource

    If set, the providers Delete method will not be called for this resource if specified is being deleted as well.

    -

    Optional dependsOn

    dependsOn?: Input<Resource> | Input<Input<Resource>[]>

    An optional additional explicit dependencies on other resources.

    -

    Optional id

    id?: Input<string>

    An optional existing ID to load, rather than create.

    -

    Optional ignoreChanges

    ignoreChanges?: string[]

    Ignore changes to any of the specified properties.

    -

    Optional import

    import?: string

    When provided with a resource ID, indicates that this resource's provider +

    Optional dependsOn

    dependsOn?: Input<Resource> | Input<Input<Resource>[]>

    An optional additional explicit dependencies on other resources.

    +

    Optional id

    id?: Input<string>

    An optional existing ID to load, rather than create.

    +

    Optional ignoreChanges

    ignoreChanges?: string[]

    Ignore changes to any of the specified properties.

    +

    Optional import

    import?: string

    When provided with a resource ID, indicates that this resource's provider should import its state from the cloud resource with the given ID. The inputs to the resource's constructor must align with the resource's current state. Once a resource has been imported, the import property must be removed from the resource's options.

    -

    Optional parent

    parent?: Resource

    An optional parent resource to which this resource belongs.

    -

    Optional pluginDownloadURL

    pluginDownloadURL?: string

    An option to specify the URL from which to download this resources +

    Optional parent

    parent?: Resource

    An optional parent resource to which this resource belongs.

    +

    Optional pluginDownloadURL

    pluginDownloadURL?: string

    An option to specify the URL from which to download this resources associated plugin. This version overrides the URL information inferred from the current package and should rarely be used.

    -

    Optional protect

    protect?: boolean

    When set to true, protect ensures this resource cannot be deleted.

    -

    Optional provider

    provider?: ProviderResource

    An optional provider to use for this resource's CRUD operations. If no provider is supplied, +

    Optional protect

    protect?: boolean

    When set to true, protect ensures this resource cannot be deleted.

    +

    Optional provider

    provider?: ProviderResource

    An optional provider to use for this resource's CRUD operations. If no provider is supplied, the default provider for the resource's package will be used. The default provider is pulled from the parent's provider bag (see also ComponentResourceOptions.providers).

    If this is a [ComponentResourceOptions] do not provide both [provider] and [providers]

    -

    Optional replaceOnChanges

    replaceOnChanges?: string[]

    Changes to any of these property paths will force a replacement. If this list includes "*", changes to any +

    Optional replaceOnChanges

    replaceOnChanges?: string[]

    Changes to any of these property paths will force a replacement. If this list includes "*", changes to any properties will force a replacement. Initialization errors from previous deployments will require replacement instead of update only if "*" is passed.

    -

    Optional retainOnDelete

    retainOnDelete?: boolean

    If set to True, the providers Delete method will not be called for this resource.

    -

    Optional transformations

    transformations?: ResourceTransformation[]

    Optional list of transformations to apply to this resource during construction. The +

    Optional retainOnDelete

    retainOnDelete?: boolean

    If set to True, the providers Delete method will not be called for this resource.

    +

    Optional transformations

    transformations?: ResourceTransformation[]

    Optional list of transformations to apply to this resource during construction. The transformations are applied in order, and are applied prior to transformation applied to parents walking from the resource up to the stack.

    -

    Optional transforms

    transforms?: ResourceTransform[]

    Optional list of transforms to apply to this resource during construction. The +

    Optional transforms

    transforms?: ResourceTransform[]

    Optional list of transforms to apply to this resource during construction. The transforms are applied in order, and are applied prior to transforms applied to parents walking from the resource up to the stack.

    This property is experimental.

    -

    Optional urn

    urn?: string

    The URN of a previously-registered resource of this type to read from the engine.

    -

    Optional version

    version?: string

    An optional version, corresponding to the version of the provider plugin that should be used when operating on +

    Optional urn

    urn?: string

    The URN of a previously-registered resource of this type to read from the engine.

    +

    Optional version

    version?: string

    An optional version, corresponding to the version of the provider plugin that should be used when operating on this resource. This version overrides the version information inferred from the current package and should rarely be used.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    additionalSecretOutputsaliasescustomTimeoutsdeleteBeforeReplacedeletedWithdependsOnidignoreChangesimportparentpluginDownloadURLprotectproviderreplaceOnChangesretainOnDeletetransformationstransformsurnversion

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    additionalSecretOutputsaliasescustomTimeoutsdeleteBeforeReplacedeletedWithdependsOnidignoreChangesimportparentpluginDownloadURLprotectproviderreplaceOnChangesretainOnDeletetransformationstransformsurnversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/CustomTimeouts.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/CustomTimeouts.html index 836298ca61a4..34719fd54ffb 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/CustomTimeouts.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/CustomTimeouts.html @@ -1,7 +1,7 @@ -CustomTimeouts | @pulumi/pulumi

    Interface CustomTimeouts

    interface CustomTimeouts {
        create?: string;
        delete?: string;
        update?: string;
    }

    Properties

    create? +CustomTimeouts | @pulumi/pulumi

    Interface CustomTimeouts

    interface CustomTimeouts {
        create?: string;
        delete?: string;
        update?: string;
    }

    Properties

    create? delete? update?

    Properties

    Optional create

    create?: string

    The optional create timeout represented as a string e.g. 5m, 40s, 1d.

    -

    Optional delete

    delete?: string

    The optional delete timeout represented as a string e.g. 5m, 40s, 1d.

    -

    Optional update

    update?: string

    The optional update timeout represented as a string e.g. 5m, 40s, 1d.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    createdeleteupdate

    Generated using TypeDoc

    \ No newline at end of file +

    Optional delete

    delete?: string

    The optional delete timeout represented as a string e.g. 5m, 40s, 1d.

    +

    Optional update

    update?: string

    The optional update timeout represented as a string e.g. 5m, 40s, 1d.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    createdeleteupdate

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeOptions.html index c19c5c276a91..12f03ca0ad5b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeOptions.html @@ -1,6 +1,6 @@ InvokeOptions | @pulumi/pulumi

    Interface InvokeOptions

    InvokeOptions is a bag of options that control the behavior of a call to runtime.invoke.

    -
    interface InvokeOptions {
        async?: boolean;
        parent?: Resource;
        pluginDownloadURL?: string;
        provider?: ProviderResource;
        version?: string;
    }

    Properties

    async? +
    interface InvokeOptions {
        async?: boolean;
        parent?: Resource;
        pluginDownloadURL?: string;
        provider?: ProviderResource;
        version?: string;
    }

    Properties

    async? parent? pluginDownloadURL? provider? @@ -10,12 +10,12 @@ false to get the non-Promise side of the result. Invoking data source functions synchronously is deprecated. The ability to do this will be removed at a later point in time.

    -

    Optional parent

    parent?: Resource

    An optional parent to use for default options for this invoke (e.g. the default provider to use).

    -

    Optional pluginDownloadURL

    pluginDownloadURL?: string

    An option to specify the URL from which to download this resources +

    Optional parent

    parent?: Resource

    An optional parent to use for default options for this invoke (e.g. the default provider to use).

    +

    Optional pluginDownloadURL

    pluginDownloadURL?: string

    An option to specify the URL from which to download this resources associated plugin. This version overrides the URL information inferred from the current package and should rarely be used.

    -

    Optional provider

    provider?: ProviderResource

    An optional provider to use for this invocation. If no provider is supplied, the default provider for the +

    Optional provider

    provider?: ProviderResource

    An optional provider to use for this invocation. If no provider is supplied, the default provider for the invoked function's package will be used.

    -

    Optional version

    version?: string

    An optional version, corresponding to the version of the provider plugin +

    Optional version

    version?: string

    An optional version, corresponding to the version of the provider plugin that should be used when performing this invoke.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    asyncparentpluginDownloadURLproviderversion

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    asyncparentpluginDownloadURLproviderversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeTransformArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeTransformArgs.html index 3bcacc683a8d..47a35c8a82ac 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeTransformArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeTransformArgs.html @@ -1,8 +1,8 @@ InvokeTransformArgs | @pulumi/pulumi

    Interface InvokeTransformArgs

    InvokeTransformArgs is the argument bag passed to a invoke transform.

    -
    interface InvokeTransformArgs {
        args: Inputs;
        opts: InvokeOptions;
        token: string;
    }

    Properties

    args +
    interface InvokeTransformArgs {
        args: Inputs;
        opts: InvokeOptions;
        token: string;
    }

    Properties

    args opts token

    Properties

    args

    args: Inputs

    The original args passed to the Invoke constructor.

    -

    opts

    opts: InvokeOptions

    The original invoke options passed to the Invoke constructor.

    -

    token

    token: string

    The token of the Invoke.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    argsoptstoken

    Generated using TypeDoc

    \ No newline at end of file +

    opts

    opts: InvokeOptions

    The original invoke options passed to the Invoke constructor.

    +

    token

    token: string

    The token of the Invoke.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    argsoptstoken

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeTransformResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeTransformResult.html index 020d972f8ed6..d403aa318a67 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeTransformResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeTransformResult.html @@ -1,8 +1,8 @@ InvokeTransformResult | @pulumi/pulumi

    Interface InvokeTransformResult

    InvokeTransformResult is the result that must be returned by an invoke transform callback. It includes new values to use for the args and opts of the Invoke in place of the originally provided values.

    -
    interface InvokeTransformResult {
        args: Inputs;
        opts: InvokeOptions;
    }

    Properties

    args +
    interface InvokeTransformResult {
        args: Inputs;
        opts: InvokeOptions;
    }

    Properties

    args opts

    Properties

    args

    args: Inputs

    The new properties to use in place of the original args

    -

    opts

    opts: InvokeOptions

    The new resource options to use in place of the original opts

    -

    Settings

    Member Visibility

    Theme

    On This Page

    argsopts

    Generated using TypeDoc

    \ No newline at end of file +

    opts

    opts: InvokeOptions

    The new resource options to use in place of the original opts

    +

    Settings

    Member Visibility

    Theme

    On This Page

    argsopts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/NumberConfigOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/NumberConfigOptions.html index 9af33bf9d8a7..5437a408e357 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/NumberConfigOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/NumberConfigOptions.html @@ -1,6 +1,6 @@ NumberConfigOptions | @pulumi/pulumi

    Interface NumberConfigOptions

    NumberConfigOptions may be used to constrain the set of legal values a number config value may contain.

    -
    interface NumberConfigOptions {
        max?: number;
        min?: number;
    }

    Properties

    max? +
    interface NumberConfigOptions {
        max?: number;
        min?: number;
    }

    Properties

    max? min?

    Properties

    Optional max

    max?: number

    The maximum number value, inclusive. If the number is greater than this, a ConfigRangeError is thrown.

    -

    Optional min

    min?: number

    The minimum number value, inclusive. If the number is less than this, a ConfigRangeError is thrown.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    maxmin

    Generated using TypeDoc

    \ No newline at end of file +

    Optional min

    min?: number

    The minimum number value, inclusive. If the number is less than this, a ConfigRangeError is thrown.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    maxmin

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/OutputConstructor.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/OutputConstructor.html index 30a0be9f52de..7d65df30ca91 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/OutputConstructor.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/OutputConstructor.html @@ -1,5 +1,5 @@ OutputConstructor | @pulumi/pulumi

    Interface OutputConstructor

    Static side of the Output type. Can be used to create outputs as well as test arbitrary values to see if they are Outputs.

    -
    interface OutputConstructor {
        create<T>(val): Output<Unwrap<T>>;
        create<T>(val): Output<undefined | Unwrap<T>>;
        isInstance<T>(obj): obj is Output<T>;
    }

    Methods

    create +
    interface OutputConstructor {
        create<T>(val): Output<Unwrap<T>>;
        create<T>(val): Output<undefined | Unwrap<T>>;
        isInstance<T>(obj): obj is Output<T>;
    }

    Methods

    create isInstance -

    Methods

    create

    isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    createisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    create

    isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    createisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/OutputInstance.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/OutputInstance.html index 5144ffc41aa6..1a9af3cab089 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/OutputInstance.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/OutputInstance.html @@ -1,6 +1,6 @@ OutputInstance | @pulumi/pulumi

    Interface OutputInstance<T>

    Instance side of the Output type. Exposes the deployment-time and run-time mechanisms for working with the underlying value of an Output.

    -
    interface OutputInstance<T> {
        apply<U>(func): Output<U>;
        apply<U>(func): Output<U>;
        apply<U>(func): Output<U>;
        get(): T;
    }

    Type Parameters

    • T

    Methods

    apply +
    interface OutputInstance<T> {
        apply<U>(func): Output<U>;
        apply<U>(func): Output<U>;
        apply<U>(func): Output<U>;
        get(): T;
    }

    Type Parameters

    • T

    Methods

    apply get

    Methods

    apply

    get

    get

    • get(): T

    • Retrieves the underlying value of this dependency.

      This function is only callable in code that runs in the cloud post-deployment. At this point all Output values will be known and can be safely retrieved. During Pulumi deployment or preview execution this must not be called (and will throw). This is because doing so would allow output values to flow into resources while losing the data that would allow the dependency graph to be changed.

      -

      Returns T

    Settings

    Member Visibility

    Theme

    On This Page

    applyget

    Generated using TypeDoc

    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility

    Theme

    On This Page

    applyget

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceOptions.html index 616b61faa69f..439e1b5c400b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceOptions.html @@ -1,6 +1,6 @@ ResourceOptions | @pulumi/pulumi

    Interface ResourceOptions

    ResourceOptions is a bag of optional settings that control a resource's behavior.

    -
    interface ResourceOptions {
        aliases?: Input<string | Alias>[];
        customTimeouts?: CustomTimeouts;
        deletedWith?: Resource;
        dependsOn?: Input<Resource> | Input<Input<Resource>[]>;
        id?: Input<string>;
        ignoreChanges?: string[];
        parent?: Resource;
        pluginDownloadURL?: string;
        protect?: boolean;
        provider?: ProviderResource;
        replaceOnChanges?: string[];
        retainOnDelete?: boolean;
        transformations?: ResourceTransformation[];
        transforms?: ResourceTransform[];
        urn?: string;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    aliases? +
    interface ResourceOptions {
        aliases?: Input<string | Alias>[];
        customTimeouts?: CustomTimeouts;
        deletedWith?: Resource;
        dependsOn?: Input<Resource> | Input<Input<Resource>[]>;
        id?: Input<string>;
        ignoreChanges?: string[];
        parent?: Resource;
        pluginDownloadURL?: string;
        protect?: boolean;
        provider?: ProviderResource;
        replaceOnChanges?: string[];
        retainOnDelete?: boolean;
        transformations?: ResourceTransformation[];
        transforms?: ResourceTransform[];
        urn?: string;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    aliases? customTimeouts? deletedWith? dependsOn? @@ -17,34 +17,34 @@ urn? version?

    Properties

    Optional aliases

    aliases?: Input<string | Alias>[]

    An optional list of aliases to treat this resource as matching.

    -

    Optional customTimeouts

    customTimeouts?: CustomTimeouts

    An optional customTimeouts configuration block.

    -

    Optional deletedWith

    deletedWith?: Resource

    If set, the providers Delete method will not be called for this resource +

    Optional customTimeouts

    customTimeouts?: CustomTimeouts

    An optional customTimeouts configuration block.

    +

    Optional deletedWith

    deletedWith?: Resource

    If set, the providers Delete method will not be called for this resource if specified is being deleted as well.

    -

    Optional dependsOn

    dependsOn?: Input<Resource> | Input<Input<Resource>[]>

    An optional additional explicit dependencies on other resources.

    -

    Optional id

    id?: Input<string>

    An optional existing ID to load, rather than create.

    -

    Optional ignoreChanges

    ignoreChanges?: string[]

    Ignore changes to any of the specified properties.

    -

    Optional parent

    parent?: Resource

    An optional parent resource to which this resource belongs.

    -

    Optional pluginDownloadURL

    pluginDownloadURL?: string

    An option to specify the URL from which to download this resources +

    Optional dependsOn

    dependsOn?: Input<Resource> | Input<Input<Resource>[]>

    An optional additional explicit dependencies on other resources.

    +

    Optional id

    id?: Input<string>

    An optional existing ID to load, rather than create.

    +

    Optional ignoreChanges

    ignoreChanges?: string[]

    Ignore changes to any of the specified properties.

    +

    Optional parent

    parent?: Resource

    An optional parent resource to which this resource belongs.

    +

    Optional pluginDownloadURL

    pluginDownloadURL?: string

    An option to specify the URL from which to download this resources associated plugin. This version overrides the URL information inferred from the current package and should rarely be used.

    -

    Optional protect

    protect?: boolean

    When set to true, protect ensures this resource cannot be deleted.

    -

    Optional provider

    provider?: ProviderResource

    An optional provider to use for this resource's CRUD operations. If no provider is supplied, +

    Optional protect

    protect?: boolean

    When set to true, protect ensures this resource cannot be deleted.

    +

    Optional provider

    provider?: ProviderResource

    An optional provider to use for this resource's CRUD operations. If no provider is supplied, the default provider for the resource's package will be used. The default provider is pulled from the parent's provider bag (see also ComponentResourceOptions.providers).

    If this is a [ComponentResourceOptions] do not provide both [provider] and [providers]

    -

    Optional replaceOnChanges

    replaceOnChanges?: string[]

    Changes to any of these property paths will force a replacement. If this list includes "*", changes to any +

    Optional replaceOnChanges

    replaceOnChanges?: string[]

    Changes to any of these property paths will force a replacement. If this list includes "*", changes to any properties will force a replacement. Initialization errors from previous deployments will require replacement instead of update only if "*" is passed.

    -

    Optional retainOnDelete

    retainOnDelete?: boolean

    If set to True, the providers Delete method will not be called for this resource.

    -

    Optional transformations

    transformations?: ResourceTransformation[]

    Optional list of transformations to apply to this resource during construction. The +

    Optional retainOnDelete

    retainOnDelete?: boolean

    If set to True, the providers Delete method will not be called for this resource.

    +

    Optional transformations

    transformations?: ResourceTransformation[]

    Optional list of transformations to apply to this resource during construction. The transformations are applied in order, and are applied prior to transformation applied to parents walking from the resource up to the stack.

    -

    Optional transforms

    transforms?: ResourceTransform[]

    Optional list of transforms to apply to this resource during construction. The +

    Optional transforms

    transforms?: ResourceTransform[]

    Optional list of transforms to apply to this resource during construction. The transforms are applied in order, and are applied prior to transforms applied to parents walking from the resource up to the stack.

    This property is experimental.

    -

    Optional urn

    urn?: string

    The URN of a previously-registered resource of this type to read from the engine.

    -

    Optional version

    version?: string

    An optional version, corresponding to the version of the provider plugin that should be used when operating on +

    Optional urn

    urn?: string

    The URN of a previously-registered resource of this type to read from the engine.

    +

    Optional version

    version?: string

    An optional version, corresponding to the version of the provider plugin that should be used when operating on this resource. This version overrides the version information inferred from the current package and should rarely be used.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    aliasescustomTimeoutsdeletedWithdependsOnidignoreChangesparentpluginDownloadURLprotectproviderreplaceOnChangesretainOnDeletetransformationstransformsurnversion

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    aliasescustomTimeoutsdeletedWithdependsOnidignoreChangesparentpluginDownloadURLprotectproviderreplaceOnChangesretainOnDeletetransformationstransformsurnversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformArgs.html index 2fbd11ab3f95..4536165d8781 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformArgs.html @@ -1,12 +1,12 @@ ResourceTransformArgs | @pulumi/pulumi

    Interface ResourceTransformArgs

    ResourceTransformArgs is the argument bag passed to a resource transform.

    -
    interface ResourceTransformArgs {
        custom: boolean;
        name: string;
        opts: ResourceOptions;
        props: Inputs;
        type: string;
    }

    Properties

    custom +
    interface ResourceTransformArgs {
        custom: boolean;
        name: string;
        opts: ResourceOptions;
        props: Inputs;
        type: string;
    }

    Properties

    custom name opts props type

    Properties

    custom

    custom: boolean

    True if the resource is a custom resource, false if it is a component resource.

    -

    name

    name: string

    The name of the resource.

    -

    opts

    opts: ResourceOptions

    The original resource options passed to the resource constructor.

    -

    props

    props: Inputs

    The original properties passed to the resource constructor.

    -

    type

    type: string

    The type of the resource.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    customnameoptspropstype

    Generated using TypeDoc

    \ No newline at end of file +

    name

    name: string

    The name of the resource.

    +

    opts

    opts: ResourceOptions

    The original resource options passed to the resource constructor.

    +

    props

    props: Inputs

    The original properties passed to the resource constructor.

    +

    type

    type: string

    The type of the resource.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    customnameoptspropstype

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformResult.html index 690e19cd4280..a9704b153101 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformResult.html @@ -2,8 +2,8 @@ resource transform callback. It includes new values to use for the props and opts of the Resource in place of the originally provided values.

    -
    interface ResourceTransformResult {
        opts: ResourceOptions;
        props: Inputs;
    }

    Properties

    opts +
    interface ResourceTransformResult {
        opts: ResourceOptions;
        props: Inputs;
    }

    Properties

    opts props

    Properties

    opts

    opts: ResourceOptions

    The new resource options to use in place of the original opts

    -

    props

    props: Inputs

    The new properties to use in place of the original props

    -

    Settings

    Member Visibility

    Theme

    On This Page

    optsprops

    Generated using TypeDoc

    \ No newline at end of file +

    props

    props: Inputs

    The new properties to use in place of the original props

    +

    Settings

    Member Visibility

    Theme

    On This Page

    optsprops

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformationArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformationArgs.html index d42f88791a1e..6d597aa93190 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformationArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformationArgs.html @@ -1,13 +1,13 @@ ResourceTransformationArgs | @pulumi/pulumi

    Interface ResourceTransformationArgs

    ResourceTransformationArgs is the argument bag passed to a resource transformation.

    -
    interface ResourceTransformationArgs {
        name: string;
        opts: ResourceOptions;
        props: Inputs;
        resource: Resource;
        type: string;
    }

    Properties

    name +
    interface ResourceTransformationArgs {
        name: string;
        opts: ResourceOptions;
        props: Inputs;
        resource: Resource;
        type: string;
    }

    Properties

    name opts props resource type

    Properties

    name

    name: string

    The name of the resource.

    -

    opts

    opts: ResourceOptions

    The original resource options passed to the resource constructor.

    -

    props

    props: Inputs

    The original properties passed to the resource constructor.

    -

    resource

    resource: Resource

    The Resource instance that is being transformed.

    -

    type

    type: string

    The type of the resource.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    nameoptspropsresourcetype

    Generated using TypeDoc

    \ No newline at end of file +

    opts

    opts: ResourceOptions

    The original resource options passed to the resource constructor.

    +

    props

    props: Inputs

    The original properties passed to the resource constructor.

    +

    resource

    resource: Resource

    The Resource instance that is being transformed.

    +

    type

    type: string

    The type of the resource.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    nameoptspropsresourcetype

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformationResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformationResult.html index 9d590edb3fcf..c006081c9aa3 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformationResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/ResourceTransformationResult.html @@ -2,8 +2,8 @@ resource transformation callback. It includes new values to use for the props and opts of the Resource in place of the originally provided values.

    -
    interface ResourceTransformationResult {
        opts: ResourceOptions;
        props: Inputs;
    }

    Properties

    opts +
    interface ResourceTransformationResult {
        opts: ResourceOptions;
        props: Inputs;
    }

    Properties

    opts props

    Properties

    opts

    opts: ResourceOptions

    The new resource options to use in place of the original opts

    -

    props

    props: Inputs

    The new properties to use in place of the original props

    -

    Settings

    Member Visibility

    Theme

    On This Page

    optsprops

    Generated using TypeDoc

    \ No newline at end of file +

    props

    props: Inputs

    The new properties to use in place of the original props

    +

    Settings

    Member Visibility

    Theme

    On This Page

    optsprops

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/StackReferenceArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/StackReferenceArgs.html index e656f1437290..6d23332dd582 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/StackReferenceArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/StackReferenceArgs.html @@ -1,4 +1,4 @@ StackReferenceArgs | @pulumi/pulumi

    Interface StackReferenceArgs

    The set of arguments for constructing a StackReference resource.

    -
    interface StackReferenceArgs {
        name?: Input<string>;
    }

    Properties

    name? +
    interface StackReferenceArgs {
        name?: Input<string>;
    }

    Properties

    name?

    Properties

    Optional Readonly name

    name?: Input<string>

    The name of the stack to reference.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    name

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    name

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/StackReferenceOutputDetails.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/StackReferenceOutputDetails.html index 114687c140e7..ba3e3c5fa519 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/StackReferenceOutputDetails.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/StackReferenceOutputDetails.html @@ -1,9 +1,9 @@ StackReferenceOutputDetails | @pulumi/pulumi

    Interface StackReferenceOutputDetails

    Records the output of a StackReference. Exactly one of value or secretValue will be set.

    -
    interface StackReferenceOutputDetails {
        secretValue?: any;
        value?: any;
    }

    Properties

    secretValue? +
    interface StackReferenceOutputDetails {
        secretValue?: any;
        value?: any;
    }

    Properties

    secretValue? value?

    Properties

    Optional Readonly secretValue

    secretValue?: any

    A secret value returned by the StackReference.

    This is null if the value is not a secret or it does not exist.

    -

    Optional Readonly value

    value?: any

    An output value returned by the StackReference.

    +

    Optional Readonly value

    value?: any

    An output value returned by the StackReference.

    This is null if the value is a secret or it does not exist.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    secretValuevalue

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    secretValuevalue

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/StringConfigOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/StringConfigOptions.html index 82395d4362c4..30bc80e250d7 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/StringConfigOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/StringConfigOptions.html @@ -1,10 +1,10 @@ StringConfigOptions | @pulumi/pulumi

    Interface StringConfigOptions<K>

    StringConfigOptions may be used to constrain the set of legal values a string config value may contain.

    -
    interface StringConfigOptions<K> {
        allowedValues?: K[];
        maxLength?: number;
        minLength?: number;
        pattern?: string | RegExp;
    }

    Type Parameters

    • K extends string = string

    Properties

    allowedValues? +
    interface StringConfigOptions<K> {
        allowedValues?: K[];
        maxLength?: number;
        minLength?: number;
        pattern?: string | RegExp;
    }

    Type Parameters

    • K extends string = string

    Properties

    allowedValues? maxLength? minLength? pattern?

    Properties

    Optional allowedValues

    allowedValues?: K[]

    The legal enum values. If it does not match, a ConfigEnumError is thrown.

    -

    Optional maxLength

    maxLength?: number

    The maximum string length. If the string is longer than this, a ConfigRangeError is thrown.

    -

    Optional minLength

    minLength?: number

    The minimum string length. If the string is not this long, a ConfigRangeError is thrown.

    -

    Optional pattern

    pattern?: string | RegExp

    A regular expression the string must match. If it does not match, a ConfigPatternError is thrown.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    allowedValuesmaxLengthminLengthpattern

    Generated using TypeDoc

    \ No newline at end of file +

    Optional maxLength

    maxLength?: number

    The maximum string length. If the string is longer than this, a ConfigRangeError is thrown.

    +

    Optional minLength

    minLength?: number

    The minimum string length. If the string is not this long, a ConfigRangeError is thrown.

    +

    Optional pattern

    pattern?: string | RegExp

    A regular expression the string must match. If it does not match, a ConfigPatternError is thrown.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    allowedValuesmaxLengthminLengthpattern

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ConfigValue.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ConfigValue.html index 2b24a82f7aa4..ebf54808c75c 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ConfigValue.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ConfigValue.html @@ -1,6 +1,6 @@ ConfigValue | @pulumi/pulumi

    Interface ConfigValue

    An input to/output from a pulumi config command.

    -
    interface ConfigValue {
        secret?: boolean;
        value: string;
    }

    Properties

    secret? +
    interface ConfigValue {
        secret?: boolean;
        value: string;
    }

    Properties

    secret? value

    Properties

    Optional secret

    secret?: boolean

    True if and only if this configuration value is a secret.

    -

    value

    value: string

    The underlying configuration value.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    secretvalue

    Generated using TypeDoc

    \ No newline at end of file +

    value

    value: string

    The underlying configuration value.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    secretvalue

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.Deployment.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.Deployment.html index 1a6e2269c00f..f84cc9c89441 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.Deployment.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.Deployment.html @@ -1,6 +1,6 @@ Deployment | @pulumi/pulumi

    Interface Deployment

    Deployment encapsulates the state of a stack deployment.

    -
    interface Deployment {
        deployment: any;
        version: number;
    }

    Properties

    deployment +
    interface Deployment {
        deployment: any;
        version: number;
    }

    Properties

    deployment version

    Properties

    deployment

    deployment: any

    The pulumi deployment.

    -

    version

    version: number

    Version indicates the schema of the encoded deployment.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    deploymentversion

    Generated using TypeDoc

    \ No newline at end of file +

    version

    version: number

    Version indicates the schema of the encoded deployment.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    deploymentversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DestroyOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DestroyOptions.html index c7ea031e8ece..1c46124aeb72 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DestroyOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DestroyOptions.html @@ -1,5 +1,5 @@ DestroyOptions | @pulumi/pulumi

    Interface DestroyOptions

    Options controlling the behavior of a Stack.destroy() operation.

    -
    interface DestroyOptions {
        color?: "always" | "never" | "raw" | "auto";
        continueOnError?: boolean;
        debug?: boolean;
        excludeProtected?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        remove?: boolean;
        showSecrets?: boolean;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        targetDependents?: boolean;
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    color? +
    interface DestroyOptions {
        color?: "always" | "never" | "raw" | "auto";
        continueOnError?: boolean;
        debug?: boolean;
        excludeProtected?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        remove?: boolean;
        showSecrets?: boolean;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        targetDependents?: boolean;
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    color? continueOnError? debug? excludeProtected? @@ -20,23 +20,23 @@ tracing? userAgent?

    Properties

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    -

    Optional continueOnError

    continueOnError?: boolean

    Continue the operation to completion even if errors occur.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    -

    Optional excludeProtected

    excludeProtected?: boolean

    Do not destroy protected resources.

    -

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    -

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    -

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    -

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    -

    Optional message

    message?: string

    Optional message to associate with the operation.

    -

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    -

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces output.

    -

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    -

    Optional remove

    remove?: boolean

    Remove the stack and its configuration after all resources in the stack have been deleted.

    -

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the operation summary.

    -

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    -

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    -

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    -

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    -

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    -

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    colorcontinueOnErrordebugexcludeProtectedimportFilelogFlowlogToStdErrlogVerbositymessageonEventonOutputparallelremoveshowSecretssuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file +

    Optional continueOnError

    continueOnError?: boolean

    Continue the operation to completion even if errors occur.

    +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    +

    Optional excludeProtected

    excludeProtected?: boolean

    Do not destroy protected resources.

    +

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    +

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    +

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    +

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    +

    Optional message

    message?: string

    Optional message to associate with the operation.

    +

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    +

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces output.

    +

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    +

    Optional remove

    remove?: boolean

    Remove the stack and its configuration after all resources in the stack have been deleted.

    +

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the operation summary.

    +

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    +

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    +

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    +

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    +

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    +

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    colorcontinueOnErrordebugexcludeProtectedimportFilelogFlowlogToStdErrlogVerbositymessageonEventonOutputparallelremoveshowSecretssuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DestroyResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DestroyResult.html index 82a2bf3c8c19..68621f28aa5f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DestroyResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DestroyResult.html @@ -1,8 +1,8 @@ DestroyResult | @pulumi/pulumi

    Interface DestroyResult

    Output from destroying all resources in a Stack.

    -
    interface DestroyResult {
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    stderr +
    interface DestroyResult {
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    stderr stdout summary

    Properties

    stderr

    stderr: string

    The standard error output from the destroy.

    -

    stdout

    stdout: string

    The standard output from the destroy.

    -

    summary

    summary: UpdateSummary

    A summary of the destroy.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    stderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file +

    stdout

    stdout: string

    The standard output from the destroy.

    +

    summary

    summary: UpdateSummary

    A summary of the destroy.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    stderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DiagnosticEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DiagnosticEvent.html index e12d05a2100a..9a84d1d470a8 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DiagnosticEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DiagnosticEvent.html @@ -1,10 +1,10 @@ DiagnosticEvent | @pulumi/pulumi

    Interface DiagnosticEvent

    An event emitted whenever a diagnostic message is provided, for example errors from a cloud resource provider while trying to create or update a resource.

    -
    interface DiagnosticEvent {
        color: string;
        ephemeral?: boolean;
        message: string;
        prefix?: string;
        severity: "info" | "info#err" | "warning" | "error";
        streamID?: number;
        urn?: string;
    }

    Properties

    color +
    interface DiagnosticEvent {
        color: string;
        ephemeral?: boolean;
        message: string;
        prefix?: string;
        severity: "info" | "info#err" | "warning" | "error";
        streamID?: number;
        urn?: string;
    }

    Properties

    color ephemeral? message prefix? severity streamID? urn? -

    Properties

    color

    color: string

    Optional ephemeral

    ephemeral?: boolean

    message

    message: string

    Optional prefix

    prefix?: string

    severity

    severity: "info" | "info#err" | "warning" | "error"

    Optional streamID

    streamID?: number

    Optional urn

    urn?: string

    Settings

    Member Visibility

    Theme

    On This Page

    colorephemeralmessageprefixseveritystreamIDurn

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    color

    color: string

    Optional ephemeral

    ephemeral?: boolean

    message

    message: string

    Optional prefix

    prefix?: string

    severity

    severity: "info" | "info#err" | "warning" | "error"

    Optional streamID

    streamID?: number

    Optional urn

    urn?: string

    Settings

    Member Visibility

    Theme

    On This Page

    colorephemeralmessageprefixseveritystreamIDurn

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.EngineEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.EngineEvent.html index b110f89a43c9..4e49e2f2772d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.EngineEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.EngineEvent.html @@ -1,7 +1,7 @@ EngineEvent | @pulumi/pulumi

    Interface EngineEvent

    A Pulumi engine event, such as a change to a resource or diagnostic message. This is intended to capture a discriminated union -- exactly one event field will be non-nil.

    -
    interface EngineEvent {
        cancelEvent?: CancelEvent;
        diagnosticEvent?: DiagnosticEvent;
        policyEvent?: PolicyEvent;
        preludeEvent?: PreludeEvent;
        resOpFailedEvent?: ResOpFailedEvent;
        resOutputsEvent?: ResOutputsEvent;
        resourcePreEvent?: ResourcePreEvent;
        sequence: number;
        stdoutEvent?: StdoutEngineEvent;
        summaryEvent?: SummaryEvent;
        timestamp: number;
    }

    Properties

    cancelEvent? +
    interface EngineEvent {
        cancelEvent?: CancelEvent;
        diagnosticEvent?: DiagnosticEvent;
        policyEvent?: PolicyEvent;
        preludeEvent?: PreludeEvent;
        resOpFailedEvent?: ResOpFailedEvent;
        resOutputsEvent?: ResOutputsEvent;
        resourcePreEvent?: ResourcePreEvent;
        sequence: number;
        stdoutEvent?: StdoutEngineEvent;
        summaryEvent?: SummaryEvent;
        timestamp: number;
    }

    Properties

    cancelEvent? diagnosticEvent? policyEvent? preludeEvent? @@ -13,17 +13,17 @@ summaryEvent? timestamp

    Properties

    Optional cancelEvent

    cancelEvent?: CancelEvent

    A cancellation event, if this engine event represents a cancellation.

    -

    Optional diagnosticEvent

    diagnosticEvent?: DiagnosticEvent

    A diagnostic event, if this engine event represents a diagnostic message.

    -

    Optional policyEvent

    policyEvent?: PolicyEvent

    A policy event, if this engine event represents a policy violation.

    -

    Optional preludeEvent

    preludeEvent?: PreludeEvent

    A prelude event, if this engine event represents the start of an +

    Optional diagnosticEvent

    diagnosticEvent?: DiagnosticEvent

    A diagnostic event, if this engine event represents a diagnostic message.

    +

    Optional policyEvent

    policyEvent?: PolicyEvent

    A policy event, if this engine event represents a policy violation.

    +

    Optional preludeEvent

    preludeEvent?: PreludeEvent

    A prelude event, if this engine event represents the start of an operation.

    -

    Optional resOpFailedEvent

    resOpFailedEvent?: ResOpFailedEvent

    A resource operation failed event, if this engine event represents a resource +

    Optional resOpFailedEvent

    resOpFailedEvent?: ResOpFailedEvent

    A resource operation failed event, if this engine event represents a resource operation that failed.

    -

    Optional resOutputsEvent

    resOutputsEvent?: ResOutputsEvent

    A resource outputs event, if this engine event represents a resource +

    Optional resOutputsEvent

    resOutputsEvent?: ResOutputsEvent

    A resource outputs event, if this engine event represents a resource that has been modified.

    -

    Optional resourcePreEvent

    resourcePreEvent?: ResourcePreEvent

    A resource pre-event, if this engine event represents a resource +

    Optional resourcePreEvent

    resourcePreEvent?: ResourcePreEvent

    A resource pre-event, if this engine event represents a resource about to be modified.

    -

    sequence

    sequence: number

    A unique, and monotonically increasing number for each engine event sent +

    sequence

    sequence: number

    A unique, and monotonically increasing number for each engine event sent to the Pulumi Service. Since events may be sent concurrently, and/or delayed via network routing, the sequence number is to ensure events can be placed into a total ordering.

    @@ -32,7 +32,7 @@
  • Events with a lower sequence number must have been emitted before those with a higher sequence number.
    • -

    Optional stdoutEvent

    stdoutEvent?: StdoutEngineEvent

    A stdout event, if this engine event represents a message written to stdout.

    -

    Optional summaryEvent

    summaryEvent?: SummaryEvent

    A summary event, if this engine event represents the end of an operation.

    -

    timestamp

    timestamp: number

    Timestamp is a Unix timestamp (seconds) of when the event was emitted.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    cancelEventdiagnosticEventpolicyEventpreludeEventresOpFailedEventresOutputsEventresourcePreEventsequencestdoutEventsummaryEventtimestamp

    Generated using TypeDoc

    \ No newline at end of file +

    Optional stdoutEvent

    stdoutEvent?: StdoutEngineEvent

    A stdout event, if this engine event represents a message written to stdout.

    +

    Optional summaryEvent

    summaryEvent?: SummaryEvent

    A summary event, if this engine event represents the end of an operation.

    +

    timestamp

    timestamp: number

    Timestamp is a Unix timestamp (seconds) of when the event was emitted.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    cancelEventdiagnosticEventpolicyEventpreludeEventresOpFailedEventresOutputsEventresourcePreEventsequencestdoutEventsummaryEventtimestamp

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.GlobalOpts.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.GlobalOpts.html index a6467f6c2321..80581e3e479f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.GlobalOpts.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.GlobalOpts.html @@ -1,4 +1,4 @@ -GlobalOpts | @pulumi/pulumi

    Interface GlobalOpts

    interface GlobalOpts {
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        tracing?: string;
    }

    Hierarchy (view full)

    Properties

    color? +GlobalOpts | @pulumi/pulumi

    Interface GlobalOpts

    interface GlobalOpts {
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        tracing?: string;
    }

    Hierarchy (view full)

    Properties

    color? debug? importFile? logFlow? @@ -8,12 +8,12 @@ suppressProgress? tracing?

    Properties

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    -

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    -

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    -

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    -

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    -

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    -

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    -

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    colordebugimportFilelogFlowlogToStdErrlogVerbositysuppressOutputssuppressProgresstracing

    Generated using TypeDoc

    \ No newline at end of file +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    +

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    +

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    +

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    +

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    +

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    +

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    +

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    colordebugimportFilelogFlowlogToStdErrlogVerbositysuppressOutputssuppressProgresstracing

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportOptions.html index 20f6247eb0d7..e3281cb87f8e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportOptions.html @@ -1,5 +1,5 @@ ImportOptions | @pulumi/pulumi

    Interface ImportOptions

    Options controlling the behavior of a Stack.import() operation.

    -
    interface ImportOptions {
        color?: "always" | "never" | "raw" | "auto";
        converter?: string;
        converterArgs?: string[];
        debug?: boolean;
        generateCode?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        nameTable?: {
            [key: string]: string;
        };
        onOutput?: ((out) => void);
        protect?: boolean;
        resources?: ImportResource[];
        showSecrets?: boolean;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        tracing?: string;
    }

    Hierarchy (view full)

    Properties

    color? +
    interface ImportOptions {
        color?: "always" | "never" | "raw" | "auto";
        converter?: string;
        converterArgs?: string[];
        debug?: boolean;
        generateCode?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        nameTable?: {
            [key: string]: string;
        };
        onOutput?: ((out) => void);
        protect?: boolean;
        resources?: ImportResource[];
        showSecrets?: boolean;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        tracing?: string;
    }

    Hierarchy (view full)

    Properties

    color? converter? converterArgs? debug? @@ -18,23 +18,23 @@ suppressProgress? tracing?

    Properties

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    -

    Optional converter

    converter?: string

    Specify the name of a converter to import resources from.

    -

    Optional converterArgs

    converterArgs?: string[]

    Additional arguments to pass to the converter, if the user specified one.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    -

    Optional generateCode

    generateCode?: boolean

    Generate resource declaration code for the imported resources. Set to true by default.

    -

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    -

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    -

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    -

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    -

    Optional message

    message?: string

    Optional message to associate with the import operation

    -

    Optional nameTable

    nameTable?: {
        [key: string]: string;
    }

    The name table maps language names to parent and provider URNs. These names are +

    Optional converter

    converter?: string

    Specify the name of a converter to import resources from.

    +

    Optional converterArgs

    converterArgs?: string[]

    Additional arguments to pass to the converter, if the user specified one.

    +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    +

    Optional generateCode

    generateCode?: boolean

    Generate resource declaration code for the imported resources. Set to true by default.

    +

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    +

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    +

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    +

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    +

    Optional message

    message?: string

    Optional message to associate with the import operation

    +

    Optional nameTable

    nameTable?: {
        [key: string]: string;
    }

    The name table maps language names to parent and provider URNs. These names are used in the generated definitions, and should match the corresponding declarations in the source program. This table is required if any parents or providers are specified by the resources to import.

    -

    Type declaration

    • [key: string]: string

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional protect

    protect?: boolean

    Allow resources to be imported with protection from deletion enabled. Set to true by default.

    -

    Optional resources

    resources?: ImportResource[]

    The resource definitions to import into the stack

    -

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the import result summary

    -

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    -

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    -

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    colorconverterconverterArgsdebuggenerateCodeimportFilelogFlowlogToStdErrlogVerbositymessagenameTableonOutputprotectresourcesshowSecretssuppressOutputssuppressProgresstracing

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • [key: string]: string

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional protect

    protect?: boolean

    Allow resources to be imported with protection from deletion enabled. Set to true by default.

    +

    Optional resources

    resources?: ImportResource[]

    The resource definitions to import into the stack

    +

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the import result summary

    +

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    +

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    +

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    colorconverterconverterArgsdebuggenerateCodeimportFilelogFlowlogToStdErrlogVerbositymessagenameTableonOutputprotectresourcesshowSecretssuppressOutputssuppressProgresstracing

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResource.html index 765a3fc53672..64c1509e70ce 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResource.html @@ -1,4 +1,4 @@ -ImportResource | @pulumi/pulumi

    Interface ImportResource

    interface ImportResource {
        component?: boolean;
        id?: string;
        logicalName?: string;
        name: string;
        parent?: string;
        pluginDownloadUrl?: string;
        properties?: string[];
        provider?: string;
        remote?: boolean;
        type: string;
        version?: string;
    }

    Properties

    component? +ImportResource | @pulumi/pulumi

    Interface ImportResource

    interface ImportResource {
        component?: boolean;
        id?: string;
        logicalName?: string;
        name: string;
        parent?: string;
        pluginDownloadUrl?: string;
        properties?: string[];
        provider?: string;
        remote?: boolean;
        type: string;
        version?: string;
    }

    Properties

    component? id? logicalName? name @@ -9,7 +9,7 @@ remote? type version? -

    Properties

    Optional component

    component?: boolean

    Optional id

    id?: string

    The ID of the resource to import. The format of the ID is specific to the resource type.

    -

    Optional logicalName

    logicalName?: string

    name

    name: string

    The name of the resource to import

    -

    Optional parent

    parent?: string

    Optional pluginDownloadUrl

    pluginDownloadUrl?: string

    Optional properties

    properties?: string[]

    Optional provider

    provider?: string

    Optional remote

    remote?: boolean

    type

    type: string

    The type of the resource to import

    -

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    componentidlogicalNamenameparentpluginDownloadUrlpropertiesproviderremotetypeversion

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional component

    component?: boolean

    Optional id

    id?: string

    The ID of the resource to import. The format of the ID is specific to the resource type.

    +

    Optional logicalName

    logicalName?: string

    name

    name: string

    The name of the resource to import

    +

    Optional parent

    parent?: string

    Optional pluginDownloadUrl

    pluginDownloadUrl?: string

    Optional properties

    properties?: string[]

    Optional provider

    provider?: string

    Optional remote

    remote?: boolean

    type

    type: string

    The type of the resource to import

    +

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    componentidlogicalNamenameparentpluginDownloadUrlpropertiesproviderremotetypeversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResult.html index dbca8855eb78..f9b5af0d065a 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResult.html @@ -1,6 +1,6 @@ ImportResult | @pulumi/pulumi

    Interface ImportResult

    The output from performing an import operation.

    -
    interface ImportResult {
        generatedCode: string;
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    generatedCode +
    interface ImportResult {
        generatedCode: string;
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    generatedCode stderr stdout summary -

    Properties

    generatedCode

    generatedCode: string

    stderr

    stderr: string

    stdout

    stdout: string

    summary

    summary: UpdateSummary

    Settings

    Member Visibility

    Theme

    On This Page

    generatedCodestderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    generatedCode

    generatedCode: string

    stderr

    stderr: string

    stdout

    stdout: string

    summary

    summary: UpdateSummary

    Settings

    Member Visibility

    Theme

    On This Page

    generatedCodestderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.InlineProgramArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.InlineProgramArgs.html index 2f46ba2df208..fc41bbe438d9 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.InlineProgramArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.InlineProgramArgs.html @@ -1,8 +1,8 @@ InlineProgramArgs | @pulumi/pulumi

    Interface InlineProgramArgs

    Description of a stack backed by an inline (in process) Pulumi program.

    -
    interface InlineProgramArgs {
        program: PulumiFn;
        projectName: string;
        stackName: string;
    }

    Properties

    program +
    interface InlineProgramArgs {
        program: PulumiFn;
        projectName: string;
        stackName: string;
    }

    Properties

    program projectName stackName

    Properties

    program

    program: PulumiFn

    The inline (in-process) Pulumi program to use with update and preview operations.

    -

    projectName

    projectName: string

    The associated project name.

    -

    stackName

    stackName: string

    The associated stack name.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    programprojectNamestackName

    Generated using TypeDoc

    \ No newline at end of file +

    projectName

    projectName: string

    The associated project name.

    +

    stackName

    stackName: string

    The associated stack name.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    programprojectNamestackName

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ListOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ListOptions.html index e39be2e7ae39..4aea3563d348 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ListOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ListOptions.html @@ -1,3 +1,3 @@ -ListOptions | @pulumi/pulumi

    Interface ListOptions

    interface ListOptions {
        all?: boolean;
    }

    Properties

    all? +ListOptions | @pulumi/pulumi

    Interface ListOptions

    interface ListOptions {
        all?: boolean;
    }

    Properties

    all?

    Properties

    Optional all

    all?: boolean

    List all stacks instead of just stacks for the current project

    -

    Settings

    Member Visibility

    Theme

    On This Page

    all

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    all

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalProgramArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalProgramArgs.html index fa64553bc626..f3f1f9f6786b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalProgramArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalProgramArgs.html @@ -1,6 +1,6 @@ LocalProgramArgs | @pulumi/pulumi

    Interface LocalProgramArgs

    Description of a stack backed by pre-existing local Pulumi CLI program.

    -
    interface LocalProgramArgs {
        stackName: string;
        workDir: string;
    }

    Properties

    stackName +
    interface LocalProgramArgs {
        stackName: string;
        workDir: string;
    }

    Properties

    stackName workDir

    Properties

    stackName

    stackName: string

    The associated stack name.

    -

    workDir

    workDir: string

    The working directory of the program.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    stackNameworkDir

    Generated using TypeDoc

    \ No newline at end of file +

    workDir

    workDir: string

    The working directory of the program.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    stackNameworkDir

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalWorkspaceOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalWorkspaceOptions.html index c335defbe961..aea7fc090db1 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalWorkspaceOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalWorkspaceOptions.html @@ -1,6 +1,6 @@ LocalWorkspaceOptions | @pulumi/pulumi

    Interface LocalWorkspaceOptions

    Extensibility options to configure a ; e.g: settings to seed and environment variables to pass through to every command.

    -
    interface LocalWorkspaceOptions {
        envVars?: {
            [key: string]: string;
        };
        program?: PulumiFn;
        projectSettings?: ProjectSettings;
        pulumiCommand?: PulumiCommand;
        pulumiHome?: string;
        secretsProvider?: string;
        stackSettings?: {
            [key: string]: StackSettings;
        };
        workDir?: string;
    }

    Properties

    envVars? +
    interface LocalWorkspaceOptions {
        envVars?: {
            [key: string]: string;
        };
        program?: PulumiFn;
        projectSettings?: ProjectSettings;
        pulumiCommand?: PulumiCommand;
        pulumiHome?: string;
        secretsProvider?: string;
        stackSettings?: {
            [key: string]: StackSettings;
        };
        workDir?: string;
    }

    Properties

    envVars? program? projectSettings? pulumiCommand? @@ -9,15 +9,15 @@ stackSettings? workDir?

    Properties

    Optional envVars

    envVars?: {
        [key: string]: string;
    }

    Environment values scoped to the current workspace. These will be supplied to every Pulumi command.

    -

    Type declaration

    • [key: string]: string

    Optional program

    program?: PulumiFn

    The inline program PulumiFn to be used for preview/update +

    Type declaration

    • [key: string]: string

    Optional program

    program?: PulumiFn

    The inline program PulumiFn to be used for preview/update operations, if any. If none is specified, the stack will refer to ProjectSettings for this information.

    -

    Optional projectSettings

    projectSettings?: ProjectSettings

    The settings object for the current project.

    -

    Optional pulumiCommand

    pulumiCommand?: PulumiCommand

    The underlying Pulumi CLI.

    -

    Optional pulumiHome

    pulumiHome?: string

    The directory to override for CLI metadata

    -

    Optional secretsProvider

    secretsProvider?: string

    The secrets provider to use for encryption and decryption of stack secrets. +

    Optional projectSettings

    projectSettings?: ProjectSettings

    The settings object for the current project.

    +

    Optional pulumiCommand

    pulumiCommand?: PulumiCommand

    The underlying Pulumi CLI.

    +

    Optional pulumiHome

    pulumiHome?: string

    The directory to override for CLI metadata

    +

    Optional secretsProvider

    secretsProvider?: string

    The secrets provider to use for encryption and decryption of stack secrets. See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providers

    -

    Optional stackSettings

    stackSettings?: {
        [key: string]: StackSettings;
    }

    A map of stack names and corresponding settings objects.

    -

    Type declaration

    Optional workDir

    workDir?: string

    The directory to run Pulumi commands and read settings (Pulumi.yaml and +

    Optional stackSettings

    stackSettings?: {
        [key: string]: StackSettings;
    }

    A map of stack names and corresponding settings objects.

    +

    Type declaration

    Optional workDir

    workDir?: string

    The directory to run Pulumi commands and read settings (Pulumi.yaml and Pulumi.<stack>.yaml).

    -

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsprogramprojectSettingspulumiCommandpulumiHomesecretsProviderstackSettingsworkDir

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsprogramprojectSettingspulumiCommandpulumiHomesecretsProviderstackSettingsworkDir

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.OutputValue.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.OutputValue.html index 6c156634e3aa..f970383b26bd 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.OutputValue.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.OutputValue.html @@ -1,6 +1,6 @@ OutputValue | @pulumi/pulumi

    Interface OutputValue

    An output produced by a Pulumi program as part of a stack operation.

    -
    interface OutputValue {
        secret: boolean;
        value: any;
    }

    Properties

    secret +
    interface OutputValue {
        secret: boolean;
        value: any;
    }

    Properties

    secret value

    Properties

    secret

    secret: boolean

    True if and only if the value represents a secret.

    -

    value

    value: any

    The underlying output value.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    secretvalue

    Generated using TypeDoc

    \ No newline at end of file +

    value

    value: any

    The underlying output value.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    secretvalue

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PluginInfo.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PluginInfo.html index 9be4ac3ee577..c2f8910760dd 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PluginInfo.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PluginInfo.html @@ -1,4 +1,4 @@ -PluginInfo | @pulumi/pulumi

    Interface PluginInfo

    interface PluginInfo {
        installTime: Date;
        kind: PluginKind;
        lastUsedTime: Date;
        name: string;
        path: string;
        serverURL: string;
        size: number;
        version?: string;
    }

    Properties

    installTime +PluginInfo | @pulumi/pulumi

    Interface PluginInfo

    interface PluginInfo {
        installTime: Date;
        kind: PluginKind;
        lastUsedTime: Date;
        name: string;
        path: string;
        serverURL: string;
        size: number;
        version?: string;
    }

    Properties

    installTime kind lastUsedTime name @@ -6,4 +6,4 @@ serverURL size version? -

    Properties

    installTime

    installTime: Date

    kind

    kind: PluginKind

    lastUsedTime

    lastUsedTime: Date

    name

    name: string

    path

    path: string

    serverURL

    serverURL: string

    size

    size: number

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    installTimekindlastUsedTimenamepathserverURLsizeversion

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    installTime

    installTime: Date

    kind

    kind: PluginKind

    lastUsedTime

    lastUsedTime: Date

    name

    name: string

    path

    path: string

    serverURL

    serverURL: string

    size

    size: number

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    installTimekindlastUsedTimenamepathserverURLsizeversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PolicyEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PolicyEvent.html index 4024bff16aba..58b9458c9c61 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PolicyEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PolicyEvent.html @@ -1,5 +1,5 @@ PolicyEvent | @pulumi/pulumi

    Interface PolicyEvent

    An event emitted whenever there is a policy violation.

    -
    interface PolicyEvent {
        color: string;
        enforcementLevel: "warning" | "mandatory";
        message: string;
        policyName: string;
        policyPackName: string;
        policyPackVersion: string;
        policyPackVersionTag: string;
        resourceUrn?: string;
    }

    Properties

    color +
    interface PolicyEvent {
        color: string;
        enforcementLevel: "warning" | "mandatory";
        message: string;
        policyName: string;
        policyPackName: string;
        policyPackVersion: string;
        policyPackVersionTag: string;
        resourceUrn?: string;
    }

    Properties

    color enforcementLevel message policyName @@ -7,4 +7,4 @@ policyPackVersion policyPackVersionTag resourceUrn? -

    Properties

    color

    color: string

    enforcementLevel

    enforcementLevel: "warning" | "mandatory"

    message

    message: string

    policyName

    policyName: string

    policyPackName

    policyPackName: string

    policyPackVersion

    policyPackVersion: string

    policyPackVersionTag

    policyPackVersionTag: string

    Optional resourceUrn

    resourceUrn?: string

    Settings

    Member Visibility

    Theme

    On This Page

    colorenforcementLevelmessagepolicyNamepolicyPackNamepolicyPackVersionpolicyPackVersionTagresourceUrn

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    color

    color: string

    enforcementLevel

    enforcementLevel: "warning" | "mandatory"

    message

    message: string

    policyName

    policyName: string

    policyPackName

    policyPackName: string

    policyPackVersion

    policyPackVersion: string

    policyPackVersionTag

    policyPackVersionTag: string

    Optional resourceUrn

    resourceUrn?: string

    Settings

    Member Visibility

    Theme

    On This Page

    colorenforcementLevelmessagepolicyNamepolicyPackNamepolicyPackVersionpolicyPackVersionTagresourceUrn

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreludeEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreludeEvent.html index ddce33e8ed18..6a38c61c71b6 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreludeEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreludeEvent.html @@ -1,4 +1,4 @@ PreludeEvent | @pulumi/pulumi

    Interface PreludeEvent

    An event emitted at the start of an update.

    -
    interface PreludeEvent {
        config: Record<string, string>;
    }

    Properties

    config +
    interface PreludeEvent {
        config: Record<string, string>;
    }

    Properties

    config

    Properties

    config

    config: Record<string, string>

    Configuration values that will be used during the update.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    config

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    config

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewOptions.html index 777ffab6031c..0a5a9c1d260f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewOptions.html @@ -1,5 +1,5 @@ PreviewOptions | @pulumi/pulumi

    Interface PreviewOptions

    Options controlling the behavior of a Stack.preview() operation.

    -
    interface PreviewOptions {
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        diff?: boolean;
        expectNoChanges?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        plan?: string;
        policyPackConfigs?: string[];
        policyPacks?: string[];
        program?: PulumiFn;
        refresh?: boolean;
        replace?: string[];
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        targetDependents?: boolean;
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    color? +
    interface PreviewOptions {
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        diff?: boolean;
        expectNoChanges?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        plan?: string;
        policyPackConfigs?: string[];
        policyPacks?: string[];
        program?: PulumiFn;
        refresh?: boolean;
        replace?: string[];
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        targetDependents?: boolean;
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    color? debug? diff? expectNoChanges? @@ -24,27 +24,27 @@ tracing? userAgent?

    Properties

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    -

    Optional diff

    diff?: boolean

    Display the operation as a rich diff showing the overall change.

    -

    Optional expectNoChanges

    expectNoChanges?: boolean

    Return an error if any changes occur during this operation.

    -

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    -

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    -

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    -

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    -

    Optional message

    message?: string

    Optional message to associate with the operation.

    -

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    -

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces output.

    -

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    -

    Optional plan

    plan?: string

    Plan specifies the path where the update plan should be saved.

    -

    Optional policyPackConfigs

    policyPackConfigs?: string[]

    A set of paths to JSON files containing configuration for the supplied policyPacks.

    -

    Optional policyPacks

    policyPacks?: string[]

    Run one or more policy packs as part of this operation.

    -

    Optional program

    program?: PulumiFn

    An inline (in-process) Pulumi program to execute the operation against.

    -

    Optional refresh

    refresh?: boolean

    Refresh the state of the stack's resources against the cloud provider before running preview.

    -

    Optional replace

    replace?: string[]

    Specify a set of resource URNs to replace.

    -

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    -

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    -

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    -

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    -

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    -

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    colordebugdiffexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonEventonOutputparallelplanpolicyPackConfigspolicyPacksprogramrefreshreplacesuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    +

    Optional diff

    diff?: boolean

    Display the operation as a rich diff showing the overall change.

    +

    Optional expectNoChanges

    expectNoChanges?: boolean

    Return an error if any changes occur during this operation.

    +

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    +

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    +

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    +

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    +

    Optional message

    message?: string

    Optional message to associate with the operation.

    +

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    +

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces output.

    +

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    +

    Optional plan

    plan?: string

    Plan specifies the path where the update plan should be saved.

    +

    Optional policyPackConfigs

    policyPackConfigs?: string[]

    A set of paths to JSON files containing configuration for the supplied policyPacks.

    +

    Optional policyPacks

    policyPacks?: string[]

    Run one or more policy packs as part of this operation.

    +

    Optional program

    program?: PulumiFn

    An inline (in-process) Pulumi program to execute the operation against.

    +

    Optional refresh

    refresh?: boolean

    Refresh the state of the stack's resources against the cloud provider before running preview.

    +

    Optional replace

    replace?: string[]

    Specify a set of resource URNs to replace.

    +

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    +

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    +

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    +

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    +

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    +

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    colordebugdiffexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonEventonOutputparallelplanpolicyPackConfigspolicyPacksprogramrefreshreplacesuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewResult.html index 7a836688feef..acbf4d24bfc8 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewResult.html @@ -1,9 +1,9 @@ PreviewResult | @pulumi/pulumi

    Interface PreviewResult

    Output from running a Pulumi program preview.

    -
    interface PreviewResult {
        changeSummary: OpMap;
        stderr: string;
        stdout: string;
    }

    Properties

    changeSummary +
    interface PreviewResult {
        changeSummary: OpMap;
        stderr: string;
        stdout: string;
    }

    Properties

    changeSummary stderr stdout

    Properties

    changeSummary

    changeSummary: OpMap

    A summary of the changes yielded by the operation (e.g. 4 unchanged, 3 created, etc.).

    -

    stderr

    stderr: string

    The standard error output from the preview.

    -

    stdout

    stdout: string

    The standard output from the preview.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    changeSummarystderrstdout

    Generated using TypeDoc

    \ No newline at end of file +

    stderr

    stderr: string

    The standard error output from the preview.

    +

    stdout

    stdout: string

    The standard output from the preview.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    changeSummarystderrstdout

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectBackend.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectBackend.html index 6471913249ae..c6d6cecfa502 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectBackend.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectBackend.html @@ -1,3 +1,3 @@ ProjectBackend | @pulumi/pulumi

    Interface ProjectBackend

    Configuration for the project's Pulumi state storage backend.

    -
    interface ProjectBackend {
        url?: string;
    }

    Properties

    url? -

    Properties

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    url

    Generated using TypeDoc

    \ No newline at end of file +
    interface ProjectBackend {
        url?: string;
    }

    Properties

    url? +

    Properties

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    url

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectRuntimeInfo.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectRuntimeInfo.html index aca912a07d89..72a42a7e7e89 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectRuntimeInfo.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectRuntimeInfo.html @@ -1,4 +1,4 @@ ProjectRuntimeInfo | @pulumi/pulumi

    Interface ProjectRuntimeInfo

    A description of the project's program runtime and associated metadata.

    -
    interface ProjectRuntimeInfo {
        name: string;
        options?: {
            [key: string]: any;
        };
    }

    Properties

    name +
    interface ProjectRuntimeInfo {
        name: string;
        options?: {
            [key: string]: any;
        };
    }

    Properties

    name options? -

    Properties

    name

    name: string

    Optional options

    options?: {
        [key: string]: any;
    }

    Type declaration

    • [key: string]: any

    Settings

    Member Visibility

    Theme

    On This Page

    nameoptions

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    name

    name: string

    Optional options

    options?: {
        [key: string]: any;
    }

    Type declaration

    • [key: string]: any

    Settings

    Member Visibility

    Theme

    On This Page

    nameoptions

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectSettings.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectSettings.html index 7377fd542869..012835368f25 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectSettings.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectSettings.html @@ -1,6 +1,6 @@ ProjectSettings | @pulumi/pulumi

    Interface ProjectSettings

    A Pulumi project manifest. It describes metadata applying to all sub-stacks created from the project.

    -
    interface ProjectSettings {
        author?: string;
        backend?: ProjectBackend;
        config?: string;
        description?: string;
        license?: string;
        main?: string;
        name: string;
        runtime: ProjectRuntimeInfo | ProjectRuntime;
        template?: ProjectTemplate;
        website?: string;
    }

    Properties

    author? +
    interface ProjectSettings {
        author?: string;
        backend?: ProjectBackend;
        config?: string;
        description?: string;
        license?: string;
        main?: string;
        name: string;
        runtime: ProjectRuntimeInfo | ProjectRuntime;
        template?: ProjectTemplate;
        website?: string;
    }

    Properties

    author? backend? config? description? @@ -10,4 +10,4 @@ runtime template? website? -

    Properties

    Optional author

    author?: string

    Optional backend

    backend?: ProjectBackend

    Optional config

    config?: string

    Optional description

    description?: string

    Optional license

    license?: string

    Optional main

    main?: string

    name

    name: string

    runtime

    runtime: ProjectRuntimeInfo | ProjectRuntime

    Optional template

    template?: ProjectTemplate

    Optional website

    website?: string

    Settings

    Member Visibility

    Theme

    On This Page

    authorbackendconfigdescriptionlicensemainnameruntimetemplatewebsite

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional author

    author?: string

    Optional backend

    backend?: ProjectBackend

    Optional config

    config?: string

    Optional description

    description?: string

    Optional license

    license?: string

    Optional main

    main?: string

    name

    name: string

    runtime

    runtime: ProjectRuntimeInfo | ProjectRuntime

    Optional template

    template?: ProjectTemplate

    Optional website

    website?: string

    Settings

    Member Visibility

    Theme

    On This Page

    authorbackendconfigdescriptionlicensemainnameruntimetemplatewebsite

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplate.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplate.html index 54bf00228f89..2823082deba0 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplate.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplate.html @@ -1,6 +1,6 @@ ProjectTemplate | @pulumi/pulumi

    Interface ProjectTemplate

    A template used to seed new stacks created from this project.

    -
    interface ProjectTemplate {
        config?: {
            [key: string]: ProjectTemplateConfigValue;
        };
        description?: string;
        important?: boolean;
        quickstart?: string;
    }

    Properties

    config? +
    interface ProjectTemplate {
        config?: {
            [key: string]: ProjectTemplateConfigValue;
        };
        description?: string;
        important?: boolean;
        quickstart?: string;
    }

    Properties

    config? description? important? quickstart? -

    Properties

    Optional config

    config?: {
        [key: string]: ProjectTemplateConfigValue;
    }

    Type declaration

    Optional description

    description?: string

    Optional important

    important?: boolean

    Optional quickstart

    quickstart?: string

    Settings

    Member Visibility

    Theme

    On This Page

    configdescriptionimportantquickstart

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional config

    config?: {
        [key: string]: ProjectTemplateConfigValue;
    }

    Type declaration

    Optional description

    description?: string

    Optional important

    important?: boolean

    Optional quickstart

    quickstart?: string

    Settings

    Member Visibility

    Theme

    On This Page

    configdescriptionimportantquickstart

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplateConfigValue.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplateConfigValue.html index 06f6fff67d11..17fd575e7a6c 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplateConfigValue.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplateConfigValue.html @@ -1,5 +1,5 @@ ProjectTemplateConfigValue | @pulumi/pulumi

    Interface ProjectTemplateConfigValue

    A placeholder config value for a project template.

    -
    interface ProjectTemplateConfigValue {
        default?: string;
        description?: string;
        secret?: boolean;
    }

    Properties

    default? +
    interface ProjectTemplateConfigValue {
        default?: string;
        description?: string;
        secret?: boolean;
    }

    Properties

    default? description? secret? -

    Properties

    Optional default

    default?: string

    Optional description

    description?: string

    Optional secret

    secret?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    defaultdescriptionsecret

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional default

    default?: string

    Optional description

    description?: string

    Optional secret

    secret?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    defaultdescriptionsecret

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PropertyDiff.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PropertyDiff.html index ad26752d79c8..9b5f71827210 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PropertyDiff.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PropertyDiff.html @@ -1,7 +1,7 @@ PropertyDiff | @pulumi/pulumi

    Interface PropertyDiff

    A PropertyDiff describes the difference between a single property's old and new values.

    -
    interface PropertyDiff {
        diffKind: DiffKind;
        inputDiff: boolean;
    }

    Properties

    diffKind +
    interface PropertyDiff {
        diffKind: DiffKind;
        inputDiff: boolean;
    }

    Properties

    diffKind inputDiff

    Properties

    diffKind

    diffKind: DiffKind

    diffKind is the kind of difference.

    -

    inputDiff

    inputDiff: boolean

    inputDiff is true if this is a difference between old and new inputs +

    inputDiff

    inputDiff: boolean

    inputDiff is true if this is a difference between old and new inputs rather than old state and new inputs.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    diffKindinputDiff

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    diffKindinputDiff

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PulumiCommandOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PulumiCommandOptions.html index e268c9ea53e4..669170857aed 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PulumiCommandOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PulumiCommandOptions.html @@ -1,8 +1,8 @@ -PulumiCommandOptions | @pulumi/pulumi

    Interface PulumiCommandOptions

    interface PulumiCommandOptions {
        root?: string;
        skipVersionCheck?: boolean;
        version?: SemVer;
    }

    Properties

    root? +PulumiCommandOptions | @pulumi/pulumi

    Interface PulumiCommandOptions

    interface PulumiCommandOptions {
        root?: string;
        skipVersionCheck?: boolean;
        version?: SemVer;
    }

    Properties

    root? skipVersionCheck? version?

    Properties

    Optional root

    root?: string

    The directory to install the CLI in or where to look for an existing installation. Defaults to $HOME/.pulumi/versions/$VERSION.

    -

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Skips the minimum CLI version check, see PULUMI_AUTOMATION_API_SKIP_VERSION_CHECK.

    -

    Optional version

    version?: SemVer

    The version of the CLI to use. Defaults to the CLI version matching the SDK version.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    rootskipVersionCheckversion

    Generated using TypeDoc

    \ No newline at end of file +

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Skips the minimum CLI version check, see PULUMI_AUTOMATION_API_SKIP_VERSION_CHECK.

    +

    Optional version

    version?: SemVer

    The version of the CLI to use. Defaults to the CLI version matching the SDK version.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    rootskipVersionCheckversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshOptions.html index 25fbbfd8715c..a457a7e566d4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshOptions.html @@ -1,5 +1,5 @@ RefreshOptions | @pulumi/pulumi

    Interface RefreshOptions

    Options controlling the behavior of a Stack.refresh() operation.

    -
    interface RefreshOptions {
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        expectNoChanges?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        showSecrets?: boolean;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    color? +
    interface RefreshOptions {
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        expectNoChanges?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        showSecrets?: boolean;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    color? debug? expectNoChanges? importFile? @@ -17,20 +17,20 @@ tracing? userAgent?

    Properties

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    -

    Optional expectNoChanges

    expectNoChanges?: boolean

    Return an error if any changes occur during this operation.

    -

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    -

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    -

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    -

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    -

    Optional message

    message?: string

    Optional message to associate with the operation.

    -

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    -

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces output.

    -

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    -

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the operation summary.

    -

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    -

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    -

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    -

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    -

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    colordebugexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonEventonOutputparallelshowSecretssuppressOutputssuppressProgresstargettracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    +

    Optional expectNoChanges

    expectNoChanges?: boolean

    Return an error if any changes occur during this operation.

    +

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    +

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    +

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    +

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    +

    Optional message

    message?: string

    Optional message to associate with the operation.

    +

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    +

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces output.

    +

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    +

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the operation summary.

    +

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    +

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    +

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    +

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    +

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    colordebugexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonEventonOutputparallelshowSecretssuppressOutputssuppressProgresstargettracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshResult.html index 223b3f8adbda..4f2c9bc74eb3 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshResult.html @@ -1,8 +1,8 @@ RefreshResult | @pulumi/pulumi

    Interface RefreshResult

    Output from refreshing the resources in a given Stack.

    -
    interface RefreshResult {
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    stderr +
    interface RefreshResult {
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    stderr stdout summary

    Properties

    stderr

    stderr: string

    The standard error output from the refresh.

    -

    stdout

    stdout: string

    The standard output from the refresh.

    -

    summary

    summary: UpdateSummary

    A summary of the refresh.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    stderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file +

    stdout

    stdout: string

    The standard output from the refresh.

    +

    summary

    summary: UpdateSummary

    A summary of the refresh.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    stderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteDestroyOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteDestroyOptions.html index 902be1a31bad..9bef3a16ad1e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteDestroyOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteDestroyOptions.html @@ -1,4 +1,4 @@ RemoteDestroyOptions | @pulumi/pulumi

    Interface RemoteDestroyOptions

    Options controlling the behavior of a RemoteStack.destroy operation.

    -
    interface RemoteDestroyOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? +
    interface RemoteDestroyOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? onOutput? -

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitAuthArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitAuthArgs.html index d9074b0e397d..164e6fed5a05 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitAuthArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitAuthArgs.html @@ -6,17 +6,17 @@
  • Username and password (basic authentication)

    • Only one authentication path is valid.

    -
    interface RemoteGitAuthArgs {
        password?: string;
        personalAccessToken?: string;
        sshPrivateKey?: string;
        sshPrivateKeyPath?: string;
        username?: string;
    }

    Properties

    password? +
    interface RemoteGitAuthArgs {
        password?: string;
        personalAccessToken?: string;
        sshPrivateKey?: string;
        sshPrivateKeyPath?: string;
        username?: string;
    }

    Properties

    password? personalAccessToken? sshPrivateKey? sshPrivateKeyPath? username?

    Properties

    Optional password

    password?: string

    The password that pairs with a username as part of basic authentication, or the passphrase to be used with an SSH private key.

    -

    Optional personalAccessToken

    personalAccessToken?: string

    A Git personal access token, to be used in replacement of a password.

    -

    Optional sshPrivateKey

    sshPrivateKey?: string

    A string containing the contents of a private key to be used for access +

    Optional personalAccessToken

    personalAccessToken?: string

    A Git personal access token, to be used in replacement of a password.

    +

    Optional sshPrivateKey

    sshPrivateKey?: string

    A string containing the contents of a private key to be used for access to the Git repository.

    -

    Optional sshPrivateKeyPath

    sshPrivateKeyPath?: string

    The absolute path to a private key to be used for access to the Git repository.

    -

    Optional username

    username?: string

    The username to use when authenticating to a Git repository with basic +

    Optional sshPrivateKeyPath

    sshPrivateKeyPath?: string

    The absolute path to a private key to be used for access to the Git repository.

    +

    Optional username

    username?: string

    The username to use when authenticating to a Git repository with basic authentication.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    passwordpersonalAccessTokensshPrivateKeysshPrivateKeyPathusername

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    passwordpersonalAccessTokensshPrivateKeysshPrivateKeyPathusername

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitProgramArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitProgramArgs.html index 8094e3a0bfb2..7540a142629e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitProgramArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitProgramArgs.html @@ -1,14 +1,14 @@ RemoteGitProgramArgs | @pulumi/pulumi

    Interface RemoteGitProgramArgs

    Description of a stack backed by a remote Pulumi program in a Git repository.

    -
    interface RemoteGitProgramArgs {
        auth?: RemoteGitAuthArgs;
        branch?: string;
        commitHash?: string;
        projectPath?: string;
        stackName: string;
        url?: string;
    }

    Properties

    auth? +
    interface RemoteGitProgramArgs {
        auth?: RemoteGitAuthArgs;
        branch?: string;
        commitHash?: string;
        projectPath?: string;
        stackName: string;
        url?: string;
    }

    Properties

    auth? branch? commitHash? projectPath? stackName url?

    Properties

    Optional auth

    auth?: RemoteGitAuthArgs

    Authentication options for the repository.

    -

    Optional branch

    branch?: string

    An optional branch to checkout.

    -

    Optional commitHash

    commitHash?: string

    Optional commit to checkout.

    -

    Optional projectPath

    projectPath?: string

    An optional path relative to the repo root specifying location of the Pulumi program.

    -

    stackName

    stackName: string

    The associated stack name.

    -

    Optional url

    url?: string

    The URL of the repository.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    authbranchcommitHashprojectPathstackNameurl

    Generated using TypeDoc

    \ No newline at end of file +

    Optional branch

    branch?: string

    An optional branch to checkout.

    +

    Optional commitHash

    commitHash?: string

    Optional commit to checkout.

    +

    Optional projectPath

    projectPath?: string

    An optional path relative to the repo root specifying location of the Pulumi program.

    +

    stackName

    stackName: string

    The associated stack name.

    +

    Optional url

    url?: string

    The URL of the repository.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    authbranchcommitHashprojectPathstackNameurl

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemotePreviewOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemotePreviewOptions.html index 134bb34f92f7..98dfc086610e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemotePreviewOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemotePreviewOptions.html @@ -1,4 +1,4 @@ RemotePreviewOptions | @pulumi/pulumi

    Interface RemotePreviewOptions

    Options controlling the behavior of a RemoteStack.preview operation.

    -
    interface RemotePreviewOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? +
    interface RemotePreviewOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? onOutput? -

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteRefreshOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteRefreshOptions.html index be388a6dbb91..06dcde954f57 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteRefreshOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteRefreshOptions.html @@ -1,4 +1,4 @@ RemoteRefreshOptions | @pulumi/pulumi

    Interface RemoteRefreshOptions

    Options controlling the behavior of a RemoteStack.refresh operation.

    -
    interface RemoteRefreshOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? +
    interface RemoteRefreshOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? onOutput? -

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteUpOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteUpOptions.html index 5454df0be38c..1eebec4191bc 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteUpOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteUpOptions.html @@ -1,4 +1,4 @@ RemoteUpOptions | @pulumi/pulumi

    Interface RemoteUpOptions

    Options controlling the behavior of a RemoteStack.up operation.

    -
    interface RemoteUpOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? +
    interface RemoteUpOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? onOutput? -

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteWorkspaceOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteWorkspaceOptions.html index efaac3e40b39..1b283017502f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteWorkspaceOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteWorkspaceOptions.html @@ -1,14 +1,14 @@ RemoteWorkspaceOptions | @pulumi/pulumi

    Interface RemoteWorkspaceOptions

    Extensibility options to configure a RemoteWorkspace.

    -
    interface RemoteWorkspaceOptions {
        envVars?: {
            [key: string]: string | {
                secret: string;
            };
        };
        inheritSettings?: boolean;
        preRunCommands?: string[];
        skipInstallDependencies?: boolean;
    }

    Properties

    envVars? +
    interface RemoteWorkspaceOptions {
        envVars?: {
            [key: string]: string | {
                secret: string;
            };
        };
        inheritSettings?: boolean;
        preRunCommands?: string[];
        skipInstallDependencies?: boolean;
    }

    Properties

    envVars? inheritSettings? preRunCommands? skipInstallDependencies?

    Properties

    Optional envVars

    envVars?: {
        [key: string]: string | {
            secret: string;
        };
    }

    Environment values scoped to the remote workspace. These will be passed to remote operations.

    -

    Type declaration

    • [key: string]: string | {
          secret: string;
      }

    Optional inheritSettings

    inheritSettings?: boolean

    Whether to inherit the deployment settings set on the stack. Defaults to +

    Type declaration

    • [key: string]: string | {
          secret: string;
      }

    Optional inheritSettings

    inheritSettings?: boolean

    Whether to inherit the deployment settings set on the stack. Defaults to false.

    -

    Optional preRunCommands

    preRunCommands?: string[]

    An optional list of arbitrary commands to run before a remote Pulumi +

    Optional preRunCommands

    preRunCommands?: string[]

    An optional list of arbitrary commands to run before a remote Pulumi operation is invoked.

    -

    Optional skipInstallDependencies

    skipInstallDependencies?: boolean

    Whether to skip the default dependency installation step. Defaults to +

    Optional skipInstallDependencies

    skipInstallDependencies?: boolean

    Whether to skip the default dependency installation step. Defaults to false.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsinheritSettingspreRunCommandsskipInstallDependencies

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsinheritSettingspreRunCommandsskipInstallDependencies

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoveOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoveOptions.html index e3b26d9c2be8..457b55198005 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoveOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoveOptions.html @@ -1,5 +1,5 @@ -RemoveOptions | @pulumi/pulumi

    Interface RemoveOptions

    interface RemoveOptions {
        force?: boolean;
        preserveConfig?: boolean;
    }

    Properties

    force? +RemoveOptions | @pulumi/pulumi

    Interface RemoveOptions

    interface RemoveOptions {
        force?: boolean;
        preserveConfig?: boolean;
    }

    Properties

    force? preserveConfig?

    Properties

    Optional force

    force?: boolean

    Forces deletion of the stack, leaving behind any resources managed by the stack

    -

    Optional preserveConfig

    preserveConfig?: boolean

    Do not delete the corresponding Pulumi..yaml configuration file for the stack

    -

    Settings

    Member Visibility

    Theme

    On This Page

    forcepreserveConfig

    Generated using TypeDoc

    \ No newline at end of file +

    Optional preserveConfig

    preserveConfig?: boolean

    Do not delete the corresponding Pulumi..yaml configuration file for the stack

    +

    Settings

    Member Visibility

    Theme

    On This Page

    forcepreserveConfig

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOpFailedEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOpFailedEvent.html index 151dfc33909a..52a0d4516240 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOpFailedEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOpFailedEvent.html @@ -1,8 +1,8 @@ ResOpFailedEvent | @pulumi/pulumi

    Interface ResOpFailedEvent

    An event emitted when a resource operation fails. Typically a DiagnosticEvent is emitted before this event, indicating the root cause of the error.

    -
    interface ResOpFailedEvent {
        metadata: StepEventMetadata;
        status: number;
        steps: number;
    }

    Properties

    metadata +
    interface ResOpFailedEvent {
        metadata: StepEventMetadata;
        status: number;
        steps: number;
    }

    Properties

    metadata status steps

    Properties

    metadata

    metadata: StepEventMetadata

    Metadata for the event.

    -

    status

    status: number

    steps

    steps: number

    Settings

    Member Visibility

    Theme

    On This Page

    metadatastatussteps

    Generated using TypeDoc

    \ No newline at end of file +

    status

    status: number

    steps

    steps: number

    Settings

    Member Visibility

    Theme

    On This Page

    metadatastatussteps

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOutputsEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOutputsEvent.html index 53c9d91ca8ab..7c80d7c54571 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOutputsEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOutputsEvent.html @@ -1,5 +1,5 @@ ResOutputsEvent | @pulumi/pulumi

    Interface ResOutputsEvent

    An event emitted when a resource is finished being provisioned.

    -
    interface ResOutputsEvent {
        metadata: StepEventMetadata;
        planning?: boolean;
    }

    Properties

    metadata +
    interface ResOutputsEvent {
        metadata: StepEventMetadata;
        planning?: boolean;
    }

    Properties

    metadata planning?

    Properties

    metadata

    metadata: StepEventMetadata

    Metadata for the event.

    -

    Optional planning

    planning?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    metadataplanning

    Generated using TypeDoc

    \ No newline at end of file +

    Optional planning

    planning?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    metadataplanning

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResourcePreEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResourcePreEvent.html index e0a329c11493..4464d087bb05 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResourcePreEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResourcePreEvent.html @@ -1,5 +1,5 @@ ResourcePreEvent | @pulumi/pulumi

    Interface ResourcePreEvent

    An event emitted before a resource is modified.

    -
    interface ResourcePreEvent {
        metadata: StepEventMetadata;
        planning?: boolean;
    }

    Properties

    metadata +
    interface ResourcePreEvent {
        metadata: StepEventMetadata;
        planning?: boolean;
    }

    Properties

    metadata planning?

    Properties

    metadata

    metadata: StepEventMetadata

    Metadata for the event.

    -

    Optional planning

    planning?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    metadataplanning

    Generated using TypeDoc

    \ No newline at end of file +

    Optional planning

    planning?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    metadataplanning

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettings.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettings.html index f11787e2bfcf..4bdf6bb3fdb5 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettings.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettings.html @@ -1,6 +1,6 @@ StackSettings | @pulumi/pulumi

    Interface StackSettings

    A description of a Stack's configuration and encryption metadata.

    -
    interface StackSettings {
        config?: {
            [key: string]: StackSettingsConfigValue;
        };
        encryptedKey?: string;
        encryptionSalt?: string;
        secretsProvider?: string;
    }

    Properties

    config? +
    interface StackSettings {
        config?: {
            [key: string]: StackSettingsConfigValue;
        };
        encryptedKey?: string;
        encryptionSalt?: string;
        secretsProvider?: string;
    }

    Properties

    config? encryptedKey? encryptionSalt? secretsProvider? -

    Properties

    Optional config

    config?: {
        [key: string]: StackSettingsConfigValue;
    }

    Type declaration

    Optional encryptedKey

    encryptedKey?: string

    Optional encryptionSalt

    encryptionSalt?: string

    Optional secretsProvider

    secretsProvider?: string

    Settings

    Member Visibility

    Theme

    On This Page

    configencryptedKeyencryptionSaltsecretsProvider

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional config

    config?: {
        [key: string]: StackSettingsConfigValue;
    }

    Type declaration

    Optional encryptedKey

    encryptedKey?: string

    Optional encryptionSalt

    encryptionSalt?: string

    Optional secretsProvider

    secretsProvider?: string

    Settings

    Member Visibility

    Theme

    On This Page

    configencryptedKeyencryptionSaltsecretsProvider

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettingsSecureConfigValue.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettingsSecureConfigValue.html index f1beaa7b5981..9ea94101d798 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettingsSecureConfigValue.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettingsSecureConfigValue.html @@ -1,3 +1,3 @@ StackSettingsSecureConfigValue | @pulumi/pulumi

    Interface StackSettingsSecureConfigValue

    A secret stack configuration entry.

    -
    interface StackSettingsSecureConfigValue {
        secure: string;
    }

    Properties

    secure -

    Properties

    secure

    secure: string

    Settings

    Member Visibility

    Theme

    On This Page

    secure

    Generated using TypeDoc

    \ No newline at end of file +
    interface StackSettingsSecureConfigValue {
        secure: string;
    }

    Properties

    secure +

    Properties

    secure

    secure: string

    Settings

    Member Visibility

    Theme

    On This Page

    secure

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSummary.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSummary.html index bf23105ee783..7e56176a69b3 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSummary.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSummary.html @@ -1,8 +1,8 @@ StackSummary | @pulumi/pulumi

    Interface StackSummary

    A summary of the status of a given stack.

    -
    interface StackSummary {
        current: boolean;
        lastUpdate?: string;
        name: string;
        resourceCount?: number;
        updateInProgress?: boolean;
        url?: string;
    }

    Properties

    current +
    interface StackSummary {
        current: boolean;
        lastUpdate?: string;
        name: string;
        resourceCount?: number;
        updateInProgress?: boolean;
        url?: string;
    }

    Properties

    current lastUpdate? name resourceCount? updateInProgress? url? -

    Properties

    current

    current: boolean

    Optional lastUpdate

    lastUpdate?: string

    name

    name: string

    Optional resourceCount

    resourceCount?: number

    Optional updateInProgress

    updateInProgress?: boolean

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    currentlastUpdatenameresourceCountupdateInProgressurl

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    current

    current: boolean

    Optional lastUpdate

    lastUpdate?: string

    name

    name: string

    Optional resourceCount

    resourceCount?: number

    Optional updateInProgress

    updateInProgress?: boolean

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    currentlastUpdatenameresourceCountupdateInProgressurl

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StdoutEngineEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StdoutEngineEvent.html index 547173511fbf..f18cd22f47ea 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StdoutEngineEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StdoutEngineEvent.html @@ -1,5 +1,5 @@ StdoutEngineEvent | @pulumi/pulumi

    Interface StdoutEngineEvent

    An event emitted whenever a generic message is written, for example warnings from the pulumi CLI itself. Less common than DiagnosticEvent

    -
    interface StdoutEngineEvent {
        color: string;
        message: string;
    }

    Properties

    color +
    interface StdoutEngineEvent {
        color: string;
        message: string;
    }

    Properties

    color message -

    Properties

    color

    color: string

    message

    message: string

    Settings

    Member Visibility

    Theme

    On This Page

    colormessage

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    color

    color: string

    message

    message: string

    Settings

    Member Visibility

    Theme

    On This Page

    colormessage

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventMetadata.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventMetadata.html index 49fb6ebe9691..9df8976a5a61 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventMetadata.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventMetadata.html @@ -1,7 +1,7 @@ StepEventMetadata | @pulumi/pulumi

    Interface StepEventMetadata

    StepEventMetadata describes a "step" within the Pulumi engine, which is any concrete action to migrate a set of cloud resources from one state to another.

    -
    interface StepEventMetadata {
        detailedDiff?: Record<string, PropertyDiff>;
        diffs?: string[];
        keys?: string[];
        logical?: boolean;
        new?: StepEventStateMetadata;
        old?: StepEventStateMetadata;
        op: OpType;
        provider: string;
        type: string;
        urn: string;
    }

    Properties

    detailedDiff? +
    interface StepEventMetadata {
        detailedDiff?: Record<string, PropertyDiff>;
        diffs?: string[];
        keys?: string[];
        logical?: boolean;
        new?: StepEventStateMetadata;
        old?: StepEventStateMetadata;
        op: OpType;
        provider: string;
        type: string;
        urn: string;
    }

    Properties

    detailedDiff? diffs? keys? logical? @@ -12,13 +12,13 @@ type urn

    Properties

    Optional detailedDiff

    detailedDiff?: Record<string, PropertyDiff>

    The diff for this step as a list of property paths and difference types.

    -

    Optional diffs

    diffs?: string[]

    Keys that changed with this step.

    -

    Optional keys

    keys?: string[]

    Keys causing a replacement (only applicable for "create" and "replace" Ops).

    -

    Optional logical

    logical?: boolean

    Logical is set if the step is a logical operation in the program.

    -

    Optional new

    new?: StepEventStateMetadata

    New is the state of the resource after performing the step.

    -

    Optional old

    old?: StepEventStateMetadata

    Old is the state of the resource before performing the step.

    -

    op

    op: OpType

    The type of operation being performed.

    -

    provider

    provider: string

    Provider actually performing the step.

    -

    type

    type: string

    The type of the resource being operated on.

    -

    urn

    urn: string

    The URN of the resource being operated on.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    detailedDiffdiffskeyslogicalnewoldopprovidertypeurn

    Generated using TypeDoc

    \ No newline at end of file +

    Optional diffs

    diffs?: string[]

    Keys that changed with this step.

    +

    Optional keys

    keys?: string[]

    Keys causing a replacement (only applicable for "create" and "replace" Ops).

    +

    Optional logical

    logical?: boolean

    Logical is set if the step is a logical operation in the program.

    +

    Optional new

    new?: StepEventStateMetadata

    New is the state of the resource after performing the step.

    +

    Optional old

    old?: StepEventStateMetadata

    Old is the state of the resource before performing the step.

    +

    op

    op: OpType

    The type of operation being performed.

    +

    provider

    provider: string

    Provider actually performing the step.

    +

    type

    type: string

    The type of the resource being operated on.

    +

    urn

    urn: string

    The URN of the resource being operated on.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    detailedDiffdiffskeyslogicalnewoldopprovidertypeurn

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventStateMetadata.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventStateMetadata.html index 17c0209e2620..6e3091077dff 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventStateMetadata.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventStateMetadata.html @@ -1,6 +1,6 @@ StepEventStateMetadata | @pulumi/pulumi

    Interface StepEventStateMetadata

    StepEventStateMetadata is the more detailed state information for a resource as it relates to a step(s) being performed.

    -
    interface StepEventStateMetadata {
        custom?: boolean;
        delete?: boolean;
        id: string;
        initErrors?: string[];
        inputs: Record<string, any>;
        outputs: Record<string, any>;
        parent: string;
        protect?: boolean;
        provider: string;
        retainOnDelete?: boolean;
        type: string;
        urn: string;
    }

    Properties

    custom? +
    interface StepEventStateMetadata {
        custom?: boolean;
        delete?: boolean;
        id: string;
        initErrors?: string[];
        inputs: Record<string, any>;
        outputs: Record<string, any>;
        parent: string;
        protect?: boolean;
        provider: string;
        retainOnDelete?: boolean;
        type: string;
        urn: string;
    }

    Properties

    custom? delete? id initErrors? @@ -13,16 +13,16 @@ type urn

    Properties

    Optional custom

    custom?: boolean

    Custom indicates if the resource is managed by a plugin.

    -

    Optional delete

    delete?: boolean

    Delete is true when the resource is pending deletion due to a replacement.

    -

    id

    id: string

    ID is the resource's unique ID, assigned by the resource provider (or blank if none/uncreated).

    -

    Optional initErrors

    initErrors?: string[]

    InitErrors is the set of errors encountered in the process of initializing resource.

    -

    inputs

    inputs: Record<string, any>

    Inputs contains the resource's input properties (as specified by the program). Secrets have +

    Optional delete

    delete?: boolean

    Delete is true when the resource is pending deletion due to a replacement.

    +

    id

    id: string

    ID is the resource's unique ID, assigned by the resource provider (or blank if none/uncreated).

    +

    Optional initErrors

    initErrors?: string[]

    InitErrors is the set of errors encountered in the process of initializing resource.

    +

    inputs

    inputs: Record<string, any>

    Inputs contains the resource's input properties (as specified by the program). Secrets have filtered out, and large assets have been replaced by hashes as applicable.

    -

    outputs

    outputs: Record<string, any>

    Outputs contains the resource's complete output state (as returned by the resource provider).

    -

    parent

    parent: string

    Parent is an optional parent URN that this resource belongs to.

    -

    Optional protect

    protect?: boolean

    Protect is true to "protect" this resource (protected resources cannot be deleted).

    -

    provider

    provider: string

    Provider is the resource's provider reference

    -

    Optional retainOnDelete

    retainOnDelete?: boolean

    RetainOnDelete is true if the resource is not physically deleted when it is logically deleted.

    -

    type

    type: string

    The type of the resource being operated on.

    -

    urn

    urn: string

    The URN of the resource being operated on.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    customdeleteidinitErrorsinputsoutputsparentprotectproviderretainOnDeletetypeurn

    Generated using TypeDoc

    \ No newline at end of file +

    outputs

    outputs: Record<string, any>

    Outputs contains the resource's complete output state (as returned by the resource provider).

    +

    parent

    parent: string

    Parent is an optional parent URN that this resource belongs to.

    +

    Optional protect

    protect?: boolean

    Protect is true to "protect" this resource (protected resources cannot be deleted).

    +

    provider

    provider: string

    Provider is the resource's provider reference

    +

    Optional retainOnDelete

    retainOnDelete?: boolean

    RetainOnDelete is true if the resource is not physically deleted when it is logically deleted.

    +

    type

    type: string

    The type of the resource being operated on.

    +

    urn

    urn: string

    The URN of the resource being operated on.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    customdeleteidinitErrorsinputsoutputsparentprotectproviderretainOnDeletetypeurn

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.SummaryEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.SummaryEvent.html index e8090cf21b33..dbdf61e665d2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.SummaryEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.SummaryEvent.html @@ -1,14 +1,14 @@ SummaryEvent | @pulumi/pulumi

    Interface SummaryEvent

    An event emitted at the end of an update, with a summary of the changes made.

    -
    interface SummaryEvent {
        durationSeconds: number;
        maybeCorrupt: boolean;
        policyPacks: Record<string, string>;
        resourceChanges: OpMap;
    }

    Properties

    durationSeconds +
    interface SummaryEvent {
        durationSeconds: number;
        maybeCorrupt: boolean;
        policyPacks: Record<string, string>;
        resourceChanges: OpMap;
    }

    Properties

    durationSeconds maybeCorrupt policyPacks resourceChanges

    Properties

    durationSeconds

    durationSeconds: number

    The number of seconds the update took to execute.

    -

    maybeCorrupt

    maybeCorrupt: boolean

    True if one or more of the resources are in an invalid state.

    -

    policyPacks

    policyPacks: Record<string, string>

    The policy packs that were run during the update. Maps PolicyPackName -> version.

    +

    maybeCorrupt

    maybeCorrupt: boolean

    True if one or more of the resources are in an invalid state.

    +

    policyPacks

    policyPacks: Record<string, string>

    The policy packs that were run during the update. Maps PolicyPackName -> version.

    Note: When this field was initially added, we forgot to add the JSON tag and are now locked into using PascalCase for this field to maintain backwards compatibility. For older clients this will map to the version, while for newer ones it will be the version tag prepended with "v".

    -

    resourceChanges

    resourceChanges: OpMap

    The count for resource changes by type.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    durationSecondsmaybeCorruptpolicyPacksresourceChanges

    Generated using TypeDoc

    \ No newline at end of file +

    resourceChanges

    resourceChanges: OpMap

    The count for resource changes by type.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    durationSecondsmaybeCorruptpolicyPacksresourceChanges

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpOptions.html index dc46beafd6d5..e5f8e9324018 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpOptions.html @@ -1,5 +1,5 @@ UpOptions | @pulumi/pulumi

    Interface UpOptions

    Options controlling the behavior of a Stack.up() operation.

    -
    interface UpOptions {
        color?: "always" | "never" | "raw" | "auto";
        continueOnError?: boolean;
        debug?: boolean;
        diff?: boolean;
        expectNoChanges?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        plan?: string;
        policyPackConfigs?: string[];
        policyPacks?: string[];
        program?: PulumiFn;
        refresh?: boolean;
        replace?: string[];
        showSecrets?: boolean;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        targetDependents?: boolean;
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    color? +
    interface UpOptions {
        color?: "always" | "never" | "raw" | "auto";
        continueOnError?: boolean;
        debug?: boolean;
        diff?: boolean;
        expectNoChanges?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        plan?: string;
        policyPackConfigs?: string[];
        policyPacks?: string[];
        program?: PulumiFn;
        refresh?: boolean;
        replace?: string[];
        showSecrets?: boolean;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        targetDependents?: boolean;
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    color? continueOnError? debug? diff? @@ -26,29 +26,29 @@ tracing? userAgent?

    Properties

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    -

    Optional continueOnError

    continueOnError?: boolean

    Continue the operation to completion even if errors occur.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    -

    Optional diff

    diff?: boolean

    Display the operation as a rich diff showing the overall change.

    -

    Optional expectNoChanges

    expectNoChanges?: boolean

    Return an error if any changes occur during this operation.

    -

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    -

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    -

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    -

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    -

    Optional message

    message?: string

    Optional message to associate with the operation.

    -

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    -

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces output.

    -

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    -

    Optional plan

    plan?: string

    Plan specifies the path to an update plan to use for the update.

    -

    Optional policyPackConfigs

    policyPackConfigs?: string[]

    A set of paths to JSON files containing configuration for the supplied policyPacks.

    -

    Optional policyPacks

    policyPacks?: string[]

    Run one or more policy packs as part of this operation.

    -

    Optional program

    program?: PulumiFn

    An inline (in-process) Pulumi program to execute the operation against.

    -

    Optional refresh

    refresh?: boolean

    Refresh the state of the stack's resources before this update.

    -

    Optional replace

    replace?: string[]

    Specify a set of resource URNs to replace.

    -

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the UpSummary.

    -

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    -

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    -

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    -

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    -

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    -

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    colorcontinueOnErrordebugdiffexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonEventonOutputparallelplanpolicyPackConfigspolicyPacksprogramrefreshreplaceshowSecretssuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file +

    Optional continueOnError

    continueOnError?: boolean

    Continue the operation to completion even if errors occur.

    +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    +

    Optional diff

    diff?: boolean

    Display the operation as a rich diff showing the overall change.

    +

    Optional expectNoChanges

    expectNoChanges?: boolean

    Return an error if any changes occur during this operation.

    +

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    +

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    +

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    +

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    +

    Optional message

    message?: string

    Optional message to associate with the operation.

    +

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    +

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces output.

    +

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    +

    Optional plan

    plan?: string

    Plan specifies the path to an update plan to use for the update.

    +

    Optional policyPackConfigs

    policyPackConfigs?: string[]

    A set of paths to JSON files containing configuration for the supplied policyPacks.

    +

    Optional policyPacks

    policyPacks?: string[]

    Run one or more policy packs as part of this operation.

    +

    Optional program

    program?: PulumiFn

    An inline (in-process) Pulumi program to execute the operation against.

    +

    Optional refresh

    refresh?: boolean

    Refresh the state of the stack's resources before this update.

    +

    Optional replace

    replace?: string[]

    Specify a set of resource URNs to replace.

    +

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the UpSummary.

    +

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    +

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    +

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    +

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    +

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    +

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    colorcontinueOnErrordebugdiffexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonEventonOutputparallelplanpolicyPackConfigspolicyPacksprogramrefreshreplaceshowSecretssuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpResult.html index 4d71b5b08697..ba8a9cde1340 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpResult.html @@ -1,10 +1,10 @@ UpResult | @pulumi/pulumi

    Interface UpResult

    The deployment output from running a Pulumi program update.

    -
    interface UpResult {
        outputs: OutputMap;
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    outputs +
    interface UpResult {
        outputs: OutputMap;
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    outputs stderr stdout summary

    Properties

    outputs

    outputs: OutputMap

    The outputs from the update.

    -

    stderr

    stderr: string

    The standard error output from the update.

    -

    stdout

    stdout: string

    The standard output from the update.

    -

    summary

    summary: UpdateSummary

    A summary of the update.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    outputsstderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file +

    stderr

    stderr: string

    The standard error output from the update.

    +

    stdout

    stdout: string

    The standard output from the update.

    +

    summary

    summary: UpdateSummary

    A summary of the update.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    outputsstderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpdateSummary.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpdateSummary.html index 827bd93280bd..34488cc1bbf4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpdateSummary.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpdateSummary.html @@ -1,5 +1,5 @@ UpdateSummary | @pulumi/pulumi

    Interface UpdateSummary

    A summary of a stack operation.

    -
    interface UpdateSummary {
        Deployment?: string;
        config: ConfigMap;
        endTime: Date;
        environment: {
            [key: string]: string;
        };
        kind: UpdateKind;
        message: string;
        resourceChanges?: OpMap;
        result: automation.UpdateResult;
        startTime: Date;
        version: number;
    }

    Properties

    Deployment? +
    interface UpdateSummary {
        Deployment?: string;
        config: ConfigMap;
        endTime: Date;
        environment: {
            [key: string]: string;
        };
        kind: UpdateKind;
        message: string;
        resourceChanges?: OpMap;
        result: automation.UpdateResult;
        startTime: Date;
        version: number;
    }

    Properties

    Deployment? config endTime environment @@ -10,14 +10,14 @@ startTime version

    Properties

    Optional Deployment

    Deployment?: string

    A raw JSON blob detailing the deployment.

    -

    config

    config: ConfigMap

    The configuration used for the operation.

    -

    endTime

    endTime: Date

    The time at which the operation completed.

    -

    environment

    environment: {
        [key: string]: string;
    }

    The environment supplied to the operation.

    -

    Type declaration

    • [key: string]: string

    kind

    kind: UpdateKind

    The kind of operation to be executed/that was executed.

    -

    message

    message: string

    An optional message associated with the operation.

    -

    Optional resourceChanges

    resourceChanges?: OpMap

    A summary of the changes yielded by the operation (e.g. 4 unchanged, 3 +

    config

    config: ConfigMap

    The configuration used for the operation.

    +

    endTime

    endTime: Date

    The time at which the operation completed.

    +

    environment

    environment: {
        [key: string]: string;
    }

    The environment supplied to the operation.

    +

    Type declaration

    • [key: string]: string

    kind

    kind: UpdateKind

    The kind of operation to be executed/that was executed.

    +

    message

    message: string

    An optional message associated with the operation.

    +

    Optional resourceChanges

    resourceChanges?: OpMap

    A summary of the changes yielded by the operation (e.g. 4 unchanged, 3 created, etc.).

    -

    result

    result: automation.UpdateResult

    The operation result.

    -

    startTime

    startTime: Date

    The time at which the operation started.

    -

    version

    version: number

    The version of the stack created by the operation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    DeploymentconfigendTimeenvironmentkindmessageresourceChangesresultstartTimeversion

    Generated using TypeDoc

    \ No newline at end of file +

    result

    result: automation.UpdateResult

    The operation result.

    +

    startTime

    startTime: Date

    The time at which the operation started.

    +

    version

    version: number

    The version of the stack created by the operation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    DeploymentconfigendTimeenvironmentkindmessageresourceChangesresultstartTimeversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.WhoAmIResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.WhoAmIResult.html index 39733c9cedd4..e57a73e3db6c 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.WhoAmIResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.WhoAmIResult.html @@ -1,5 +1,5 @@ WhoAmIResult | @pulumi/pulumi

    Interface WhoAmIResult

    The currently logged-in Pulumi identity.

    -
    interface WhoAmIResult {
        organizations?: string[];
        url?: string;
        user: string;
    }

    Properties

    organizations? +
    interface WhoAmIResult {
        organizations?: string[];
        url?: string;
        user: string;
    }

    Properties

    organizations? url? user -

    Properties

    Optional organizations

    organizations?: string[]

    Optional url

    url?: string

    user

    user: string

    Settings

    Member Visibility

    Theme

    On This Page

    organizationsurluser

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional organizations

    organizations?: string[]

    Optional url

    url?: string

    user

    user: string

    Settings

    Member Visibility

    Theme

    On This Page

    organizationsurluser

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.Workspace.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.Workspace.html index f55b1c75dc3d..62e0fa4baf18 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.Workspace.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.Workspace.html @@ -3,7 +3,7 @@ manage the execution environment, providing various utilities such as plugin installation, environment configuration ($PULUMI_HOME), and creation, deletion, and listing of Stacks.

    -
    interface Workspace {
        envVars: {
            [key: string]: string;
        };
        program?: PulumiFn;
        pulumiCommand: PulumiCommand;
        pulumiHome?: string;
        pulumiVersion: string;
        secretsProvider?: string;
        workDir: string;
        addEnvironments(stackName, ...environments): Promise<void>;
        createStack(stackName): Promise<void>;
        exportStack(stackName): Promise<Deployment>;
        getAllConfig(stackName): Promise<ConfigMap>;
        getConfig(stackName, key, path?): Promise<ConfigValue>;
        getTag(stackName, key): Promise<string>;
        importStack(stackName, state): Promise<void>;
        installPlugin(name, version, kind?): Promise<void>;
        installPluginFromServer(name, version, server): Promise<void>;
        listEnvironments(stackName): Promise<string[]>;
        listPlugins(): Promise<PluginInfo[]>;
        listStacks(opts?): Promise<StackSummary[]>;
        listTags(stackName): Promise<TagMap>;
        postCommandCallback(stackName): Promise<void>;
        projectSettings(): Promise<ProjectSettings>;
        refreshConfig(stackName): Promise<ConfigMap>;
        removeAllConfig(stackName, keys, path?): Promise<void>;
        removeConfig(stackName, key, path?): Promise<void>;
        removeEnvironment(stackName, environment): Promise<void>;
        removePlugin(name?, versionRange?, kind?): Promise<void>;
        removeStack(stackName, opts?): Promise<void>;
        removeTag(stackName, key): Promise<void>;
        saveProjectSettings(settings): Promise<void>;
        saveStackSettings(stackName, settings): Promise<void>;
        selectStack(stackName): Promise<void>;
        serializeArgsForOp(stackName): Promise<string[]>;
        setAllConfig(stackName, config, path?): Promise<void>;
        setConfig(stackName, key, value, path?): Promise<void>;
        setTag(stackName, key, value): Promise<void>;
        stack(): Promise<undefined | StackSummary>;
        stackOutputs(stackName): Promise<OutputMap>;
        stackSettings(stackName): Promise<StackSettings>;
        whoAmI(): Promise<WhoAmIResult>;
    }

    Implemented by

    Properties

    envVars +
    interface Workspace {
        envVars: {
            [key: string]: string;
        };
        program?: PulumiFn;
        pulumiCommand: PulumiCommand;
        pulumiHome?: string;
        pulumiVersion: string;
        secretsProvider?: string;
        workDir: string;
        addEnvironments(stackName, ...environments): Promise<void>;
        createStack(stackName): Promise<void>;
        exportStack(stackName): Promise<Deployment>;
        getAllConfig(stackName): Promise<ConfigMap>;
        getConfig(stackName, key, path?): Promise<ConfigValue>;
        getTag(stackName, key): Promise<string>;
        importStack(stackName, state): Promise<void>;
        installPlugin(name, version, kind?): Promise<void>;
        installPluginFromServer(name, version, server): Promise<void>;
        listEnvironments(stackName): Promise<string[]>;
        listPlugins(): Promise<PluginInfo[]>;
        listStacks(opts?): Promise<StackSummary[]>;
        listTags(stackName): Promise<TagMap>;
        postCommandCallback(stackName): Promise<void>;
        projectSettings(): Promise<ProjectSettings>;
        refreshConfig(stackName): Promise<ConfigMap>;
        removeAllConfig(stackName, keys, path?): Promise<void>;
        removeConfig(stackName, key, path?): Promise<void>;
        removeEnvironment(stackName, environment): Promise<void>;
        removePlugin(name?, versionRange?, kind?): Promise<void>;
        removeStack(stackName, opts?): Promise<void>;
        removeTag(stackName, key): Promise<void>;
        saveProjectSettings(settings): Promise<void>;
        saveStackSettings(stackName, settings): Promise<void>;
        selectStack(stackName): Promise<void>;
        serializeArgsForOp(stackName): Promise<string[]>;
        setAllConfig(stackName, config, path?): Promise<void>;
        setConfig(stackName, key, value, path?): Promise<void>;
        setTag(stackName, key, value): Promise<void>;
        stack(): Promise<undefined | StackSummary>;
        stackOutputs(stackName): Promise<OutputMap>;
        stackSettings(stackName): Promise<StackSettings>;
        whoAmI(): Promise<WhoAmIResult>;
    }

    Implemented by

    Properties

    envVars program? pulumiCommand pulumiHome? @@ -45,129 +45,129 @@ whoAmI

    Properties

    envVars

    envVars: {
        [key: string]: string;
    }

    Environment values scoped to the current workspace. These will be supplied to every Pulumi command.

    -

    Type declaration

    • [key: string]: string

    Optional program

    program?: PulumiFn

    The inline program PulumiFn to be used for preview/update +

    Type declaration

    • [key: string]: string

    Optional program

    program?: PulumiFn

    The inline program PulumiFn to be used for preview/update operations, if any. If none is specified, the stack will refer to ProjectSettings for this information.

    -

    Readonly pulumiCommand

    pulumiCommand: PulumiCommand

    The underlying Pulumi CLI.

    -

    Optional Readonly pulumiHome

    pulumiHome?: string

    The directory override for CLI metadata if set. This customizes the +

    Readonly pulumiCommand

    pulumiCommand: PulumiCommand

    The underlying Pulumi CLI.

    +

    Optional Readonly pulumiHome

    pulumiHome?: string

    The directory override for CLI metadata if set. This customizes the location of $PULUMI_HOME where metadata is stored and plugins are installed.

    -

    Readonly pulumiVersion

    pulumiVersion: string

    The version of the underlying Pulumi CLI/engine.

    -

    Optional Readonly secretsProvider

    secretsProvider?: string

    The secrets provider to use for encryption and decryption of stack +

    Readonly pulumiVersion

    pulumiVersion: string

    The version of the underlying Pulumi CLI/engine.

    +

    Optional Readonly secretsProvider

    secretsProvider?: string

    The secrets provider to use for encryption and decryption of stack secrets.

    See

    https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providers

    -

    Readonly workDir

    workDir: string

    The working directory to run Pulumi CLI commands.

    -

    Methods

    addEnvironments

    Readonly workDir

    workDir: string

    The working directory to run Pulumi CLI commands.

    +

    Methods

    addEnvironments

    • addEnvironments(stackName, ...environments): Promise<void>

    • Adds environments to the end of a stack's import list. Imported environments are merged in order per the ESC merge rules. The list of environments behaves as if it were the import list in an anonymous environment.

      Parameters

      • stackName: string

        The stack to operate on

      • Rest ...environments: string[]

        The names of the environments to add to the stack's configuration

        -

      Returns Promise<void>

    createStack

    • createStack(stackName): Promise<void>

    • Creates and sets a new stack with the stack name, failing if one already +

    Returns Promise<void>

    createStack

    • createStack(stackName): Promise<void>

    • Creates and sets a new stack with the stack name, failing if one already exists.

      Parameters

      • stackName: string

        The stack to create.

        -

      Returns Promise<void>

    exportStack

    • exportStack(stackName): Promise<Deployment>

    • Exports the deployment state of the stack. This can be combined with +

    Returns Promise<void>

    exportStack

    getAllConfig

    • getAllConfig(stackName): Promise<ConfigMap>

    • Returns the config map for the specified stack name, scoped to the +

    Returns Promise<Deployment>

    getAllConfig

    getConfig

    • getConfig(stackName, key, path?): Promise<ConfigValue>

    • Returns the value associated with the specified stack name and key, +

    Returns Promise<ConfigMap>

    getConfig

    • getConfig(stackName, key, path?): Promise<ConfigValue>

    • Returns the value associated with the specified stack name and key, scoped to the Workspace.

      Parameters

      • stackName: string

        The stack to read config from

      • key: string

        The key to use for the config lookup

      • Optional path: boolean

        The key contains a path to a property in a map or list to get

        -

      Returns Promise<ConfigValue>

    getTag

    • getTag(stackName, key): Promise<string>

    • Returns the value associated with the specified stack name and key, +

    Returns Promise<ConfigValue>

    getTag

    • getTag(stackName, key): Promise<string>

    • Returns the value associated with the specified stack name and key, scoped to the Workspace.

      Parameters

      • stackName: string

        The stack to read tag metadata from.

      • key: string

        The key to use for the tag lookup.

        -

      Returns Promise<string>

    importStack

    • importStack(stackName, state): Promise<void>

    • Imports the specified deployment state into a pre-existing stack. This +

    Returns Promise<string>

    importStack

    • importStack(stackName, state): Promise<void>

    • Imports the specified deployment state into a pre-existing stack. This can be combined with Workspace.exportStack to edit a stack's state (such as recovery from failed deployments).

      Parameters

      • stackName: string

        The name of the stack.

      • state: Deployment

        The stack state to import.

        -

      Returns Promise<void>

    installPlugin

    • installPlugin(name, version, kind?): Promise<void>

    • Installs a plugin in the workspace from a remote server, for example a +

    Returns Promise<void>

    installPlugin

    • installPlugin(name, version, kind?): Promise<void>

    • Installs a plugin in the workspace from a remote server, for example a third-party plugin.

      Parameters

      • name: string

        The name of the plugin.

      • version: string

        The version of the plugin e.g. "v1.0.0".

      • Optional kind: string

        The kind of plugin e.g. "resource"

        -

      Returns Promise<void>

    installPluginFromServer

    • installPluginFromServer(name, version, server): Promise<void>

    • Installs a plugin in the workspace, for example to use cloud providers +

    Returns Promise<void>

    installPluginFromServer

    • installPluginFromServer(name, version, server): Promise<void>

    • Installs a plugin in the workspace, for example to use cloud providers like AWS or GCP.

      Parameters

      • name: string

        The name of the plugin.

      • version: string

        The version of the plugin e.g. "v1.0.0".

      • server: string

        The server to install the plugin into

        -

      Returns Promise<void>

    listEnvironments

    • listEnvironments(stackName): Promise<string[]>

    • Returns the list of environments associated with the specified stack +

    Returns Promise<void>

    listEnvironments

    • listEnvironments(stackName): Promise<string[]>

    • Returns the list of environments associated with the specified stack name.

      Parameters

      • stackName: string

        The stack to operate on

        -

      Returns Promise<string[]>

    listPlugins

    listStacks

    • listStacks(opts?): Promise<StackSummary[]>

    • Returns all stacks from the underlying backend based on the provided +

    Returns Promise<string[]>

    listPlugins

    listStacks

    listTags

    • listTags(stackName): Promise<TagMap>

    • Returns the tag map for the specified tag name, scoped to the current +

    Returns Promise<StackSummary[]>

    listTags

    postCommandCallback

    • postCommandCallback(stackName): Promise<void>

    • A hook executed after every command. Called with the stack name. An +

    Returns Promise<TagMap>

    postCommandCallback

    • postCommandCallback(stackName): Promise<void>

    • A hook executed after every command. Called with the stack name. An extensibility point to perform workspace cleanup (CLI operations may create/modify a Pulumi.stack.yaml)

      -

      Parameters

      • stackName: string

      Returns Promise<void>

    projectSettings

    refreshConfig

    projectSettings

    refreshConfig

    removeAllConfig

    • removeAllConfig(stackName, keys, path?): Promise<void>

    • Removes all values in the provided key list for the specified stack name.

      +

    Returns Promise<ConfigMap>

    removeAllConfig

    • removeAllConfig(stackName, keys, path?): Promise<void>

    • Removes all values in the provided key list for the specified stack name.

      Parameters

      • stackName: string

        The stack to operate on

      • keys: string[]

        The list of keys to remove from the underlying config

      • Optional path: boolean

        The keys contain a path to a property in a map or list to remove

        -

      Returns Promise<void>

    removeConfig

    • removeConfig(stackName, key, path?): Promise<void>

    • Removes the specified key-value pair on the provided stack name.

      +

    Returns Promise<void>

    removeConfig

    • removeConfig(stackName, key, path?): Promise<void>

    • Removes the specified key-value pair on the provided stack name.

      Parameters

      • stackName: string

        The stack to operate on

      • key: string

        The config key to remove

      • Optional path: boolean

        The key contains a path to a property in a map or list to remove

        -

      Returns Promise<void>

    removeEnvironment

    • removeEnvironment(stackName, environment): Promise<void>

    • Removes an environment from a stack's import list.

      +

    Returns Promise<void>

    removeEnvironment

    • removeEnvironment(stackName, environment): Promise<void>

    • Removes an environment from a stack's import list.

      Parameters

      • stackName: string

        The stack to operate on

      • environment: string

        The name of the environment to remove from the stack's configuration

        -

      Returns Promise<void>

    removePlugin

    • removePlugin(name?, versionRange?, kind?): Promise<void>

    • Removes a plugin from the workspace matching the specified name and +

    Returns Promise<void>

    removePlugin

    • removePlugin(name?, versionRange?, kind?): Promise<void>

    • Removes a plugin from the workspace matching the specified name and version.

      Parameters

      • Optional name: string

        The optional name of the plugin.

      • Optional versionRange: string

        An optional semver range to check when removing plugins matching the given name e.g. "1.0.0", ">1.0.0".

      • Optional kind: string

        The kind of plugin e.g. "resource"

        -

      Returns Promise<void>

    removeStack

    • removeStack(stackName, opts?): Promise<void>

    • Deletes the stack and all associated configuration and history.

      +

    Returns Promise<void>

    removeStack

    removeTag

    • removeTag(stackName, key): Promise<void>

    • Removes the specified key-value pair on the provided stack name.

      +
    • Optional opts: RemoveOptions

    Returns Promise<void>

    removeTag

    • removeTag(stackName, key): Promise<void>

    • Removes the specified key-value pair on the provided stack name.

      Parameters

      • stackName: string

        The stack to operate on.

      • key: string

        The tag key to remove.

        -

      Returns Promise<void>

    saveProjectSettings

    • saveProjectSettings(settings): Promise<void>

    • Overwrites the settings object in the current project. There can only be +

    Returns Promise<void>

    saveProjectSettings

    • saveProjectSettings(settings): Promise<void>

    • Overwrites the settings object in the current project. There can only be a single project per workspace. Fails if the new project name does not match the old one.

      Parameters

      Returns Promise<void>

    saveStackSettings

    • saveStackSettings(stackName, settings): Promise<void>

    • Overwrites the settings object for the stack matching the specified stack +

    Returns Promise<void>

    saveStackSettings

    • saveStackSettings(stackName, settings): Promise<void>

    • Overwrites the settings object for the stack matching the specified stack name.

      Parameters

      • stackName: string

        The name of the stack to operate on.

      • settings: StackSettings

        The settings object to save.

        -

      Returns Promise<void>

    selectStack

    • selectStack(stackName): Promise<void>

    • Selects and sets an existing stack matching the stack name, failing if +

    Returns Promise<void>

    selectStack

    • selectStack(stackName): Promise<void>

    • Selects and sets an existing stack matching the stack name, failing if none exists.

      Parameters

      • stackName: string

        The stack to select.

        -

      Returns Promise<void>

    serializeArgsForOp

    • serializeArgsForOp(stackName): Promise<string[]>

    • A hook to provide additional arguments to every CLI command before they +

    Returns Promise<void>

    serializeArgsForOp

    • serializeArgsForOp(stackName): Promise<string[]>

    • A hook to provide additional arguments to every CLI command before they are executed. Provided with the stack name, this should return a list of arguments to append to an invoked command (e.g. ["--config=...", ...]).

      -

      Parameters

      • stackName: string

      Returns Promise<string[]>

    setAllConfig

    • setAllConfig(stackName, config, path?): Promise<void>

    • Sets all values in the provided config map for the specified stack name.

      +

      Parameters

      • stackName: string

      Returns Promise<string[]>

    setAllConfig

    • setAllConfig(stackName, config, path?): Promise<void>

    • Sets all values in the provided config map for the specified stack name.

      Parameters

      • stackName: string

        The stack to operate on

      • config: ConfigMap

        The ConfigMap to upsert against the existing config

      • Optional path: boolean

        The keys contain a path to a property in a map or list to set

        -

      Returns Promise<void>

    setConfig

    • setConfig(stackName, key, value, path?): Promise<void>

    • Sets the specified key-value pair on the provided stack name.

      +

    Returns Promise<void>

    setConfig

    • setConfig(stackName, key, value, path?): Promise<void>

    • Sets the specified key-value pair on the provided stack name.

      Parameters

      • stackName: string

        The stack to operate on

      • key: string

        The config key to set

      • value: ConfigValue

        The value to set

      • Optional path: boolean

        The key contains a path to a property in a map or list to set

        -

      Returns Promise<void>

    setTag

    • setTag(stackName, key, value): Promise<void>

    • Sets the specified key-value pair on the provided stack name.

      +

    Returns Promise<void>

    setTag

    • setTag(stackName, key, value): Promise<void>

    • Sets the specified key-value pair on the provided stack name.

      Parameters

      • stackName: string

        The stack to operate on.

      • key: string

        The tag key to set.

      • value: string

        The tag value to set.

        -

      Returns Promise<void>

    stack

    stackOutputs

    • stackOutputs(stackName): Promise<OutputMap>

    • Gets the current set of Stack outputs from the last Stack.up.

      +

    Returns Promise<void>

    stack

    stackOutputs

    stackSettings

    • stackSettings(stackName): Promise<StackSettings>

    • Returns the settings object for the stack matching the specified stack +

    Returns Promise<OutputMap>

    stackSettings

    whoAmI

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsprogrampulumiCommandpulumiHomepulumiVersionsecretsProviderworkDiraddEnvironmentscreateStackexportStackgetAllConfiggetConfiggetTagimportStackinstallPlugininstallPluginFromServerlistEnvironmentslistPluginslistStackslistTagspostCommandCallbackprojectSettingsrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremovePluginremoveStackremoveTagsaveProjectSettingssaveStackSettingsselectStackserializeArgsForOpsetAllConfigsetConfigsetTagstackstackOutputsstackSettingswhoAmI

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<StackSettings>

    whoAmI

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsprogrampulumiCommandpulumiHomepulumiVersionsecretsProviderworkDiraddEnvironmentscreateStackexportStackgetAllConfiggetConfiggetTagimportStackinstallPlugininstallPluginFromServerlistEnvironmentslistPluginslistStackslistTagspostCommandCallbackprojectSettingsrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremovePluginremoveStackremoveTagsaveProjectSettingssaveStackSettingsselectStackserializeArgsForOpsetAllConfigsetConfigsetTagstackstackOutputsstackSettingswhoAmI

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckFailure.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckFailure.html index 7e217c4f0094..a82bfbda0f07 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckFailure.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckFailure.html @@ -1,7 +1,7 @@ CheckFailure | @pulumi/pulumi

    Interface CheckFailure

    CheckFailure represents a single failure in the results of a call to ResourceProvider.check.

    -
    interface CheckFailure {
        property: string;
        reason: string;
    }

    Properties

    property +
    interface CheckFailure {
        property: string;
        reason: string;
    }

    Properties

    property reason

    Properties

    Readonly property

    property: string

    The property that failed validation.

    -

    Readonly reason

    reason: string

    The reason that the property failed validation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    propertyreason

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly reason

    reason: string

    The reason that the property failed validation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    propertyreason

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckResult.html index 7aeda9e45292..4d2616254be1 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckResult.html @@ -1,6 +1,6 @@ CheckResult | @pulumi/pulumi

    Interface CheckResult<Inputs>

    CheckResult represents the results of a call to ResourceProvider.check.

    -
    interface CheckResult<Inputs> {
        failures?: dynamic.CheckFailure[];
        inputs?: Inputs;
    }

    Type Parameters

    • Inputs = any

    Properties

    failures? +
    interface CheckResult<Inputs> {
        failures?: dynamic.CheckFailure[];
        inputs?: Inputs;
    }

    Type Parameters

    • Inputs = any

    Properties

    failures? inputs?

    Properties

    Optional Readonly failures

    failures?: dynamic.CheckFailure[]

    Any validation failures that occurred.

    -

    Optional Readonly inputs

    inputs?: Inputs

    The inputs to use, if any.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    failuresinputs

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly inputs

    inputs?: Inputs

    The inputs to use, if any.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    failuresinputs

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CreateResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CreateResult.html index 00dbf3e5ee91..e7cbc6a9629e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CreateResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CreateResult.html @@ -1,7 +1,7 @@ CreateResult | @pulumi/pulumi

    Interface CreateResult<Outputs>

    CreateResult represents the results of a call to ResourceProvider.create.

    -
    interface CreateResult<Outputs> {
        id: string;
        outs?: Outputs;
    }

    Type Parameters

    • Outputs = any

    Properties

    id +
    interface CreateResult<Outputs> {
        id: string;
        outs?: Outputs;
    }

    Type Parameters

    • Outputs = any

    Properties

    id outs?

    Properties

    Readonly id

    id: string

    The ID of the created resource.

    -

    Optional Readonly outs

    outs?: Outputs

    Any properties that were computed during creation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    idouts

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly outs

    outs?: Outputs

    Any properties that were computed during creation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    idouts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.DiffResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.DiffResult.html index ddcba79562df..56602e6bb818 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.DiffResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.DiffResult.html @@ -1,13 +1,13 @@ DiffResult | @pulumi/pulumi

    Interface DiffResult

    DiffResult represents the results of a call to ResourceProvider.diff.

    -
    interface DiffResult {
        changes?: boolean;
        deleteBeforeReplace?: boolean;
        replaces?: string[];
        stables?: string[];
    }

    Properties

    changes? +
    interface DiffResult {
        changes?: boolean;
        deleteBeforeReplace?: boolean;
        replaces?: string[];
        stables?: string[];
    }

    Properties

    changes? deleteBeforeReplace? replaces? stables?

    Properties

    Optional Readonly changes

    changes?: boolean

    If true, this diff detected changes and suggests an update.

    -

    Optional Readonly deleteBeforeReplace

    deleteBeforeReplace?: boolean

    If true, and a replacement occurs, the resource will first be deleted +

    Optional Readonly deleteBeforeReplace

    deleteBeforeReplace?: boolean

    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.

    -

    Optional Readonly replaces

    replaces?: string[]

    If this update requires a replacement, the set of properties triggering it.

    -

    Optional Readonly stables

    stables?: string[]

    An optional list of properties that will not ever change.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    changesdeleteBeforeReplacereplacesstables

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly replaces

    replaces?: string[]

    If this update requires a replacement, the set of properties triggering it.

    +

    Optional Readonly stables

    stables?: string[]

    An optional list of properties that will not ever change.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    changesdeleteBeforeReplacereplacesstables

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ReadResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ReadResult.html index 63fc7f70a599..d4ca680a48c8 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ReadResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ReadResult.html @@ -1,7 +1,7 @@ ReadResult | @pulumi/pulumi

    Interface ReadResult<Outputs>

    ReadResult represents the results of a call to ResourceProvider.read.

    -
    interface ReadResult<Outputs> {
        id?: string;
        props?: Outputs;
    }

    Type Parameters

    • Outputs = any

    Properties

    id? +
    interface ReadResult<Outputs> {
        id?: string;
        props?: Outputs;
    }

    Type Parameters

    • Outputs = any

    Properties

    id? props?

    Properties

    Optional Readonly id

    id?: string

    The ID of the resource ready back (or blank if missing).

    -

    Optional Readonly props

    props?: Outputs

    The current property state read from the live environment.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    idprops

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly props

    props?: Outputs

    The current property state read from the live environment.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    idprops

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ResourceProvider.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ResourceProvider.html index 32d3e929aa52..311c85de6c36 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ResourceProvider.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ResourceProvider.html @@ -1,6 +1,6 @@ ResourceProvider | @pulumi/pulumi

    Interface ResourceProvider<Inputs, Outputs>

    ResourceProvider represents an object that provides CRUD operations for a particular type of resource.

    -
    interface ResourceProvider<Inputs, Outputs> {
        check?: ((olds, news) => Promise<dynamic.CheckResult<Inputs>>);
        create: ((inputs) => Promise<dynamic.CreateResult<Outputs>>);
        delete?: ((id, props) => Promise<void>);
        diff?: ((id, olds, news) => Promise<dynamic.DiffResult>);
        read?: ((id, props?) => Promise<dynamic.ReadResult<Outputs>>);
        update?: ((id, olds, news) => Promise<dynamic.UpdateResult<Outputs>>);
    }

    Type Parameters

    • Inputs = any
    • Outputs = any

    Properties

    check? +
    interface ResourceProvider<Inputs, Outputs> {
        check?: ((olds, news) => Promise<dynamic.CheckResult<Inputs>>);
        create: ((inputs) => Promise<dynamic.CreateResult<Outputs>>);
        delete?: ((id, props) => Promise<void>);
        diff?: ((id, olds, news) => Promise<dynamic.DiffResult>);
        read?: ((id, props?) => Promise<dynamic.ReadResult<Outputs>>);
        update?: ((id, olds, news) => Promise<dynamic.UpdateResult<Outputs>>);
    }

    Type Parameters

    • Inputs = any
    • Outputs = any

    Properties

    check? create delete? diff? @@ -9,24 +9,24 @@

    Properties

    Optional check

    check?: ((olds, news) => Promise<dynamic.CheckResult<Inputs>>)

    Validates that the given property bag is valid for a resource of the given type.

    Type declaration

    create

    create: ((inputs) => Promise<dynamic.CreateResult<Outputs>>)

    Allocates a new instance of the provided resource and returns its unique +

    Returns Promise<dynamic.CheckResult<Inputs>>

    create

    create: ((inputs) => Promise<dynamic.CreateResult<Outputs>>)

    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").

    Type declaration

    Optional delete

    delete?: ((id, props) => Promise<void>)

    Tears down an existing resource with the given ID. If it fails, +

    Returns Promise<dynamic.CreateResult<Outputs>>

    Optional delete

    delete?: ((id, props) => Promise<void>)

    Tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.

    Type declaration

      • (id, props): Promise<void>

      • Parameters

        • id: string

          The ID of the resource to delete.

        • props: Outputs

          The current properties on the resource.

          -

        Returns Promise<void>

    Optional diff

    diff?: ((id, olds, news) => Promise<dynamic.DiffResult>)

    Checks what impacts a hypothetical update will have on the resource's +

    Returns Promise<void>

    Optional diff

    diff?: ((id, olds, news) => Promise<dynamic.DiffResult>)

    Checks what impacts a hypothetical update will have on the resource's properties.

    Type declaration

    Optional read

    read?: ((id, props?) => Promise<dynamic.ReadResult<Outputs>>)

    Reads the current live state associated with a resource. Enough state +

    Returns Promise<dynamic.DiffResult>

    Optional read

    read?: ((id, props?) => Promise<dynamic.ReadResult<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.

    -

    Type declaration

    Optional update

    update?: ((id, olds, news) => Promise<dynamic.UpdateResult<Outputs>>)

    Updates an existing resource with new values.

    +

    Type declaration

    Optional update

    update?: ((id, olds, news) => Promise<dynamic.UpdateResult<Outputs>>)

    Updates an existing resource with new values.

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    checkcreatedeletediffreadupdate

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<dynamic.UpdateResult<Outputs>>

    Settings

    Member Visibility

    Theme

    On This Page

    checkcreatedeletediffreadupdate

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.UpdateResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.UpdateResult.html index 74329bca31c9..bfdf297225c1 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.UpdateResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.UpdateResult.html @@ -1,5 +1,5 @@ UpdateResult | @pulumi/pulumi

    Interface UpdateResult<Outputs>

    UpdateResult represents the results of a call to ResourceProvider.update.

    -
    interface UpdateResult<Outputs> {
        outs?: Outputs;
    }

    Type Parameters

    • Outputs = any

    Properties

    outs? +
    interface UpdateResult<Outputs> {
        outs?: Outputs;
    }

    Type Parameters

    • Outputs = any

    Properties

    outs?

    Properties

    Optional Readonly outs

    outs?: Outputs

    Any properties that were computed during updating.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    outs

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    outs

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckFailure.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckFailure.html index 6b5636e004c8..8fe0bdcb715d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckFailure.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckFailure.html @@ -1,7 +1,7 @@ CheckFailure | @pulumi/pulumi

    Interface CheckFailure

    CheckFailure represents a single failure in the results of a call to ResourceProvider.check.

    -
    interface CheckFailure {
        property: string;
        reason: string;
    }

    Properties

    property +
    interface CheckFailure {
        property: string;
        reason: string;
    }

    Properties

    property reason

    Properties

    Readonly property

    property: string

    The property that failed validation.

    -

    Readonly reason

    reason: string

    The reason that the property failed validation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    propertyreason

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly reason

    reason: string

    The reason that the property failed validation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    propertyreason

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckResult.html index 0c1a5e01723d..f1a8f01d1424 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckResult.html @@ -1,7 +1,7 @@ CheckResult | @pulumi/pulumi

    Interface CheckResult

    CheckResult represents the results of a call to ResourceProvider.check.

    -
    interface CheckResult {
        failures?: provider.CheckFailure[];
        inputs?: any;
    }

    Properties

    failures? +
    interface CheckResult {
        failures?: provider.CheckFailure[];
        inputs?: any;
    }

    Properties

    failures? inputs?

    Properties

    Optional Readonly failures

    failures?: provider.CheckFailure[]

    Any validation failures that occurred.

    -

    Optional Readonly inputs

    inputs?: any

    The inputs to use, if any.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    failuresinputs

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly inputs

    inputs?: any

    The inputs to use, if any.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    failuresinputs

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ConstructResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ConstructResult.html index 58cd3b0fbe0e..1cb75f527811 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ConstructResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ConstructResult.html @@ -1,7 +1,7 @@ ConstructResult | @pulumi/pulumi

    Interface ConstructResult

    ConstructResult represents the results of a call to ResourceProvider.construct.

    -
    interface ConstructResult {
        state: Inputs;
        urn: Input<string>;
    }

    Properties

    state +
    interface ConstructResult {
        state: Inputs;
        urn: Input<string>;
    }

    Properties

    state urn

    Properties

    Readonly state

    state: Inputs

    Any state that was computed during construction.

    -

    Readonly urn

    urn: Input<string>

    The URN of the constructed resource.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    stateurn

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly urn

    urn: Input<string>

    The URN of the constructed resource.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    stateurn

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CreateResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CreateResult.html index bbe9772c8f7c..600ac28c5244 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CreateResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CreateResult.html @@ -1,7 +1,7 @@ CreateResult | @pulumi/pulumi

    Interface CreateResult

    CreateResult represents the results of a call to ResourceProvider.create.

    -
    interface CreateResult {
        id: string;
        outs?: any;
    }

    Properties

    id +
    interface CreateResult {
        id: string;
        outs?: any;
    }

    Properties

    id outs?

    Properties

    Readonly id

    id: string

    The ID of the created resource.

    -

    Optional Readonly outs

    outs?: any

    Any properties that were computed during creation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    idouts

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly outs

    outs?: any

    Any properties that were computed during creation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    idouts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.DiffResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.DiffResult.html index 095f7d29ac5a..51338a27bd6b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.DiffResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.DiffResult.html @@ -1,13 +1,13 @@ DiffResult | @pulumi/pulumi

    Interface DiffResult

    DiffResult represents the results of a call to ResourceProvider.diff.

    -
    interface DiffResult {
        changes?: boolean;
        deleteBeforeReplace?: boolean;
        replaces?: string[];
        stables?: string[];
    }

    Properties

    changes? +
    interface DiffResult {
        changes?: boolean;
        deleteBeforeReplace?: boolean;
        replaces?: string[];
        stables?: string[];
    }

    Properties

    changes? deleteBeforeReplace? replaces? stables?

    Properties

    Optional Readonly changes

    changes?: boolean

    If true, this diff detected changes and suggests an update.

    -

    Optional Readonly deleteBeforeReplace

    deleteBeforeReplace?: boolean

    If true, and a replacement occurs, the resource will first be deleted +

    Optional Readonly deleteBeforeReplace

    deleteBeforeReplace?: boolean

    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.

    -

    Optional Readonly replaces

    replaces?: string[]

    If this update requires a replacement, the set of properties triggering it.

    -

    Optional Readonly stables

    stables?: string[]

    An optional list of properties that will not ever change.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    changesdeleteBeforeReplacereplacesstables

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly replaces

    replaces?: string[]

    If this update requires a replacement, the set of properties triggering it.

    +

    Optional Readonly stables

    stables?: string[]

    An optional list of properties that will not ever change.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    changesdeleteBeforeReplacereplacesstables

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.InvokeResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.InvokeResult.html index 4dfca6c772a5..df511c75122a 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.InvokeResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.InvokeResult.html @@ -1,7 +1,7 @@ InvokeResult | @pulumi/pulumi

    Interface InvokeResult

    InvokeResult represents the results of a call to ResourceProvider.invoke.

    -
    interface InvokeResult {
        failures?: provider.CheckFailure[];
        outputs?: any;
    }

    Properties

    failures? +
    interface InvokeResult {
        failures?: provider.CheckFailure[];
        outputs?: any;
    }

    Properties

    failures? outputs?

    Properties

    Optional Readonly failures

    failures?: provider.CheckFailure[]

    Any validation failures that occurred.

    -

    Optional Readonly outputs

    outputs?: any

    The outputs returned by the invoked function, if any.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    failuresoutputs

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly outputs

    outputs?: any

    The outputs returned by the invoked function, if any.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    failuresoutputs

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.Provider.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.Provider.html index de09773c8ec0..4d0f3fd80d1b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.Provider.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.Provider.html @@ -1,6 +1,6 @@ Provider | @pulumi/pulumi

    Interface Provider

    Provider represents an object that implements the resources and functions for a particular Pulumi package.

    -
    interface Provider {
        call?: ((token, inputs) => Promise<InvokeResult>);
        check?: ((urn, olds, news) => Promise<provider.CheckResult>);
        construct?: ((name, type, inputs, options) => Promise<ConstructResult>);
        create?: ((urn, inputs) => Promise<provider.CreateResult>);
        delete?: ((id, urn, props) => Promise<void>);
        diff?: ((id, urn, olds, news) => Promise<provider.DiffResult>);
        invoke?: ((token, inputs) => Promise<InvokeResult>);
        read?: ((id, urn, props?) => Promise<provider.ReadResult>);
        schema?: string;
        update?: ((id, urn, olds, news) => Promise<provider.UpdateResult>);
        version: string;
    }

    Properties

    call? +
    interface Provider {
        call?: ((token, inputs) => Promise<InvokeResult>);
        check?: ((urn, olds, news) => Promise<provider.CheckResult>);
        construct?: ((name, type, inputs, options) => Promise<ConstructResult>);
        create?: ((urn, inputs) => Promise<provider.CreateResult>);
        delete?: ((id, urn, props) => Promise<void>);
        diff?: ((id, urn, olds, news) => Promise<provider.DiffResult>);
        invoke?: ((token, inputs) => Promise<InvokeResult>);
        read?: ((id, urn, props?) => Promise<provider.ReadResult>);
        schema?: string;
        update?: ((id, urn, olds, news) => Promise<provider.UpdateResult>);
        version: string;
    }

    Properties

    call? check? construct? create? @@ -14,37 +14,37 @@

    Properties

    Optional call

    call?: ((token, inputs) => Promise<InvokeResult>)

    Calls the indicated method.

    Type declaration

      • (token, inputs): Promise<InvokeResult>

      • Parameters

        • token: string

          The token of the method to call.

        • inputs: Inputs

          The inputs to the method.

          -

        Returns Promise<InvokeResult>

    Optional check

    check?: ((urn, olds, news) => Promise<provider.CheckResult>)

    Validates that the given property bag is valid for a resource of the +

    Returns Promise<InvokeResult>

    Optional check

    check?: ((urn, olds, news) => Promise<provider.CheckResult>)

    Validates that the given property bag is valid for a resource of the given type.

    Type declaration

      • (urn, olds, news): Promise<provider.CheckResult>

      • Parameters

        • urn: string
        • olds: any

          The old input properties to use for validation.

        • news: any

          The new input properties to use for validation.

          -

        Returns Promise<provider.CheckResult>

    Optional construct

    construct?: ((name, type, inputs, options) => Promise<ConstructResult>)

    Creates a new component resource.

    +

    Returns Promise<provider.CheckResult>

    Optional construct

    construct?: ((name, type, inputs, options) => Promise<ConstructResult>)

    Creates a new component resource.

    Type declaration

    Optional create

    create?: ((urn, inputs) => Promise<provider.CreateResult>)

    Allocates a new instance of the provided resource and returns its unique +

    Returns Promise<ConstructResult>

    Optional create

    create?: ((urn, inputs) => Promise<provider.CreateResult>)

    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").

    Type declaration

    Optional delete

    delete?: ((id, urn, props) => Promise<void>)

    Tears down an existing resource with the given ID. If it fails, the +

    Returns Promise<provider.CreateResult>

    Optional delete

    delete?: ((id, urn, props) => Promise<void>)

    Tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.

    Type declaration

      • (id, urn, props): Promise<void>

      • Parameters

        • id: string

          The ID of the resource to delete.

        • urn: string
        • props: any

          The current properties on the resource.

          -

        Returns Promise<void>

    Optional diff

    diff?: ((id, urn, olds, news) => Promise<provider.DiffResult>)

    Checks what impacts a hypothetical update will have on the resource's properties.

    +

    Returns Promise<void>

    Optional diff

    diff?: ((id, urn, olds, news) => Promise<provider.DiffResult>)

    Checks what impacts a hypothetical update will have on the resource's properties.

    Type declaration

      • (id, urn, olds, news): Promise<provider.DiffResult>

      • Parameters

        • id: string

          The ID of the resource to diff.

        • urn: string
        • olds: any

          The old values of properties to diff.

        • news: any

          The new values of properties to diff.

          -

        Returns Promise<provider.DiffResult>

    Optional invoke

    invoke?: ((token, inputs) => Promise<InvokeResult>)

    Calls the indicated function.

    +

    Returns Promise<provider.DiffResult>

    Optional invoke

    invoke?: ((token, inputs) => Promise<InvokeResult>)

    Calls the indicated function.

    Type declaration

      • (token, inputs): Promise<InvokeResult>

      • Parameters

        • token: string

          The token of the function to call.

        • inputs: any

          The inputs to the function.

          -

        Returns Promise<InvokeResult>

    Optional read

    read?: ((id, urn, props?) => Promise<provider.ReadResult>)

    Reads the current live state associated with a resource. Enough state +

    Returns Promise<InvokeResult>

    Optional read

    read?: ((id, urn, props?) => Promise<provider.ReadResult>)

    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.

    -

    Type declaration

    Optional schema

    schema?: string

    The JSON-encoded schema for this provider's package.

    -

    Optional update

    update?: ((id, urn, olds, news) => Promise<provider.UpdateResult>)

    Update updates an existing resource with new values.

    +

    Type declaration

    Optional schema

    schema?: string

    The JSON-encoded schema for this provider's package.

    +

    Optional update

    update?: ((id, urn, olds, news) => Promise<provider.UpdateResult>)

    Update updates an existing resource with new values.

    Type declaration

      • (id, urn, olds, news): Promise<provider.UpdateResult>

      • Parameters

        • id: string

          The ID of the resource to update.

        • urn: string
        • olds: any

          The old values of properties to update.

        • news: any

          The new values of properties to update.

          -

        Returns Promise<provider.UpdateResult>

    version

    version: string

    The version of the provider. Must be valid semver.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    callcheckconstructcreatedeletediffinvokereadschemaupdateversion

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<provider.UpdateResult>

    version

    version: string

    The version of the provider. Must be valid semver.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    callcheckconstructcreatedeletediffinvokereadschemaupdateversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ReadResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ReadResult.html index 5f79acb7ef65..fb4586ef7003 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ReadResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ReadResult.html @@ -1,9 +1,9 @@ ReadResult | @pulumi/pulumi

    Interface ReadResult

    ReadResult represents the results of a call to ResourceProvider.read.

    -
    interface ReadResult {
        id?: string;
        inputs?: any;
        props?: any;
    }

    Properties

    id? +
    interface ReadResult {
        id?: string;
        inputs?: any;
        props?: any;
    }

    Properties

    id? inputs? props?

    Properties

    Optional Readonly id

    id?: string

    The ID of the resource ready back (or blank if missing).

    -

    Optional Readonly inputs

    inputs?: any

    The inputs that would lead to the current resource state when importing it.

    -

    Optional Readonly props

    props?: any

    The current property state read from the live environment.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    idinputsprops

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly inputs

    inputs?: any

    The inputs that would lead to the current resource state when importing it.

    +

    Optional Readonly props

    props?: any

    The current property state read from the live environment.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    idinputsprops

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.UpdateResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.UpdateResult.html index 5bd92838c5f8..b7af4ab3502c 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.UpdateResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.UpdateResult.html @@ -1,5 +1,5 @@ UpdateResult | @pulumi/pulumi

    Interface UpdateResult

    UpdateResult represents the results of a call to ResourceProvider.update.

    -
    interface UpdateResult {
        outs?: any;
    }

    Properties

    outs? +
    interface UpdateResult {
        outs?: any;
    }

    Properties

    outs?

    Properties

    Optional Readonly outs

    outs?: any

    Any properties that were computed during updating.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    outs

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    outs

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.CodePathOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.CodePathOptions.html index 7dcc9e37d484..e9a378ffe797 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.CodePathOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.CodePathOptions.html @@ -1,5 +1,5 @@ CodePathOptions | @pulumi/pulumi

    Interface CodePathOptions

    Options for controlling what gets returned by computeCodePaths.

    -
    interface CodePathOptions {
        extraExcludePackages?: string[];
        extraIncludePackages?: string[];
        extraIncludePaths?: string[];
        logResource?: Resource;
    }

    Properties

    extraExcludePackages? +
    interface CodePathOptions {
        extraExcludePackages?: string[];
        extraIncludePackages?: string[];
        extraIncludePaths?: string[];
        logResource?: Resource;
    }

    Properties

    extraExcludePackages? extraIncludePackages? extraIncludePaths? logResource? @@ -7,11 +7,11 @@ This can be used when clients want to trim down the size of a closure, and they know that some package won't ever actually be needed at runtime, but is still a dependency of some package that is being used at runtime.

    -

    Optional extraIncludePackages

    extraIncludePackages?: string[]

    Extra packages to include when producing the assets for a serialized +

    Optional extraIncludePackages

    extraIncludePackages?: string[]

    Extra packages to include when producing the assets for a serialized closure. This can be useful if the packages are acquired in a way that the serialization code does not understand. For example, if there was some sort of module that was pulled in based off of a computed string.

    -

    Optional extraIncludePaths

    extraIncludePaths?: string[]

    Local file/directory paths that we always want to include when producing +

    Optional extraIncludePaths

    extraIncludePaths?: string[]

    Local file/directory paths that we always want to include when producing the assets to be included for a serialized closure.

    -

    Optional logResource

    logResource?: Resource

    The resource to log any errors we encounter against.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    extraExcludePackagesextraIncludePackagesextraIncludePathslogResource

    Generated using TypeDoc

    \ No newline at end of file +

    Optional logResource

    logResource?: Resource

    The resource to log any errors we encounter against.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    extraExcludePackagesextraIncludePackagesextraIncludePathslogResource

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockCallArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockCallArgs.html index ee8e51aa39dd..d7aff28f50e4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockCallArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockCallArgs.html @@ -1,10 +1,10 @@ MockCallArgs | @pulumi/pulumi

    Interface MockCallArgs

    MockResourceArgs is used to construct call mocks.

    -
    interface MockCallArgs {
        inputs: any;
        provider?: string;
        token: string;
    }

    Properties

    inputs +
    interface MockCallArgs {
        inputs: any;
        provider?: string;
        token: string;
    }

    Properties

    inputs provider? token

    Properties

    inputs

    inputs: any

    The arguments provided to the function call.

    -

    Optional provider

    provider?: string

    If provided, the identifier of the provider instance being used to make +

    Optional provider

    provider?: string

    If provided, the identifier of the provider instance being used to make the call.

    -

    token

    token: string

    The token that indicates which function is being called. This token is of +

    token

    token: string

    The token that indicates which function is being called. This token is of the form "package:module:function".

    -

    Settings

    Member Visibility

    Theme

    On This Page

    inputsprovidertoken

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    inputsprovidertoken

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockResourceArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockResourceArgs.html index c5ca76e05723..6032ab469572 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockResourceArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockResourceArgs.html @@ -1,5 +1,5 @@ MockResourceArgs | @pulumi/pulumi

    Interface MockResourceArgs

    MockResourceArgs is used to construct a new resource mock.

    -
    interface MockResourceArgs {
        custom?: boolean;
        id?: string;
        inputs: any;
        name: string;
        provider?: string;
        type: string;
    }

    Properties

    custom? +
    interface MockResourceArgs {
        custom?: boolean;
        id?: string;
        inputs: any;
        name: string;
        provider?: string;
        type: string;
    }

    Properties

    custom? id? inputs name @@ -7,12 +7,12 @@ type

    Properties

    Optional custom

    custom?: boolean

    Specifies whether or not the resource is Custom (i.e. managed by a resource provider).

    -

    Optional id

    id?: string

    If provided, the physical identifier of an existing resource to read or +

    Optional id

    id?: string

    If provided, the physical identifier of an existing resource to read or import.

    -

    inputs

    inputs: any

    The inputs for the resource.

    -

    name

    name: string

    The logical name of the resource instance.

    -

    Optional provider

    provider?: string

    If provided, the identifier of the provider instance being used to manage +

    inputs

    inputs: any

    The inputs for the resource.

    +

    name

    name: string

    The logical name of the resource instance.

    +

    Optional provider

    provider?: string

    If provided, the identifier of the provider instance being used to manage this resource.

    -

    type

    type: string

    The token that indicates which resource type is being constructed. This +

    type

    type: string

    The token that indicates which resource type is being constructed. This token is of the form "package:module:type".

    -

    Settings

    Member Visibility

    Theme

    On This Page

    customidinputsnameprovidertype

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    customidinputsnameprovidertype

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Mocks.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Mocks.html index d17162161855..f45b4ab4ff36 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Mocks.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Mocks.html @@ -2,12 +2,12 @@ implemented by the Pulumi engine with their own implementations. This can be used during testing to ensure that calls to provider functions and resource constructors return predictable values.

    -
    interface Mocks {
        call(args): MockCallResult | Promise<MockCallResult>;
        newResource(args): MockResourceResult | Promise<MockResourceResult>;
    }

    Methods

    call +
    interface Mocks {
        call(args): MockCallResult | Promise<MockCallResult>;
        newResource(args): MockResourceResult | Promise<MockResourceResult>;
    }

    Methods

    call newResource

    Methods

    call

    newResource

    Returns MockCallResult | Promise<MockCallResult>

    newResource

    Settings

    Member Visibility

    Theme

    On This Page

    callnewResource

    Generated using TypeDoc

    \ No newline at end of file +

    Returns MockResourceResult | Promise<MockResourceResult>

    Settings

    Member Visibility

    Theme

    On This Page

    callnewResource

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Options.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Options.html index 085633c30179..f1ac48ad0590 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Options.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Options.html @@ -1,6 +1,6 @@ Options | @pulumi/pulumi

    Interface Options

    Options is a bag of settings that controls the behavior of previews and deployments.

    -
    interface Options {
        cacheDynamicProviders?: boolean;
        dryRun?: boolean;
        engineAddr?: string;
        legacyApply?: boolean;
        monitorAddr?: string;
        organization?: string;
        parallel?: number;
        project?: string;
        queryMode?: boolean;
        stack?: string;
        syncDir?: string;
        testModeEnabled?: boolean;
    }

    Properties

    cacheDynamicProviders? +
    interface Options {
        cacheDynamicProviders?: boolean;
        dryRun?: boolean;
        engineAddr?: string;
        legacyApply?: boolean;
        monitorAddr?: string;
        organization?: string;
        parallel?: number;
        project?: string;
        queryMode?: boolean;
        stack?: string;
        syncDir?: string;
        testModeEnabled?: boolean;
    }

    Properties

    cacheDynamicProviders? dryRun? engineAddr? legacyApply? @@ -13,16 +13,16 @@ syncDir? testModeEnabled?

    Properties

    Optional Readonly cacheDynamicProviders

    cacheDynamicProviders?: boolean

    True if we will cache serialized dynamic providers on the program side.

    -

    Optional Readonly dryRun

    dryRun?: boolean

    Whether we are performing a preview (true) or a real deployment (false).

    -

    Optional Readonly engineAddr

    engineAddr?: string

    A connection string to the engine's RPC, in case we need to reestablish.

    -

    Optional Readonly legacyApply

    legacyApply?: boolean

    True if we will resolve missing outputs to inputs during preview.

    -

    Optional Readonly monitorAddr

    monitorAddr?: string

    A connection string to the monitor's RPC, in case we need to reestablish.

    -

    Optional Readonly organization

    organization?: string

    The name of the current organization.

    -

    Optional Readonly parallel

    parallel?: number

    The degree of parallelism for resource operations (default is serial).

    -

    Optional Readonly project

    project?: string

    The name of the current project.

    -

    Optional Readonly queryMode

    queryMode?: boolean

    True if we're in query mode (does not allow resource registration).

    -

    Optional Readonly stack

    stack?: string

    The name of the current stack being deployed into.

    -

    Optional Readonly syncDir

    syncDir?: string

    A directory containing the send/receive files for making synchronous +

    Optional Readonly dryRun

    dryRun?: boolean

    Whether we are performing a preview (true) or a real deployment (false).

    +

    Optional Readonly engineAddr

    engineAddr?: string

    A connection string to the engine's RPC, in case we need to reestablish.

    +

    Optional Readonly legacyApply

    legacyApply?: boolean

    True if we will resolve missing outputs to inputs during preview.

    +

    Optional Readonly monitorAddr

    monitorAddr?: string

    A connection string to the monitor's RPC, in case we need to reestablish.

    +

    Optional Readonly organization

    organization?: string

    The name of the current organization.

    +

    Optional Readonly parallel

    parallel?: number

    The degree of parallelism for resource operations (default is serial).

    +

    Optional Readonly project

    project?: string

    The name of the current project.

    +

    Optional Readonly queryMode

    queryMode?: boolean

    True if we're in query mode (does not allow resource registration).

    +

    Optional Readonly stack

    stack?: string

    The name of the current stack being deployed into.

    +

    Optional Readonly syncDir

    syncDir?: string

    A directory containing the send/receive files for making synchronous invokes to the engine.

    -

    Optional Readonly testModeEnabled

    testModeEnabled?: boolean

    True if we're in testing mode (allows execution without the CLI).

    -

    Settings

    Member Visibility

    Theme

    On This Page

    cacheDynamicProvidersdryRunengineAddrlegacyApplymonitorAddrorganizationparallelprojectqueryModestacksyncDirtestModeEnabled

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly testModeEnabled

    testModeEnabled?: boolean

    True if we're in testing mode (allows execution without the CLI).

    +

    Settings

    Member Visibility

    Theme

    On This Page

    cacheDynamicProvidersdryRunengineAddrlegacyApplymonitorAddrorganizationparallelprojectqueryModestacksyncDirtestModeEnabled

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourceModule.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourceModule.html index 422663bdfd9f..e752769f4ea5 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourceModule.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourceModule.html @@ -1,5 +1,5 @@ ResourceModule | @pulumi/pulumi

    Interface ResourceModule

    A ResourceModule is a type that understands how to construct resources given a name, type, args, and URN.

    -
    interface ResourceModule {
        version?: string;
        construct(name, type, urn): Resource;
    }

    Properties

    version? +
    interface ResourceModule {
        version?: string;
        construct(name, type, urn): Resource;
    }

    Properties

    version?

    Methods

    construct -

    Properties

    Optional Readonly version

    version?: string

    Methods

    construct

    Settings

    Member Visibility

    Theme

    On This Page

    versionconstruct

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Readonly version

    version?: string

    Methods

    construct

    Settings

    Member Visibility

    Theme

    On This Page

    versionconstruct

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourcePackage.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourcePackage.html index 22b20909a39b..327d638e2c21 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourcePackage.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourcePackage.html @@ -1,5 +1,5 @@ ResourcePackage | @pulumi/pulumi

    Interface ResourcePackage

    A ResourcePackage is a type that understands how to construct resource providers given a name, type, args, and URN.

    -
    interface ResourcePackage {
        version?: string;
        constructProvider(name, type, urn): ProviderResource;
    }

    Properties

    version? +
    interface ResourcePackage {
        version?: string;
        constructProvider(name, type, urn): ProviderResource;
    }

    Properties

    version?

    Methods

    constructProvider -

    Properties

    Optional Readonly version

    version?: string

    Methods

    constructProvider

    Settings

    Member Visibility

    Theme

    On This Page

    versionconstructProvider

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Readonly version

    version?: string

    Methods

    constructProvider

    Settings

    Member Visibility

    Theme

    On This Page

    versionconstructProvider

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializationOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializationOptions.html index ad6ae536e676..8620b175b46f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializationOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializationOptions.html @@ -1,5 +1,5 @@ SerializationOptions | @pulumi/pulumi

    Interface SerializationOptions

    Controls the serialization of RPC structures.

    -
    interface SerializationOptions {
        keepOutputValues?: boolean;
    }

    Properties

    keepOutputValues? +
    interface SerializationOptions {
        keepOutputValues?: boolean;
    }

    Properties

    keepOutputValues?

    Properties

    Optional keepOutputValues

    keepOutputValues?: boolean

    True if we are keeping output values. If the monitor does not support output values, they will not be kept, even when this is set to true.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    keepOutputValues

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    keepOutputValues

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializeFunctionArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializeFunctionArgs.html index d94e805d6433..2aa2a7eed456 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializeFunctionArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializeFunctionArgs.html @@ -1,6 +1,6 @@ SerializeFunctionArgs | @pulumi/pulumi

    Interface SerializeFunctionArgs

    SerializeFunctionArgs are arguments used to serialize a JavaScript function.

    -
    interface SerializeFunctionArgs {
        allowSecrets?: boolean;
        exportName?: string;
        isFactoryFunction?: boolean;
        logResource?: Resource;
        serialize?: ((o) => boolean);
    }

    Properties

    allowSecrets? +
    interface SerializeFunctionArgs {
        allowSecrets?: boolean;
        exportName?: string;
        isFactoryFunction?: boolean;
        logResource?: Resource;
        serialize?: ((o) => boolean);
    }

    Properties

    allowSecrets? exportName? isFactoryFunction? logResource? @@ -12,16 +12,16 @@ containsSecrets property on the returned SerializedFunction object will indicate whether secrets were serialized into the function text.

    -

    Optional exportName

    exportName?: string

    The name to export from the module defined by the generated module text. +

    Optional exportName

    exportName?: string

    The name to export from the module defined by the generated module text. Defaults to handler.

    -

    Optional isFactoryFunction

    isFactoryFunction?: boolean

    True if this is a function which, when invoked, will produce the actual +

    Optional isFactoryFunction

    isFactoryFunction?: boolean

    True if this is a function which, when invoked, will produce the actual entrypoint function. Useful for when serializing a function that has high startup cost that we'd ideally only run once. The signature of this function should be () => (provider_handler_args...) => provider_result.

    This will then be emitted as exports.[exportName] = serialized_func_name();

    In other words, the function will be invoked (once) and the resulting inner function will be what is exported.

    -

    Optional logResource

    logResource?: Resource

    The resource to log any errors we encounter against.

    -

    Optional serialize

    serialize?: ((o) => boolean)

    A function to prevent serialization of certain objects captured during +

    Optional logResource

    logResource?: Resource

    The resource to log any errors we encounter against.

    +

    Optional serialize

    serialize?: ((o) => boolean)

    A function to prevent serialization of certain objects captured during the serialization. Primarily used to prevent potential cycles.

    -

    Type declaration

      • (o): boolean

      • Parameters

        • o: any

        Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    allowSecretsexportNameisFactoryFunctionlogResourceserialize

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

      • (o): boolean

      • Parameters

        • o: any

        Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    allowSecretsexportNameisFactoryFunctionlogResourceserialize

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializedFunction.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializedFunction.html index 5f612c06206d..2481640b2b32 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializedFunction.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializedFunction.html @@ -1,12 +1,12 @@ SerializedFunction | @pulumi/pulumi

    Interface SerializedFunction

    SerializedFunction is a representation of a serialized JavaScript function.

    -
    interface SerializedFunction {
        containsSecrets: boolean;
        exportName: string;
        text: string;
    }

    Properties

    containsSecrets +
    interface SerializedFunction {
        containsSecrets: boolean;
        exportName: string;
        text: string;
    }

    Properties

    containsSecrets exportName text

    Properties

    containsSecrets

    containsSecrets: boolean

    True if the serialized function text includes serialized secrets.

    -

    exportName

    exportName: string

    The name of the exported module member.

    -

    text

    text: string

    The text of a JavaScript module which exports a single name bound to an +

    exportName

    exportName: string

    The name of the exported module member.

    +

    text

    text: string

    The text of a JavaScript module which exports a single name bound to an appropriate value. In the case of a normal function, this value will just be serialized function. In the case of a factory function this value will be the result of invoking the factory function.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    containsSecretsexportNametext

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    containsSecretsexportNametext

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SourcePosition.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SourcePosition.html index 71aead15774a..77528ba32486 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SourcePosition.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SourcePosition.html @@ -1,4 +1,4 @@ -SourcePosition | @pulumi/pulumi

    Interface SourcePosition

    interface SourcePosition {
        column: number;
        line: number;
        uri: string;
    }

    Properties

    column +SourcePosition | @pulumi/pulumi

    Interface SourcePosition

    interface SourcePosition {
        column: number;
        line: number;
        uri: string;
    }

    Properties

    column line uri -

    Properties

    column

    column: number

    line

    line: number

    uri

    uri: string

    Settings

    Member Visibility

    Theme

    On This Page

    columnlineuri

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    column

    column: number

    line

    line: number

    uri

    uri: string

    Settings

    Member Visibility

    Theme

    On This Page

    columnlineuri

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/asset.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/asset.html index 55cb12937c34..794e190bf2f5 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/asset.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/asset.html @@ -1,4 +1,4 @@ -asset | @pulumi/pulumi

    Namespace asset

    Index

    Classes

    Archive +asset | @pulumi/pulumi

    Namespace asset

    Index

    Classes

    Archive Asset AssetArchive FileArchive diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/automation.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/automation.html index b431cd730d7b..064e72894412 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/automation.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/automation.html @@ -1,4 +1,4 @@ -automation | @pulumi/pulumi

    Namespace automation

    Index

    Enumerations

    DiffKind +automation | @pulumi/pulumi

    Namespace automation

    Index

    Enumerations

    DiffKind

    Classes

    CommandError ConcurrentUpdateError LocalWorkspace diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/dynamic.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/dynamic.html index f5fd5e6c6c5a..7c3b4d1e3963 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/dynamic.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/dynamic.html @@ -1,4 +1,4 @@ -dynamic | @pulumi/pulumi

    Namespace dynamic

    Index

    Classes

    Resource +dynamic | @pulumi/pulumi

    Namespace dynamic

    Index

    Classes

    Resource

    Interfaces

    CheckFailure CheckResult CreateResult diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/iterable.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/iterable.html index af823189d434..18af9912847f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/iterable.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/iterable.html @@ -1,3 +1,3 @@ -iterable | @pulumi/pulumi

    Namespace iterable

    Index

    Functions

    groupBy +iterable | @pulumi/pulumi

    Namespace iterable

    Index

    Functions

    groupBy toObject

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/log.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/log.html index 8cd2436d4604..cc039662e852 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/log.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/log.html @@ -1,4 +1,4 @@ -log | @pulumi/pulumi

    Namespace log

    Index

    Functions

    debug +log | @pulumi/pulumi

    Namespace log

    Index

    Functions

    debug error hasErrors info diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/provider.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/provider.html index 7c2f8155dd3a..d7098aa65426 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/provider.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/provider.html @@ -1,4 +1,4 @@ -provider | @pulumi/pulumi

    Namespace provider

    Index

    Interfaces

    CheckFailure +provider | @pulumi/pulumi

    Namespace provider

    Index

    Interfaces

    CheckFailure CheckResult ConstructResult CreateResult diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/runtime.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/runtime.html index 64b6ce67f1d7..47f48e6c17d8 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/runtime.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/runtime.html @@ -1,4 +1,4 @@ -runtime | @pulumi/pulumi

    Namespace runtime

    Index

    Classes

    Stack +runtime | @pulumi/pulumi

    Namespace runtime

    Index

    Classes

    Stack StreamInvokeResponse

    Interfaces

    CodePathOptions MockCallArgs diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/utils.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/utils.html index 6ffbd54856c8..88341c0d655e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/utils.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/utils.html @@ -1 +1 @@ -utils | @pulumi/pulumi

    Namespace utils

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +utils | @pulumi/pulumi

    Namespace utils

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ID.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ID.html index 521da8e3fe17..e9c14a4b51a3 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ID.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ID.html @@ -1 +1 @@ -ID | @pulumi/pulumi

    Type alias ID

    ID: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ID | @pulumi/pulumi

    Type alias ID

    ID: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Input.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Input.html index 2090aeb8207b..b0bbd79a3838 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Input.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Input.html @@ -1,4 +1,4 @@ Input | @pulumi/pulumi

    Type alias Input<T>

    Input<T>: T | Promise<T> | OutputInstance<T>

    Input is a property input for a resource. It may be a promptly available T, a promise for one, or the Output from a existing Resource.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Inputs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Inputs.html index 911d056d5a91..ae275504fe53 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Inputs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Inputs.html @@ -1,3 +1,3 @@ Inputs | @pulumi/pulumi

    Type alias Inputs

    Inputs: Record<string, Input<any>>

    Inputs is a map of property name to property input, one for each resource property value.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/InvokeTransform.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/InvokeTransform.html index adc8c441ec69..546cd7208081 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/InvokeTransform.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/InvokeTransform.html @@ -6,4 +6,4 @@ in place of the original call to the Invoke. If the transform returns nil, this indicates that the Invoke

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Lifted.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Lifted.html index fa3ffab95a20..3f13b927955d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Lifted.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Lifted.html @@ -19,4 +19,4 @@

    Instead, you still need to write;

         const o: Output<string> = ...;
         const c: Output<number> = o.apply(v => v.charCodeAt(0));
    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedArray.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedArray.html index db7bcc18af4e..63b18780edde 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedArray.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedArray.html @@ -1,3 +1,3 @@ LiftedArray | @pulumi/pulumi

    Type alias LiftedArray<T>

    LiftedArray<T>: {
        length: Output<number>;
        [n: number]: Output<T>;
    }

    Type Parameters

    • T

    Type declaration

    • [n: number]: Output<T>
    • Readonly length: Output<number>

      Gets the length of the array. This is a number one higher than the highest element defined in an array.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedObject.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedObject.html index 036ebef11148..1cf4debf0985 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedObject.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedObject.html @@ -1 +1 @@ -LiftedObject | @pulumi/pulumi

    Type alias LiftedObject<T, K>

    LiftedObject<T, K>: {
        [P in K]: T[P] extends OutputInstance<infer T1>
            ? Output<T1>
            : T[P] extends Promise<infer T2>
                ? Output<T2>
                : Output<T[P]>
    }

    Type Parameters

    • T
    • K extends keyof T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +LiftedObject | @pulumi/pulumi

    Type alias LiftedObject<T, K>

    LiftedObject<T, K>: {
        [P in K]: IsStrictlyAny<T[P]> extends true
            ? Output<any>
            : T[P] extends OutputInstance<infer T1>
                ? Output<T1>
                : T[P] extends Promise<infer T2>
                    ? Output<T2>
                    : Output<T[P]>
    }

    Type Parameters

    • T
    • K extends keyof T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Output.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Output.html index d67632a4cec2..0a8d586b9559 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Output.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Output.html @@ -27,4 +27,4 @@

    Instead of having to write:

         const o: Output<{ name: string, age: number, orders: Order[] }> = ...;
         const name : Output<string> = o.apply(v => v.name);
         const age  : Output<number> = o.apply(v => v.age);
         const first: Output<Order> = o.apply(v => v.orders[0]);
    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransform.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransform.html index afa930dd2a14..56d4aadbbb35 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransform.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransform.html @@ -6,4 +6,4 @@ place of the original call to the Resource constructor. If the transform returns undefined, this indicates that the resource will not be transformed.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransformation.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransformation.html index 09faa6083b46..a19c590fe6d3 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransformation.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransformation.html @@ -6,4 +6,4 @@ and opts were passed in place of the original call to the Resource constructor. If the transformation returns undefined, this indicates that the resource will not be transformed.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/URN.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/URN.html index f9933a19223e..47d341b2fe29 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/URN.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/URN.html @@ -1 +1 @@ -URN | @pulumi/pulumi

    Type alias URN

    URN: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +URN | @pulumi/pulumi

    Type alias URN

    URN: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Unwrap.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Unwrap.html index 7cf295690028..81608fd0e004 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Unwrap.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Unwrap.html @@ -16,4 +16,4 @@ Or, it should start with an output and call apply on it, passing in an async function. This will also collapse and just produce an output.

    In other words, this should not be used as the shape of an object: { a: Promise<Output<...>> }. It should always either be { a: Promise<NonOutput> } or just { a: Output<...> }.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrapSimple.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrapSimple.html index f93f3b1e596f..1320680730a5 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrapSimple.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrapSimple.html @@ -1,2 +1,2 @@ UnwrapSimple | @pulumi/pulumi

    Type alias UnwrapSimple<T>

    UnwrapSimple<T>: T extends primitive
        ? T
        : T extends Resource
            ? T
            : T extends (infer U)[]
                ? UnwrappedArray<U>
                : T extends object
                    ? UnwrappedObject<T>
                    : never

    Handles encountering basic types when unwrapping.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedArray.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedArray.html index 2ef28e74f7a8..f356bda7d949 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedArray.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedArray.html @@ -1 +1 @@ -UnwrappedArray | @pulumi/pulumi

    Type alias UnwrappedArray<T>

    UnwrappedArray<T>: Unwrap<T>[]

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +UnwrappedArray | @pulumi/pulumi

    Type alias UnwrappedArray<T>

    UnwrappedArray<T>: Unwrap<T>[]

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedObject.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedObject.html index 63e8859b1ad4..fbd2c4cbd97e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedObject.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedObject.html @@ -1 +1 @@ -UnwrappedObject | @pulumi/pulumi

    Type alias UnwrappedObject<T>

    UnwrappedObject<T>: {
        [P in keyof T]: Unwrap<T[P]>
    }

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +UnwrappedObject | @pulumi/pulumi

    Type alias UnwrappedObject<T>

    UnwrappedObject<T>: {
        [P in keyof T]: Unwrap<T[P]>
    }

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/asset.AssetMap.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/asset.AssetMap.html index 045deead0a63..dcff4c14e74d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/asset.AssetMap.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/asset.AssetMap.html @@ -1,2 +1,2 @@ AssetMap | @pulumi/pulumi

    Type alias AssetMap

    AssetMap: {
        [name: string]: Asset | Archive;
    }

    A map of assets.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.CancelEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.CancelEvent.html index 4332b4bd672e..2a2653988fde 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.CancelEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.CancelEvent.html @@ -1,3 +1,3 @@ CancelEvent | @pulumi/pulumi

    Type alias CancelEvent

    CancelEvent: {}

    CancelEvent is emitted when the user initiates a cancellation of the update in progress, or the update successfully completes.

    -

    Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ConfigMap.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ConfigMap.html index 9f5832c21245..e84854106bc6 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ConfigMap.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ConfigMap.html @@ -1,2 +1,2 @@ ConfigMap | @pulumi/pulumi

        Type alias ConfigMap

        ConfigMap: {
            [key: string]: ConfigValue;
        }

        A map of configuration values.

        -

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpMap.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpMap.html index a70e78940232..7c2699b78e4b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpMap.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpMap.html @@ -1,2 +1,2 @@ OpMap | @pulumi/pulumi

        Type alias OpMap

        OpMap: {
            [key in OpType]?: number
        }

        A map of operation types and their corresponding counts.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpType.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpType.html index 5e88c5c59d07..de8b0e5151ee 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpType.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpType.html @@ -1,2 +1,2 @@ OpType | @pulumi/pulumi

        Type alias OpType

        OpType: "same" | "create" | "update" | "delete" | "replace" | "create-replacement" | "delete-replaced" | "read" | "read-replacement" | "refresh" | "discard" | "discard-replaced" | "remove-pending-replace" | "import" | "import-replacement"

        The granular CRUD operation performed on a particular resource during an update.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OutputMap.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OutputMap.html index 00656156d765..9911c786aba4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OutputMap.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OutputMap.html @@ -1,3 +1,3 @@ OutputMap | @pulumi/pulumi

        Type alias OutputMap

        OutputMap: {
            [key: string]: OutputValue;
        }

        A set of outputs, keyed by name, that might be returned by a Pulumi program as part of a stack operation.

        -

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PluginKind.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PluginKind.html index 4f843e8618a1..b822e06711c8 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PluginKind.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PluginKind.html @@ -1 +1 @@ -PluginKind | @pulumi/pulumi

        Type alias PluginKind

        PluginKind: "analyzer" | "language" | "resource"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PluginKind | @pulumi/pulumi

        Type alias PluginKind

        PluginKind: "analyzer" | "language" | "resource"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ProjectRuntime.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ProjectRuntime.html index e1be55843091..6785b04c899f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ProjectRuntime.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ProjectRuntime.html @@ -1,2 +1,2 @@ ProjectRuntime | @pulumi/pulumi

        Type alias ProjectRuntime

        ProjectRuntime: "nodejs" | "go" | "python" | "dotnet"

        Supported Pulumi program language runtimes.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PulumiFn.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PulumiFn.html index ea1d6223da62..503d4e8e1277 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PulumiFn.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PulumiFn.html @@ -1,2 +1,2 @@ PulumiFn | @pulumi/pulumi

        Type alias PulumiFn

        PulumiFn: (() => Promise<Record<string, any> | void>)

        A Pulumi program as an inline function (in process).

        -

        Type declaration

          • (): Promise<Record<string, any> | void>

          • Returns Promise<Record<string, any> | void>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

          • (): Promise<Record<string, any> | void>

          • Returns Promise<Record<string, any> | void>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.RawJSON.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.RawJSON.html index 407477ed66e5..5f65a47b0442 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.RawJSON.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.RawJSON.html @@ -1,2 +1,2 @@ RawJSON | @pulumi/pulumi

        Type alias RawJSON

        RawJSON: string

        An unstructured JSON string used for back-compat with versioned APIs (such as Deployment).

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.StackSettingsConfigValue.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.StackSettingsConfigValue.html index 96964310c11b..48655e1eb773 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.StackSettingsConfigValue.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.StackSettingsConfigValue.html @@ -1,2 +1,2 @@ StackSettingsConfigValue | @pulumi/pulumi

        Type alias StackSettingsConfigValue

        StackSettingsConfigValue: string | StackSettingsSecureConfigValue | any

        A stack configuration entry.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.TagMap.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.TagMap.html index a19cee32e84a..730b062900fb 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.TagMap.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.TagMap.html @@ -1,3 +1,3 @@ TagMap | @pulumi/pulumi

        Type alias TagMap

        TagMap: {
            [key: string]: string;
        }

        A TagMap is a key-value map of tag metadata associated with a Stack.

        -

        Type declaration

        • [key: string]: string

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        • [key: string]: string

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateKind.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateKind.html index 11f1c860fdc8..f2658e81ae7a 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateKind.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateKind.html @@ -1,2 +1,2 @@ UpdateKind | @pulumi/pulumi

        Type alias UpdateKind

        UpdateKind: "update" | "preview" | "refresh" | "rename" | "destroy" | "import"

        The kind of update that was performed on the stack.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateResult.html index 9accbfdb2004..cda3e8f38db5 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateResult.html @@ -1,2 +1,2 @@ UpdateResult | @pulumi/pulumi

        Type alias UpdateResult

        UpdateResult: "not-started" | "in-progress" | "succeeded" | "failed"

        Represents the current status of a given update.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockCallResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockCallResult.html index 4e09251a157c..6b53a5d4f52a 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockCallResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockCallResult.html @@ -1,2 +1,2 @@ MockCallResult | @pulumi/pulumi

        Type alias MockCallResult

        MockCallResult: Record<string, any>

        MockCallResult is the result of a call mock.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockResourceResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockResourceResult.html index 27bb7c670bb4..ae7e871a177a 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockResourceResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockResourceResult.html @@ -1,4 +1,4 @@ MockResourceResult | @pulumi/pulumi

        Type alias MockResourceResult

        MockResourceResult: {
            id: string | undefined;
            state: Record<string, any>;
        }

        MockResourceResult is the result of a new resource mock, returning a physical identifier and the output properties for the resource being constructed.

        -

        Type declaration

        • id: string | undefined
        • state: Record<string, any>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        • id: string | undefined
        • state: Record<string, any>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.OutputResolvers.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.OutputResolvers.html index c6d773f38fe7..a7429ee3367d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.OutputResolvers.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.OutputResolvers.html @@ -1 +1 @@ -OutputResolvers | @pulumi/pulumi

        Type alias OutputResolvers

        OutputResolvers: Record<string, ((value, isStable, isSecret, deps?, err?) => void)>

        Type declaration

          • (value, isStable, isSecret, deps?, err?): void

          • Parameters

            • value: any
            • isStable: boolean
            • isSecret: boolean
            • Optional deps: Resource[]
            • Optional err: Error

            Returns void

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +OutputResolvers | @pulumi/pulumi

        Type alias OutputResolvers

        OutputResolvers: Record<string, ((value, isStable, isSecret, deps?, err?) => void)>

        Type declaration

          • (value, isStable, isSecret, deps?, err?): void

          • Parameters

            • value: any
            • isStable: boolean
            • isSecret: boolean
            • Optional deps: Resource[]
            • Optional err: Error

            Returns void

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/Output-1.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/Output-1.html index 5ceb4eeb5073..c1d06be018dc 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/Output-1.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/Output-1.html @@ -1 +1 @@ -Output | @pulumi/pulumi

        Variable Output

        Output: OutputConstructor

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +Output | @pulumi/pulumi

        Variable Output

        Output: OutputConstructor

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/rootStackResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/rootStackResource.html index e2b3083e7b30..c067f9adabb7 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/rootStackResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/rootStackResource.html @@ -9,4 +9,4 @@

        However, the former form is preferable as it is more self-descriptive, while the latter may look a bit confusing and may incorrectly look like something that could be removed without changing semantics.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.excessiveDebugOutput.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.excessiveDebugOutput.html index 366b4790a75c..8b883fbc6a13 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.excessiveDebugOutput.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.excessiveDebugOutput.html @@ -1,3 +1,3 @@ excessiveDebugOutput | @pulumi/pulumi

        Variable excessiveDebugOutputConst

        excessiveDebugOutput: boolean = false

        excessiveDebugOutput enables, well, pretty excessive debug output pertaining to resources and properties.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.rootPulumiStackTypeName.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.rootPulumiStackTypeName.html index a20701d2403e..3b101f8beb61 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.rootPulumiStackTypeName.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.rootPulumiStackTypeName.html @@ -1,4 +1,4 @@ rootPulumiStackTypeName | @pulumi/pulumi

        Variable rootPulumiStackTypeNameConst

        rootPulumiStackTypeName: "pulumi:pulumi:Stack" = "pulumi:pulumi:Stack"

        The type name that should be used to construct the root component in the tree of Pulumi resources allocated by a deployment. This must be kept up to date with github.com/pulumi/pulumi/sdk/v3/go/common/resource/stack.RootStackType.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialArchiveSig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialArchiveSig.html index 3020af2cf8f4..a642f252dd6e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialArchiveSig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialArchiveSig.html @@ -1,4 +1,4 @@ specialArchiveSig | @pulumi/pulumi

        Variable specialArchiveSigConst

        specialArchiveSig: "0def7320c3a5731c473e5ecbe6d01bc7" = "0def7320c3a5731c473e5ecbe6d01bc7"

        specialArchiveSig is a randomly assigned hash used to identify archives in maps.

        See

        sdk/go/common/resource/asset.go.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialAssetSig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialAssetSig.html index 2b271fcd1545..e5b1ee48da13 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialAssetSig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialAssetSig.html @@ -1,4 +1,4 @@ specialAssetSig | @pulumi/pulumi

        Variable specialAssetSigConst

        specialAssetSig: "c44067f5952c0a294b673a41bacd8c17" = "c44067f5952c0a294b673a41bacd8c17"

        specialAssetSig is a randomly assigned hash used to identify assets in maps.

        See

        sdk/go/common/resource/asset.go.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialOutputValueSig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialOutputValueSig.html index 3de581792bf6..1fe47ae153fe 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialOutputValueSig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialOutputValueSig.html @@ -1,4 +1,4 @@ specialOutputValueSig | @pulumi/pulumi

        Variable specialOutputValueSigConst

        specialOutputValueSig: "d0e6a833031e9bbcd3f4e8bde6ca49a4" = "d0e6a833031e9bbcd3f4e8bde6ca49a4"

        specialOutputValueSig is a randomly assigned hash used to identify outputs in maps.

        See

        sdk/go/common/resource/properties.go.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialResourceSig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialResourceSig.html index 0a581570b9c1..9081279fbb8e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialResourceSig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialResourceSig.html @@ -1,4 +1,4 @@ specialResourceSig | @pulumi/pulumi

        Variable specialResourceSigConst

        specialResourceSig: "5cf8f73096256a8f31e491e813e4eb8e" = "5cf8f73096256a8f31e491e813e4eb8e"

        specialResourceSig is a randomly assigned hash used to identify resources in maps.

        See

        sdk/go/common/resource/properties.go.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSecretSig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSecretSig.html index fd43aecbb8b5..84d7a15c005b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSecretSig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSecretSig.html @@ -1,4 +1,4 @@ specialSecretSig | @pulumi/pulumi

        Variable specialSecretSigConst

        specialSecretSig: "1b47061264138c4ac30d75fd1eb44270" = "1b47061264138c4ac30d75fd1eb44270"

        specialSecretSig is a randomly assigned hash used to identify secrets in maps.

        See

        sdk/go/common/resource/properties.go.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSigKey.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSigKey.html index 9eebc35a582e..ce69c1b6e7b4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSigKey.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSigKey.html @@ -1,4 +1,4 @@ specialSigKey | @pulumi/pulumi

        Variable specialSigKeyConst

        specialSigKey: "4dabf18193072939515e22adb298388d" = "4dabf18193072939515e22adb298388d"

        specialSigKey is sometimes used to encode type identity inside of a map.

        See

        sdk/go/common/resource/properties.go.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.unknownValue.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.unknownValue.html index 817da3346574..1dbf1381b037 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.unknownValue.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.unknownValue.html @@ -1,2 +1,2 @@ unknownValue | @pulumi/pulumi

        Variable unknownValueConst

        unknownValue: "04da6b54-80e4-46f7-96ec-b56ff0331ba9" = "04da6b54-80e4-46f7-96ec-b56ff0331ba9"

        Unknown values are encoded as a distinguished string value.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/python/pulumi/index.html b/static-prebuilt/docs/reference/pkg/python/pulumi/index.html index 4e382ead412e..e187271b66e0 100644 --- a/static-prebuilt/docs/reference/pkg/python/pulumi/index.html +++ b/static-prebuilt/docs/reference/pkg/python/pulumi/index.html @@ -2083,7 +2083,7 @@
        -outputs: Output[dict]
        +outputs: Output[Dict[str, Any]]

        The outputs of the referenced stack.

        diff --git a/static/latest-version b/static/latest-version index 3dc537b288fa..899701957e0d 100644 --- a/static/latest-version +++ b/static/latest-version @@ -1 +1 @@ -3.129.0 \ No newline at end of file +3.130.0 \ No newline at end of file