diff --git a/content/docs/cli/commands/pulumi.md b/content/docs/cli/commands/pulumi.md index 679441c45b3e..c70248709fae 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_about.md b/content/docs/cli/commands/pulumi_about.md index 57d3565a2955..04fcad417bb6 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_cancel.md b/content/docs/cli/commands/pulumi_cancel.md index 2063f87fc8f9..7f88e0afb8aa 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_config.md b/content/docs/cli/commands/pulumi_config.md index 24892717e625..f4572ac5e3ab 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_config_cp.md b/content/docs/cli/commands/pulumi_config_cp.md index a951d50e9f9c..dd8ed5aa4296 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_config_env.md b/content/docs/cli/commands/pulumi_config_env.md index 1b7115f52ffb..0f394d0e3abb 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_config_env_add.md b/content/docs/cli/commands/pulumi_config_env_add.md index 7ec5a7350175..57ff648931fe 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_config_env_init.md b/content/docs/cli/commands/pulumi_config_env_init.md index d54ac20970d5..647592bf2526 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_config_env_ls.md b/content/docs/cli/commands/pulumi_config_env_ls.md index edb45b6a689c..aa6e65690b96 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_config_env_rm.md b/content/docs/cli/commands/pulumi_config_env_rm.md index 2b715b2ff226..383dfb8f871d 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_config_get.md b/content/docs/cli/commands/pulumi_config_get.md index e2cede2bfcb3..7869dfca459b 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_config_refresh.md b/content/docs/cli/commands/pulumi_config_refresh.md index 6d1ce3c78ca8..e769e9e6398f 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_config_rm-all.md b/content/docs/cli/commands/pulumi_config_rm-all.md index 0fcc2f5882f6..6b576ef385d9 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_config_rm.md b/content/docs/cli/commands/pulumi_config_rm.md index f3a5da77e3f7..c7a8c418ffe7 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_config_set-all.md b/content/docs/cli/commands/pulumi_config_set-all.md index 573064f44282..346fc18548b0 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_config_set.md b/content/docs/cli/commands/pulumi_config_set.md index 645acaa8e700..d05360243fc1 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_console.md b/content/docs/cli/commands/pulumi_console.md index 2c4e0f30362a..542861ddb4a9 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_convert.md b/content/docs/cli/commands/pulumi_convert.md index 73650964a072..4feff90bef0c 100644 --- a/content/docs/cli/commands/pulumi_convert.md +++ b/content/docs/cli/commands/pulumi_convert.md @@ -58,4 +58,4 @@ pulumi convert [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_destroy.md b/content/docs/cli/commands/pulumi_destroy.md index 71ddfa2f7f9b..5414a5081a52 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_env.md b/content/docs/cli/commands/pulumi_env.md index 93a7ce0864e0..fc9a0dc95a9a 100644 --- a/content/docs/cli/commands/pulumi_env.md +++ b/content/docs/cli/commands/pulumi_env.md @@ -60,4 +60,4 @@ For more information, please visit the project page: https://www.pulumi.com/docs * [pulumi env run](/docs/cli/commands/pulumi_env_run/) - Open the environment with the given name and run a command. * [pulumi env set](/docs/cli/commands/pulumi_env_set/) - Set a value within an environment. -###### Auto generated by spf13/cobra on 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_env_edit.md b/content/docs/cli/commands/pulumi_env_edit.md index f638057c0320..5c48090f57a1 100644 --- a/content/docs/cli/commands/pulumi_env_edit.md +++ b/content/docs/cli/commands/pulumi_env_edit.md @@ -54,4 +54,4 @@ pulumi env edit [/] [flags] * [pulumi env](/docs/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_env_get.md b/content/docs/cli/commands/pulumi_env_get.md index b801dbb91ad6..438bb0012c09 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_env_init.md b/content/docs/cli/commands/pulumi_env_init.md index 2eb2f627c652..b184ded0a810 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_env_ls.md b/content/docs/cli/commands/pulumi_env_ls.md index 71525e86b52a..a094cd4eeb47 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_env_open.md b/content/docs/cli/commands/pulumi_env_open.md index b1c253f376f8..b02c331efe6b 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] [flags] * [pulumi env](/docs/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_env_rm.md b/content/docs/cli/commands/pulumi_env_rm.md index 007b42345641..7b832539a201 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_env_run.md b/content/docs/cli/commands/pulumi_env_run.md index 0aa34a05c15a..e6a5c7663adb 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_env_set.md b/content/docs/cli/commands/pulumi_env_set.md index b44fa39c0577..707ef5e4ac05 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_gen-completion.md b/content/docs/cli/commands/pulumi_gen-completion.md index 60259ae9710b..f2cb5002769c 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_import.md b/content/docs/cli/commands/pulumi_import.md index 82863cd40b36..8924000bd5dd 100644 --- a/content/docs/cli/commands/pulumi_import.md +++ b/content/docs/cli/commands/pulumi_import.md @@ -149,4 +149,4 @@ pulumi import [type] [name] [id] [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_install.md b/content/docs/cli/commands/pulumi_install.md index b91f74f2eb58..be6ab5d15426 100644 --- a/content/docs/cli/commands/pulumi_install.md +++ b/content/docs/cli/commands/pulumi_install.md @@ -48,4 +48,4 @@ pulumi install [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_login.md b/content/docs/cli/commands/pulumi_login.md index f32cf0f9116b..c00e549917f0 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_logout.md b/content/docs/cli/commands/pulumi_logout.md index b4091bf2a6d9..7baecd7dc32a 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_logs.md b/content/docs/cli/commands/pulumi_logs.md index 42d1ca9bb61b..a5f9f80e3987 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_new.md b/content/docs/cli/commands/pulumi_new.md index cf4bb9ee204e..2ac87c9c1c5f 100644 --- a/content/docs/cli/commands/pulumi_new.md +++ b/content/docs/cli/commands/pulumi_new.md @@ -101,4 +101,4 @@ pulumi new [template|url] [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_org.md b/content/docs/cli/commands/pulumi_org.md index 4f41a7b2744e..95efb40421b8 100644 --- a/content/docs/cli/commands/pulumi_org.md +++ b/content/docs/cli/commands/pulumi_org.md @@ -46,6 +46,6 @@ pulumi org [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line * [pulumi org get-default](/docs/cli/commands/pulumi_org_get-default/) - Get the default org for the current backend * [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 default organization for the current backend +* [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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_org_get-default.md b/content/docs/cli/commands/pulumi_org_get-default.md index 32d956ada47f..b8f15ddcd95d 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_org_search.md b/content/docs/cli/commands/pulumi_org_search.md index 02f1af4e342b..1e4613e9572f 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 e57a915624a0..23933eeeb762 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 2a50baae6c66..6d47cbb71f3a 100644 --- a/content/docs/cli/commands/pulumi_org_set-default.md +++ b/content/docs/cli/commands/pulumi_org_set-default.md @@ -6,13 +6,13 @@ aliases: -Set the default organization for the current backend +Set the local default organization for the current backend ## Synopsis -Set the default organization for the current backend. +Set the local default organization for the current backend. -This command is used to set the default organization in which to create +This command is used to set your local default organization in which to create projects and stacks for the current backend. Currently, only the managed and self-hosted backends support organizations. If you try and set a default organization for a backend that does not @@ -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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_package.md b/content/docs/cli/commands/pulumi_package.md index d4eec8625e82..975d747050f5 100644 --- a/content/docs/cli/commands/pulumi_package.md +++ b/content/docs/cli/commands/pulumi_package.md @@ -44,4 +44,4 @@ Subcommands of this command are useful to package authors during development. * [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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_package_gen-sdk.md b/content/docs/cli/commands/pulumi_package_gen-sdk.md index 255033f0feff..f66de9a94b45 100644 --- a/content/docs/cli/commands/pulumi_package_gen-sdk.md +++ b/content/docs/cli/commands/pulumi_package_gen-sdk.md @@ -12,10 +12,11 @@ Generate SDK(s) from a package or schema Generate SDK(s) from a package or schema. - can be a package name, the path to a plugin binary, or the path to a schema file. + can be a package name or the path to a plugin binary or folder. +If a folder either the plugin binary must match the folder name (e.g. 'aws' and 'pulumi-resource-aws') or it must have a PulumiPlugin.yaml file specifying the runtime to use. ``` -pulumi package gen-sdk [flags] +pulumi package gen-sdk [provider parameters] [flags] ``` ## Options @@ -48,4 +49,4 @@ pulumi package gen-sdk [flags] * [pulumi package](/docs/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_package_get-mapping.md b/content/docs/cli/commands/pulumi_package_get-mapping.md index 6616731d5aae..d63f48717497 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_package_get-schema.md b/content/docs/cli/commands/pulumi_package_get-schema.md index 7ab72a2373e7..7f5ac3f74822 100644 --- a/content/docs/cli/commands/pulumi_package_get-schema.md +++ b/content/docs/cli/commands/pulumi_package_get-schema.md @@ -12,10 +12,11 @@ Get the schema.json from a package Get the schema.json from a package. - can be a package name or the path to a plugin binary. + can be a package name or the path to a plugin binary or folder. +If a folder either the plugin binary must match the folder name (e.g. 'aws' and 'pulumi-resource-aws') or it must have a PulumiPlugin.yaml file specifying the runtime to use. ``` -pulumi package get-schema [flags] +pulumi package get-schema [provider parameters] [flags] ``` ## Options @@ -45,4 +46,4 @@ pulumi package get-schema [flags] * [pulumi package](/docs/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_plugin.md b/content/docs/cli/commands/pulumi_plugin.md index 5ff4cda71816..90f78a34b4aa 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_plugin_install.md b/content/docs/cli/commands/pulumi_plugin_install.md index 69ddce2d2689..ebf905b4ea25 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_plugin_ls.md b/content/docs/cli/commands/pulumi_plugin_ls.md index 59044eaa55fb..fc7449aff131 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_plugin_rm.md b/content/docs/cli/commands/pulumi_plugin_rm.md index ccc19ae7b00d..8e94fc2b1fab 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_policy.md b/content/docs/cli/commands/pulumi_policy.md index 14d62bebb6b0..48b261d44b1e 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_policy_disable.md b/content/docs/cli/commands/pulumi_policy_disable.md index aa3d576b7923..93838aeb064c 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_policy_enable.md b/content/docs/cli/commands/pulumi_policy_enable.md index 4c9d4154fc46..0c4e65b32a98 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_policy_group.md b/content/docs/cli/commands/pulumi_policy_group.md index 0a67580fc0ae..c194a060509c 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_policy_group_ls.md b/content/docs/cli/commands/pulumi_policy_group_ls.md index 9d1ad8bbc7ef..cefb14619908 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_policy_ls.md b/content/docs/cli/commands/pulumi_policy_ls.md index 4c953f708150..be6f8e4c9235 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_policy_new.md b/content/docs/cli/commands/pulumi_policy_new.md index e4925d4e0c7a..c9ee7a6b7749 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_policy_publish.md b/content/docs/cli/commands/pulumi_policy_publish.md index c5c19c6d7dcc..d456dc595264 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_policy_rm.md b/content/docs/cli/commands/pulumi_policy_rm.md index 2c4e74aa210e..909d002b93e6 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_policy_validate-config.md b/content/docs/cli/commands/pulumi_policy_validate-config.md index 4b316ce407f3..a4fa1e365720 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_preview.md b/content/docs/cli/commands/pulumi_preview.md index a774f07af6cb..9b88a9a000ce 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_refresh.md b/content/docs/cli/commands/pulumi_refresh.md index ee2610cb90f7..f678d78dc0ba 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_schema.md b/content/docs/cli/commands/pulumi_schema.md index fa200d2e4b3d..fa9aee9dd11f 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_schema_check.md b/content/docs/cli/commands/pulumi_schema_check.md index 3bf5d95f1726..746d2027fdcb 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack.md b/content/docs/cli/commands/pulumi_stack.md index 00b924944e78..66829775255a 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-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 d1603172b3bf..69c3ea2f8d7d 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_export.md b/content/docs/cli/commands/pulumi_stack_export.md index 199996686003..1b391c629e21 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_graph.md b/content/docs/cli/commands/pulumi_stack_graph.md index ed8facb0b415..e91f879de802 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_history.md b/content/docs/cli/commands/pulumi_stack_history.md index 9ccc8ce13e97..e7b8195a9dff 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_import.md b/content/docs/cli/commands/pulumi_stack_import.md index 1ce73d230eda..9de29525d359 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_init.md b/content/docs/cli/commands/pulumi_stack_init.md index 94529103a511..10975122979a 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_ls.md b/content/docs/cli/commands/pulumi_stack_ls.md index a475fcf56f4c..4ff1f7c619d5 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_output.md b/content/docs/cli/commands/pulumi_stack_output.md index 7f7cb057a0ce..3daa9d000d8e 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_rename.md b/content/docs/cli/commands/pulumi_stack_rename.md index 8ad7b5d76089..dc4f19919561 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_rm.md b/content/docs/cli/commands/pulumi_stack_rm.md index e5309e6f9f7d..bb1bf9d46cd7 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_select.md b/content/docs/cli/commands/pulumi_stack_select.md index 09b3db0c4bd0..e932be0b680d 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_tag.md b/content/docs/cli/commands/pulumi_stack_tag.md index 8f10fb35057b..a6fb7c8ccd36 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_tag_get.md b/content/docs/cli/commands/pulumi_stack_tag_get.md index 8d5ca021d2fd..ecc8b81c8a24 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_tag_ls.md b/content/docs/cli/commands/pulumi_stack_tag_ls.md index bd3a4bfe0c56..5dfdfcda8f8a 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_tag_rm.md b/content/docs/cli/commands/pulumi_stack_tag_rm.md index 3de7499e4c60..75247cc8ae28 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_tag_set.md b/content/docs/cli/commands/pulumi_stack_tag_set.md index f6d5403b91e4..9bbb5e3c1e21 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_stack_unselect.md b/content/docs/cli/commands/pulumi_stack_unselect.md index b7caf25ea267..5050506d3949 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_state.md b/content/docs/cli/commands/pulumi_state.md index 411010e631f5..e1bc3c964d82 100644 --- a/content/docs/cli/commands/pulumi_state.md +++ b/content/docs/cli/commands/pulumi_state.md @@ -46,4 +46,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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_state_delete.md b/content/docs/cli/commands/pulumi_state_delete.md index edad8512de1f..03a648e4df74 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_state_rename.md b/content/docs/cli/commands/pulumi_state_rename.md index 3cb6371f3764..2a37c4438989 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_state_unprotect.md b/content/docs/cli/commands/pulumi_state_unprotect.md index 2ca628ba8fe1..2a81fdba898e 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_state_upgrade.md b/content/docs/cli/commands/pulumi_state_upgrade.md index f7393a9fb2f2..4a6f4499fee4 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_up.md b/content/docs/cli/commands/pulumi_up.md index 4a283371e266..051c46978cdb 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_version.md b/content/docs/cli/commands/pulumi_version.md index f30812282645..455da16b9d5d 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_watch.md b/content/docs/cli/commands/pulumi_watch.md index 4740dfb1582c..45e1d26cf081 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/cli/commands/pulumi_whoami.md b/content/docs/cli/commands/pulumi_whoami.md index b923d6e46754..40cba8ab4378 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 15-May-2024 +###### Auto generated by spf13/cobra on 24-May-2024 diff --git a/content/docs/install/versions.md b/content/docs/install/versions.md index 461acc3cd565..710162e9d484 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.117.0" date="2024-05-24" showChecksum="true" >}} {{< changelog-table-row version="3.116.1" date="2024-05-15" showChecksum="true" >}} {{< changelog-table-row version="3.116.0" date="2024-05-13" showChecksum="true" >}} {{< changelog-table-row version="3.115.2" date="2024-05-06" showChecksum="true" >}} diff --git a/data/versions.json b/data/versions.json index cedd2f71de98..51b105970326 100644 --- a/data/versions.json +++ b/data/versions.json @@ -1,4 +1,17 @@ [ + { + "version": "v3.117.0", + "date": "2024-05-24T20:27:56Z", + "downloads": { + "linux-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.117.0-linux-x64.tar.gz", + "linux-arm64": "https://get.pulumi.com/releases/sdk/pulumi-v3.117.0-linux-arm64.tar.gz", + "darwin-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.117.0-darwin-x64.tar.gz", + "darwin-arm64": "https://get.pulumi.com/releases/sdk/pulumi-v3.117.0-darwin-arm64.tar.gz", + "windows-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.117.0-windows-x64.zip" + }, + "checksums": "https://get.pulumi.com/releases/sdk/pulumi-3.117.0-checksums.txt", + "latest": true + }, { "version": "v3.116.1", "date": "2024-05-15T06:07:24Z", @@ -9,8 +22,7 @@ "darwin-arm64": "https://get.pulumi.com/releases/sdk/pulumi-v3.116.1-darwin-arm64.tar.gz", "windows-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.116.1-windows-x64.zip" }, - "checksums": "https://get.pulumi.com/releases/sdk/pulumi-3.116.1-checksums.txt", - "latest": true + "checksums": "https://get.pulumi.com/releases/sdk/pulumi-3.116.1-checksums.txt" }, { "version": "v3.116.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 95375bdc993b..3b859091405b 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 @@ -1,7 +1,7 @@ ComponentResource | @pulumi/pulumi

Class ComponentResource<TData>

ComponentResource is a resource that aggregates one or more other 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 @@ -18,18 +18,18 @@
  • 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.

    -

    • Returns ComponentResource<TData>

    Properties

    Readonly urn

    urn: Output<string>

    urn is the stable logical URN used to distinctly address a resource, both before and after +

    Returns ComponentResource<TData>

    Properties

    Readonly urn

    urn: Output<string>

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

    -

    Methods

    Protected getData

    Methods

    Protected getData

    • getData(): Promise<TData>

    • Retrieves the data produces by [initialize]. The data is immediately available in a derived class's constructor after the super(...) call to ComponentResource.

      -

      Returns Promise<TData>

    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

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

      ComponentResources 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 62d9a8719b75..174c2090a0a0 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 81a66ff54cae..918a24e2d046 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 @@ -2,7 +2,7 @@ by performing external operations on some 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 @@ -18,10 +18,10 @@
  • 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.

    -

    • Returns CustomResource

    Properties

    Readonly id

    id: Output<string>

    id is the provider-assigned unique ID for this managed resource. It is set during +

    Returns CustomResource

    Properties

    Readonly id

    id: Output<string>

    id is 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>

    urn is the stable logical URN used to distinctly address a resource, both before and after +

    Readonly urn

    urn: Output<string>

    urn is 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 b6c6dd3b6645..2b01aa2d7300 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,15 +1,15 @@ 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>

    id is the provider-assigned unique ID for this managed resource. It is set during +

    Constructors

    constructor

    Properties

    Readonly id

    id: Output<string>

    id is 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>

    urn is the stable logical URN used to distinctly address a resource, both before and after +

    Readonly urn

    urn: Output<string>

    urn is 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 44cc156c3611..8b9091c53274 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,14 +1,14 @@ 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>

    id is the provider-assigned unique ID for this managed resource. It is set during +

    Constructors

    constructor

    Properties

    Readonly id

    id: Output<string>

    id is 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>

    urn is the stable logical URN used to distinctly address a resource, both before and after +

    Readonly urn

    urn: Output<string>

    urn is 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 28ec0d94c9a3..37e4d517d26b 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,6 +1,6 @@ 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 @@ -12,10 +12,10 @@
  • 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.

    -

    • Returns ProviderResource

    Properties

    Readonly id

    id: Output<string>

    id is the provider-assigned unique ID for this managed resource. It is set during +

    Returns ProviderResource

    Properties

    Readonly id

    id: Output<string>

    id is 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>

    urn is the stable logical URN used to distinctly address a resource, both before and after +

    Readonly urn

    urn: Output<string>

    urn is 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 5f9d6e28e67c..6c2572961d82 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,5 +1,5 @@ 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 @@ -14,6 +14,6 @@
  • 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.

    -

    • Returns Resource

    Properties

    Readonly urn

    urn: Output<string>

    urn is the stable logical URN used to distinctly address a resource, both before and after +

    Returns Resource

    Properties

    Readonly urn

    urn: Output<string>

    urn is 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 4a214ca38cc1..e2145b36ee7d 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 @@ -2,10 +2,10 @@ problem with a Resource. Depending on the nature of the problem, clients can choose whether or not a call stack should be returned as well. This should be very rare, and would only indicate no usefulness of presenting that stack to the user.

    -

    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

    • isInstance(obj): obj is ResourceError

    • Returns true if the given object is an instance of a ResourceError. This is designed to work even when +

    Constructors

    constructor

    Properties

    Optional hideStack

    hideStack?: boolean

    resource

    resource: undefined | Resource

    Methods

    Static isInstance

    • isInstance(obj): obj is ResourceError

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

      -

      Parameters

      • obj: any

      Returns obj is ResourceError

    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 ccf58632561e..f1555a03b527 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 @@ -2,8 +2,8 @@ than the usual verbose unhandled error logic which emits the source program text and complete stack trace. This type should be rarely used. Ideally ResourceError should always be used so that as many errors as possible can be associated with a Resource.

    -

    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 an instance of a RunError. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

      -

      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 f6208e36988c..300074901fad 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,6 +1,6 @@ StackReference | @pulumi/pulumi

    Class StackReference

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    id name outputs @@ -18,31 +18,31 @@

    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>

    id is the provider-assigned unique ID for this managed resource. It is set during +

    Returns StackReference

    Properties

    Readonly id

    id: Output<string>

    id is 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>

    urn is the stable logical URN used to distinctly address a resource, both before and after +

    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>

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

    -

    Methods

    getOutput

    Methods

    getOutput

    getOutputDetails

    Returns Output<any>

    getOutputDetails

    • getOutputDetails(name): Promise<StackReferenceOutputDetails>

    • Fetches the value of the named stack output and builds a StackReferenceOutputDetails with it.

      The returned object has its value or secretValue fields set depending on wehther the output is a secret. Neither field is set if the output was not found.

      Parameters

      • name: string

        The name of the stack output to fetch.

        -

      Returns Promise<StackReferenceOutputDetails>

    getOutputValue

    • getOutputValue(name): Promise<any>

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

    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 output was not found.

      +

    Returns Promise<any>

    getProvider

    requireOutput

    requireOutputValue

    • requireOutputValue(name): Promise<any>

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

    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

    • isInstance(obj): obj is CustomResource

    • Returns true if the given object is an instance of CustomResource. This is designed to work even when +

    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 310afab35929..0edfd40d37cc 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,6 +1,6 @@ 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

    • isInstance(obj): obj is Archive

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

      -

      Parameters

      • obj: any

      Returns obj is Archive

    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 3e021f63036c..7421b85ecc9f 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,6 +1,6 @@ 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 instance of 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 ddba23904600..b40bc1efbb3c 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,8 +1,8 @@ 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 instance of an Archive. This is designed to work even when +

    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 a8ec41019e7b..faf95c5837ac 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,9 +1,9 @@ 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 instance of an Archive. This is designed to work even when +

    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 270b8a3353cb..1b3c722fa7c7 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,8 +1,8 @@ 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 instance of an Asset. This is designed to work even when +

    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 instance of 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

    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 0c67d530e72d..aa5549aa7217 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 @@ -1,10 +1,10 @@ RemoteArchive | @pulumi/pulumi

    Class RemoteArchive

    A RemoteArchive is a file-based archive fetched from a remote location. The URI's scheme dictates the protocol for fetching the archive's contents: file:// is a local file (just like a FileArchive), http:// and https:// specify HTTP and HTTPS, respectively, and specific providers may recognize custom schemes.

    -

    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 instance of an Archive. This is designed to work even when +

    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 7e3691a420ad..657765a8b163 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 @@ -1,10 +1,10 @@ RemoteAsset | @pulumi/pulumi

    Class RemoteAsset

    RemoteAsset is a kind of asset produced from a given URI string. The URI's scheme dictates the protocol for fetching contents: file:// specifies a local file, http:// and https:// specify HTTP and HTTPS, respectively. Note that specific providers may recognize alternative schemes; this is merely the base-most set that all providers support.

    -

    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 instance of an Asset. This is designed to work even when +

    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 instance of 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

    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 807f418c7e16..a29d4bac89d6 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,8 +1,8 @@ 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 instance of an Asset. This is designed to work even when +

    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 instance of 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

    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 c304f9c3369e..0b78c3148e67 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

    CommandError is an error resulting from 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 79c499197bc1..e2e03cb3a35a 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,2 +1,2 @@ ConcurrentUpdateError | @pulumi/pulumi

    Class ConcurrentUpdateError

    ConcurrentUpdateError is thrown when attempting to update a stack that already has an update in progress.

    -

    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 3e87976e2328..460c90b1cb33 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 @@ -7,7 +7,7 @@ for Project and Stack settings. Modifying ProjectSettings will alter the Workspace Pulumi.yaml file, and setting config on a Stack will modify the Pulumi..yaml file. This is identical to the behavior of Pulumi CLI driven workspaces.

    -

    Implements

    Properties

    envVars +

    Implements

    Properties

    envVars program? pulumiHome? secretsProvider? @@ -52,160 +52,160 @@ 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 operations if any. +

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

    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

    -

    Accessors

    pulumiCommand

    pulumiVersion

    Readonly workDir

    workDir: string

    The working directory to run Pulumi CLI commands

    +

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

      +

    Returns Promise<void>

    createStack

    exportStack

    • exportStack(stackName): Promise<Deployment>

    • exportStack exports the deployment state of the stack. +

    Returns Promise<void>

    exportStack

    getAllConfig

    • getAllConfig(stackName): Promise<ConfigMap>

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

    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>

    • importStack imports the specified deployment state into a pre-existing stack. +

    Returns Promise<string>

    importStack

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

    • importStack 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, for example to use cloud providers like AWS or GCP.

      +

    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(): Promise<StackSummary[]>

    • Returns all Stacks created under the current Project. +

    Returns Promise<string[]>

    listPlugins

    listStacks

    listTags

    listTags

    postCommandCallback

    • postCommandCallback(_): Promise<void>

    • postCommandCallback is a hook executed after every command. Called with the stack name. +

    Returns Promise<TagMap>

    postCommandCallback

    • postCommandCallback(_): Promise<void>

    • postCommandCallback is 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) LocalWorkspace does not utilize this extensibility point.

      -

      Parameters

      • _: string

      Returns Promise<void>

    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 It will remove any matching values in the Pulumi..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. +

    Returns Promise<void>

    removeConfig

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

    • Removes the specified key-value pair on the provided stack name. It will remove any matching values in the Pulumi..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

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

      • kind: string = "resource"

        he kind of plugin, defaults to "resource".

        -

      Returns Promise<void>

    removeStack

    • removeStack(stackName): 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.

      +

    Returns Promise<void>

    removeTag

    saveProjectSettings

    • saveProjectSettings(settings): Promise<void>

    • Overwrites the settings object in the current project. +

    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 new project name does not match old. LocalWorkspace writes this value to a Pulumi.yaml file in Workspace.WorkDir().

      Parameters

      Returns Promise<void>

    saveStackSettings

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

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

    Returns Promise<void>

    saveStackSettings

    selectStack

    • selectStack(stackName): Promise<void>

    • Selects and sets an existing stack matching the stack name, failing if none exists.

      +

    Returns Promise<void>

    selectStack

    serializeArgsForOp

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

    • serializeArgsForOp is hook to provide additional args to every CLI commands before they are executed. +

    Returns Promise<void>

    serializeArgsForOp

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

    • serializeArgsForOp is hook to provide additional args to every CLI commands before they are executed. Provided with stack name, returns a list of args to append to an invoked command ["--config=...", ] 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..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. +

    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..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 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 name if any. +

    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

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

    • Creates or selects an existing Stack with a LocalWorkspace utilizing the specified inline (in process) Pulumi CLI program. +

    Returns Promise<LocalWorkspace>

    Static createOrSelectStack

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

    • Creates or selects an existing Stack with a LocalWorkspace utilizing the specified inline (in process) 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 directory will default to a new temporary directory provided by the OS.

      Parameters

      • args: LocalProgramArgs

        A set of arguments to initialize a Stack with a pre-configured Pulumi CLI program that already exists on disk.

      • Optional opts: LocalWorkspaceOptions

        Additional customizations to be applied to the Workspace.

        -

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

    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 directory will default to a new temporary directory provided by the OS.

    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

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

    • Creates a Stack with a LocalWorkspace utilizing the local Pulumi CLI program from the specified workDir. +

    Returns Promise<automation.Stack>

    Static createStack

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

    • Creates a Stack with a LocalWorkspace utilizing the local Pulumi CLI program from the specified workDir. This is a way to create drivers on top of pre-existing Pulumi programs. This Workspace will pick up any available Settings files (Pulumi.yaml, Pulumi..yaml).

      Parameters

      • args: LocalProgramArgs

        A set of arguments to initialize a Stack with a pre-configured Pulumi CLI program that already exists on disk.

      • Optional opts: LocalWorkspaceOptions

        Additional customizations to be applied to the Workspace.

        -

      Returns Promise<automation.Stack>

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

    • Creates a Stack with a LocalWorkspace utilizing the specified inline (in process) Pulumi program. +

    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. Similarly, unless a workDir option is specified, the working directory will default to a new temporary directory provided by the OS.

    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 selectStack

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

    • Selects a Stack with a LocalWorkspace utilizing the local Pulumi CLI program from the specified workDir. +

    Returns Promise<automation.Stack>

    Static selectStack

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

    • Selects a Stack with a LocalWorkspace utilizing the local Pulumi CLI program from the specified workDir. This is a way to create drivers on top of pre-existing Pulumi programs. This Workspace will pick up any available Settings files (Pulumi.yaml, Pulumi..yaml).

      Parameters

      • args: LocalProgramArgs

        A set of arguments to initialize a Stack with a pre-configured Pulumi CLI program that already exists on disk.

      • Optional opts: LocalWorkspaceOptions

        Additional customizations to be applied to the Workspace.

        -

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

    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. Similarly, unless a workDir option is specified, the working directory will default to a new temporary directory provided by the OS.

    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 acad223d49b0..fb1303b2f8f2 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 ef58d830a885..4267bbb9589a 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, independencly configurable instance of a Pulumi program that is operated on remotely (up/preview/refresh/destroy).

    -

    Accessors

    name +

    Accessors

    name

    Methods

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

    Accessors

    name

    Methods

    cancel

    Methods

    cancel

    • cancel(): Promise<void>

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

    • exportStack exports the deployment state of the stack. +

    Returns Promise<DestroyResult>

    exportStack

    history

    history

    importStack

    importStack

    • importStack(state): Promise<void>

    • importStack imports the specified deployment state into a pre-existing stack. This can be combined with Stack.exportStack to edit a stack's state (such as recovery from failed deployments).

      Parameters

      Returns Promise<void>

    outputs

    preview

    • preview(opts?): Promise<PreviewResult>

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

    Returns Promise<void>

    outputs

    preview

    refresh

    • refresh(opts?): Promise<RefreshResult>

    • Compares the current stack’s resource state with the state known to exist in the actual +

    Returns Promise<PreviewResult>

    refresh

    up

    • up(opts?): Promise<UpResult>

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

    Returns Promise<RefreshResult>

    up

    Settings

    Member Visibility

    Theme

    On This Page

    namecanceldestroyexportStackhistoryimportStackoutputspreviewrefreshup

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<UpResult>

    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 145a3c3d6261..6e8fff4f24ef 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,17 +1,17 @@ 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

    • createOrSelectStack(args, opts?): Promise<RemoteStack>

    • PREVIEW: Creates or selects an existing Stack backed by a RemoteWorkspace with source code from the specified Git repository. Pulumi operations on the stack (Preview, Update, Refresh, and Destroy) are performed remotely.

      Parameters

      • args: RemoteGitProgramArgs

        A set of arguments to initialize a RemoteStack with a remote Pulumi program from a Git repository.

      • Optional opts: RemoteWorkspaceOptions

        Additional customizations to be applied to the Workspace.

        -

      Returns Promise<RemoteStack>

    Static createStack

    • createStack(args, opts?): Promise<RemoteStack>

    • PREVIEW: Creates a Stack backed by a RemoteWorkspace with source code from the specified Git repository. +

    Returns Promise<RemoteStack>

    Static createStack

    Static selectStack

    • selectStack(args, opts?): Promise<RemoteStack>

    • PREVIEW: Selects an existing Stack backed by a RemoteWorkspace with source code from the specified Git +

    Returns Promise<RemoteStack>

    Static selectStack

    • selectStack(args, opts?): Promise<RemoteStack>

    • PREVIEW: Selects an existing Stack backed by a RemoteWorkspace with source code from the specified Git repository. Pulumi operations on the stack (Preview, Update, Refresh, and Destroy) are performed remotely.

      Parameters

      • args: RemoteGitProgramArgs

        A set of arguments to initialize a RemoteStack with a remote Pulumi program from a Git repository.

      • Optional opts: RemoteWorkspaceOptions

        Additional customizations to be applied to the Workspace.

        -

      Returns Promise<RemoteStack>

    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 d55e8d2d5472..723d78a2f71e 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 @@ -2,7 +2,7 @@ Stack exposes methods for the full pulumi lifecycle (up/preview/refresh/destroy), as well as managing configuration. Multiple 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 @@ -32,75 +32,75 @@ 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>

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

    Returns Promise<void>

    cancel

    • cancel(): Promise<void>

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

    • exportStack exports the deployment state of the stack. +

    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 lifecycle operations +

    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[]>

    importStack

    • importStack(state): Promise<void>

    • importStack imports the specified deployment state into a pre-existing stack. +

      Parameters

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

      Returns Promise<UpdateSummary[]>

    importStack

    • importStack(state): Promise<void>

    • importStack imports the specified deployment state into a pre-existing stack. This can be combined with Stack.exportStack to edit a stack's state (such as recovery from failed deployments).

      Parameters

      Returns Promise<void>

    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(opts?): Promise<RefreshResult>

    • Compares the current stack’s resource state with the state known to exist in the actual +

    Returns Promise<PreviewResult>

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

      +

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

      +

    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 the Workspace. +

    Returns Promise<void>

    up

    Static create

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

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

    Returns Promise<UpResult>

    Static create

    Static createOrSelect

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

    • Tries to create a new stack using the given workspace and +

    Returns Promise<automation.Stack>

    Static createOrSelect

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

    • Tries to create 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 was created from.

        -

      Returns Promise<automation.Stack>

    Static select

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

    • Selects stack using the given workspace, and stack name. +

    Returns Promise<automation.Stack>

    Static select

    Settings

    Member Visibility

    Theme

    On This Page

    nameworkspaceaddEnvironmentscanceldestroyexportStackgetAllConfiggetConfiggetTaghistoryimportStackinfolistEnvironmentslistTagsoutputspreviewrefreshrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremoveTagsetAllConfigsetConfigsetTagupcreatecreateOrSelectselect

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<automation.Stack>

    Settings

    Member Visibility

    Theme

    On This Page

    nameworkspaceaddEnvironmentscanceldestroyexportStackgetAllConfiggetConfiggetTaghistoryimportStackinfolistEnvironmentslistTagsoutputspreviewrefreshrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremoveTagsetAllConfigsetConfigsetTagupcreatecreateOrSelectselect

    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 93fbe7ca4fe5..b91d852be2cb 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

    StackAlreadyExistsError is 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 37d531c6abd5..3ec8c842317d 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

    StackNotFoundError is 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 967357ee62b6..5b838599687f 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,5 +1,5 @@ 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 @@ -12,10 +12,10 @@
  • 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>

    id is the provider-assigned unique ID for this managed resource. It is set during +

    Returns dynamic.Resource

    Properties

    Readonly id

    id: Output<string>

    id is 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>

    urn is the stable logical URN used to distinctly address a resource, both before and after +

    Readonly urn

    urn: Output<string>

    urn is 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 d8fb6fc8bf76..82d5bf292742 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,6 +1,6 @@ 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 @@ -8,19 +8,19 @@ 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>

    urn is the stable logical URN used to distinctly address a resource, both before and after +

    Constructors

    constructor

    Properties

    Readonly outputs

    outputs: Output<Inputs>

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

    +

    Readonly urn

    urn: Output<string>

    urn is 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

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

    Returns Promise<Inputs>

    Protected registerOutputs

    • registerOutputs(outputs?): void

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

      ComponentResources 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 a1330b840570..43793725c17d 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,4 +1,4 @@ -StreamInvokeResponse | @pulumi/pulumi

    Class StreamInvokeResponse<T>

    Type Parameters

    • T

    Implements

    • AsyncIterable<T>

    Constructors

    constructor +StreamInvokeResponse | @pulumi/pulumi

    Class StreamInvokeResponse<T>

    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 91042187a404..ef2ad28c82f5 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,7 +1,7 @@ -DiffKind | @pulumi/pulumi

    Enumeration DiffKind

    Enumeration Members

    add +DiffKind | @pulumi/pulumi

    Enumeration DiffKind

    Enumeration Members

    add addReplace delete deleteReplace update updateReplace -

    Enumeration Members

    add

    add: "add"

    addReplace

    addReplace: "add-replace"

    delete

    delete: "delete"

    deleteReplace

    deleteReplace: "delete-replace"

    update

    update: "update"

    updateReplace

    updateReplace: "update-replace"

    Settings

    Member Visibility

    Theme

    On This Page

    addaddReplacedeletedeleteReplaceupdateupdateReplace

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    add

    add: "add"

    addReplace

    addReplace: "add-replace"

    delete

    delete: "delete"

    deleteReplace

    deleteReplace: "delete-replace"

    update

    update: "update"

    updateReplace

    updateReplace: "update-replace"

    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 6f483646d97c..9e57b1046e5a 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 @@ -5,4 +5,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 e7d7aa2c64a8..6be53f73bf9b 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 @@ -1 +1 @@ -allAliases | @pulumi/pulumi

    Function allAliases

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function allAliases

    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 0b6abb095375..7a406be23871 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 @@ -8,4 +8,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 aee3d4d1a906..2f7e1b034a04 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 @@ -3,4 +3,4 @@ [Output]s, or just plain JavaScript values. This can be used 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 82335e4707e3..8127a6417f22 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

    • containsUnknowns 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 efcd69fd6ab3..e8c0beb7edc2 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/getOrganization.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getOrganization.html index b53e23f101f6..46d484180079 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 43a6f39de7d7..256e199f2045 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

    • getProject(): string

    • getProject returns the current project name. It throws an exception if none is registered.

      -

      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/getStack.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/getStack.html index 12dc75c0ffc2..058ce86c8232 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

    • getStack(): string

    • getStack returns the current stack name. It throws an exception if none is registered.

      -

      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/interpolate.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/interpolate.html index c44301461884..7eb1209bfd62 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. i.e. they can be [Promise]s, [Output]s, 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 e429e03b211d..7d8f766fd079 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 e1d96dd6693b..dbfa625f1d90 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 +1 @@ -isSecret | @pulumi/pulumi

    Function isSecret

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isSecret

    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 808f92192a67..2c845ac416c3 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 4ca91068c4ad..de6cc7c91004 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 @@ -7,4 +7,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 e3fcfa94a1cc..0d3ae137b192 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 @@ -6,4 +6,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 c98512e31b58..b65637b6ea74 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 2261199dbc3a..023d343b5d50 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,2 +1,2 @@ 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 b5027b03f085..40e0b1f22a52 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>

    • debug 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 4286d4a4b589..1db5605d157e 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,2 +1,2 @@ error | @pulumi/pulumi

    Function error

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

    • error 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 d834ea63d860..dd1d8479464c 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 638ade469496..5b7e26e15670 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,2 +1,2 @@ info | @pulumi/pulumi

    Function info

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

    • info logs an informational message that is generally printed to stdout 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 7d529acf1dbd..792b3d5adda2 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,2 +1,2 @@ warn | @pulumi/pulumi

    Function warn

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

    • warn 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 05878d61b82c..856b7123400c 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 @@ -12,4 +12,4 @@
  • For the purposes of merging dependsOn, provider and providers are 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 30ab0983497e..f65d303b8af8 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 2cffdb9f66f6..1b04dc94351e 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 3c094311b05a..6f1740722fbc 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;
      }

    • allConfig returns a copy of the full config 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 5540971b0c0a..16821617b0d9 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 f8326d8bd613..531d265bede7 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,2 +1,2 @@ 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 297559e92586..4299054aef58 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

    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 ff384fd2d31d..83ff83d12f06 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 @@ -13,5 +13,5 @@ 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 [CodePathOptions] instead.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    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 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 4def1bbac6fb..d8869005b942 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

    • deserializeProperties 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 ad4b95d0cfad..baee495b46e0 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,2 +1,2 @@ deserializeProperty | @pulumi/pulumi

    Function deserializeProperty

    • deserializeProperty(prop, keepUnknowns?): any

    • deserializeProperty unpacks some special types, reversing the above process.

      -

      Parameters

      • prop: any
      • Optional keepUnknowns: boolean

      Returns any

    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 6757c08e70a8..367f97f951af 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,3 +1,3 @@ disconnect | @pulumi/pulumi

    Function disconnect

    • disconnect(): Promise<void>

    • disconnect 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 a7ba80561136..da3ac73621c8 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,3 +1,3 @@ disconnectSync | @pulumi/pulumi

    Function disconnectSync

    • disconnectSync(): void

    • disconnectSync 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 bfd1468a6460..e83f3a1defe7 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 e90624309ef7..d396795abd1d 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

    • getConfig 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 425895cba117..cb704acbd15a 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,2 +1,2 @@ getEngine | @pulumi/pulumi

    Function getEngine

    • getEngine(): engrpc.IEngineClient | undefined

    • getEngine 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 5f0236ff5aa0..17807dfcdc3c 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 eb5539983924..3370d844b25b 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,2 +1,2 @@ getMonitor | @pulumi/pulumi

    Function getMonitor

    • getMonitor(): resrpc.IResourceMonitorClient | undefined

    • getMonitor 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 44cb01dfb94c..51d1dd92b194 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 571c2664cb1a..ea001de64cd0 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 de4a23cbee54..8cef9924a356 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 3eeee5234550..796771ea9e7d 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 b89640acfb9a..16b467ccb085 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 46d3ed037118..a4374e2d1fc1 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 b52126a8e626..82b3161bcf44 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 b245711b45f9..03f733249b49 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 bcf5c09727d5..6ef0486b2eb8 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 e56906c45456..b78f5d5a73b0 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 @@ -31,4 +31,4 @@

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

    -

    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.invokeSingle.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.invokeSingle.html index fbb1dfae6c40..acc16ab9e0f3 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 4b7e4c0d2c66..4a362debfd8a 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,3 +1,3 @@ isDryRun | @pulumi/pulumi

    Function isDryRun

    • isDryRun(): boolean

    • Returns whether or not 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 8496aeabfb31..d78151212e39 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,2 +1,2 @@ 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 59df417ad634..b75cc631ec66 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 adfc16655464..c33f07af9ae3 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,2 +1,2 @@ isRpcSecret | @pulumi/pulumi

    Function isRpcSecret

    • isRpcSecret(obj): boolean

    • isRpcSecret returns true if obj 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 f2e04878cd0b..e2f67e026a73 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 @@ -7,4 +7,4 @@
      • (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>>

    Example

    const buckets = pulumi.runtime.listResourceOutput(aws.s3.Bucket.isInstance);
    -

    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.mapAliasesForRequest.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.mapAliasesForRequest.html index 219ae0b528d2..6f118003b14a 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 30a9fd8e9d26..9b05e004c885 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,3 +1,3 @@ readResource | @pulumi/pulumi

    Function readResource

    • readResource(res, parent, t, name, props, opts, sourcePosition?): 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.registerResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerResource.html index 4e86aa89d28e..7670c649ba1f 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 @@ -1,4 +1,4 @@ registerResource | @pulumi/pulumi

    Function registerResource

    • registerResource(res, parent, t, name, custom, remote, newDependency, props, opts, sourcePosition?): void

    • registerResource registers a new resource object with a given type t and name. It returns the auto-generated URN and the ID that will resolve after 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 2c6edc9d56a6..b950ca6ee904 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,3 +1,3 @@ registerResourceModule | @pulumi/pulumi

    Function registerResourceModule

    • registerResourceModule(pkg, mod, module): void

    • registerResourceModule 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 fbd1271a3ba9..fc4b35cfdf00 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,2 +1,2 @@ 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 8df773609537..dbc4ccc9cd4c 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,3 +1,3 @@ registerResourcePackage | @pulumi/pulumi

    Function registerResourcePackage

    • registerResourcePackage(pkg, resourcePackage): void

    • registerResourcePackage 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.registerStackTransformation.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.registerStackTransformation.html index ad43dec620d7..c0c28386d87b 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,2 +1,2 @@ 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 c005c8da95b5..834569cabffc 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 +1 @@ -resetOptions | @pulumi/pulumi

    Function resetOptions

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

    • 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 +resetOptions | @pulumi/pulumi

    Function resetOptions

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

    • 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 7c3c0c0ceda5..3b87b386861f 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 @@ -3,4 +3,4 @@

    NOTE: it is imperative that the properties in allProps were produced by deserializeProperties in order for output properties to work correctly 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 bece1f9165fb..e0b3e016a646 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,3 +1,3 @@ rpcKeepAlive | @pulumi/pulumi

    Function rpcKeepAlive

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

    • rpcKeepAlive 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 13451dcccea0..c1d565c989a7 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,3 +1,3 @@ runInPulumiStack | @pulumi/pulumi

    Function runInPulumiStack

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

    • runInPulumiStack 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 bee7dc73bd71..912691816bd7 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 8f3d86e5b36e..8f7fecec71d6 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 @@ -13,4 +13,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 7aa0999657c3..37710c03bd60 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

    • serializeFunctionAsync(func, serialize?): Promise<string>

    • Parameters

      • func: Function
      • Optional serialize: ((o) => boolean)
          • (o): boolean

          • Parameters

            • o: any

            Returns boolean

      Returns Promise<string>

      Deprecated

      Please use 'serializeFunction' 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.serializeProperties.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.serializeProperties.html index 9487508ea599..0d244103e7d6 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

    • serializeProperties(label, props, opts?): Promise<Record<string, any>>

    • serializeProperties walks the props object passed in, awaiting all interior promises, creating a reasonable POJO object that can be remoted over to registerResource.

      -

      Parameters

      Returns Promise<Record<string, any>>

    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 b1895e875eff..ea56a5447ff5 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,3 +1,3 @@ serializeProperty | @pulumi/pulumi

    Function serializeProperty

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

    • serializeProperty 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 8eb6ba5059f9..225abce143a0 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,3 +1,3 @@ serializeResourceProperties | @pulumi/pulumi

    Function serializeResourceProperties

    • serializeResourceProperties(label, props, opts?): Promise<[Record<string, any>, Map<string, Set<Resource>>]>

    • serializeResourceProperties walks the props object passed in, awaiting all interior promises besides those for id and urn, creating a reasonable POJO object that can be remoted over to registerResource.

      -

      Parameters

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

    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 fb04f1036153..b45ef1a6bc56 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

    • setAllConfig overwrites the config 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 6cd680a1cfbd..5fe3767d12f6 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 5a715d387d8d..5ab633a52d67 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 e6241b29d2fa..08d8722a2f40 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 fc85f7565485..3d41dd3781cc 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,2 +1,2 @@ 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 f373b1579f36..819b8dd3342c 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 739426dde4f7..ba38cff774ef 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>

    • suppressUnhandledGrpcRejections 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 2f0514566847..d253d1913e24 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 51823aaa53c1..4a9a17384814 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 @@ -7,4 +7,4 @@ that will be called post-RPC call. When the 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 c10971d15cc8..09c25eceade1 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,2 +1,2 @@ unwrapRpcSecret | @pulumi/pulumi

    Function unwrapRpcSecret

    • unwrapRpcSecret(obj): any

    • unwrapRpcSecret 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/runtime.xRegisterStackTransform.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.xRegisterStackTransform.html index edbf4ac0e1ab..e7e1e715de7b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.xRegisterStackTransform.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.xRegisterStackTransform.html @@ -1,3 +1,3 @@ xRegisterStackTransform | @pulumi/pulumi

    Function xRegisterStackTransform

    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/secret.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/secret.html index 7b6ccb9a05e1..35df4b196832 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,2 +1,2 @@ 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 e25d6b74023b..6787539f6d25 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,2 +1,2 @@ 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 678c6602fb59..1242b6611781 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 @@ -12,18 +12,18 @@

    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 +

    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 pulumi.getProject().

    -

    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 the resource is used.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    nameparentprojectstacktype

    Generated using TypeDoc

    \ No newline at end of file +

    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 pulumi.getStack().

    +

    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 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 bc1a6e46a578..2a8021e3e539 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,5 +1,5 @@ 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? @@ -17,38 +17,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 package name (e.g. +

    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 89e9b2818d5a..9ef6a46400f9 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,5 +1,5 @@ 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? @@ -21,41 +21,41 @@

    Properties

    Optional additionalSecretOutputs

    additionalSecretOutputs?: string[]

    The names of outputs for this resource that should be treated as secrets. 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, deleteBeforeReplace indicates that this resource should be deleted before its replacement +

    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, deleteBeforeReplace 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, import indicates that this resource's provider should import its state from +

    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, import 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 bad00de13c87..763c6060e9da 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 5146f9928184..f9281c4d69f8 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,4 +1,4 @@ -InvokeOptions | @pulumi/pulumi

    Interface InvokeOptions

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

    Properties

    async? +InvokeOptions | @pulumi/pulumi

    Interface InvokeOptions

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

    Properties

    async? parent? pluginDownloadURL? provider? @@ -8,12 +8,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 that should be used when performing this +

    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/NumberConfigOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/NumberConfigOptions.html index 393ac497d181..31bf37f426bd 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 dd01f660f78a..b2ef8ed0d7ac 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 [Output]s.

    -
    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 404d853daaf6..f4aab6d71365 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 28450559d808..306946362b16 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,5 +1,5 @@ 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? @@ -16,34 +16,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 bc6dea3d9b40..c91c1d9b902f 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

    If the resource is a custom or 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 6cb7e3ad2c9d..4fec404f6e07 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 @@ -1,8 +1,8 @@ ResourceTransformResult | @pulumi/pulumi

    Interface ResourceTransformResult

    ResourceTransformResult is the result that must be returned by a 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 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 1310b255b80c..9724f1f53ccd 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,12 +1,12 @@ 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 5f45a38ff92a..26ee4f42b52d 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 @@ -1,8 +1,8 @@ ResourceTransformationResult | @pulumi/pulumi

    Interface ResourceTransformationResult

    ResourceTransformationResult is the result that must be returned by a 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 de33c8d62093..0fa13aad29e7 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 1baff7203c99..fc0fc2527474 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. At most one of th evalue and secretValue fields 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

    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

    Output value returned by the StackReference. +

    Optional Readonly value

    value?: any

    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 45b998941049..14fc0b8c2ef5 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 3831de5e39df..1b0707e041e1 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,5 +1,5 @@ ConfigValue | @pulumi/pulumi

    Interface ConfigValue

    ConfigValue is the input/output of a pulumi config command. It has a plaintext value, and an option boolean indicating secretness.

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

    Properties

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

    Properties

    secret? value -

    Properties

    Optional secret

    secret?: boolean

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    secretvalue

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional secret

    secret?: boolean

    value

    value: string

    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 de1acf547a54..e4fbf6de9512 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 614bc5af93fe..03ecb641e901 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;
        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;
        showSecrets?: boolean;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        targetDependents?: boolean;
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    color? continueOnError? debug? excludeProtected? @@ -19,13 +19,13 @@ tracing? userAgent?

    Properties

    Optional color

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

    Colorize output.

    -

    Optional continueOnError

    continueOnError?: boolean

    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 onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Optional showSecrets

    showSecrets?: boolean

    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[]

    Optional targetDependents

    targetDependents?: boolean

    Optional tracing

    tracing?: string

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

    -

    Optional userAgent

    userAgent?: string

    Settings

    Member Visibility

    Theme

    On This Page

    colorcontinueOnErrordebugexcludeProtectedimportFilelogFlowlogToStdErrlogVerbositymessageonEventonOutputparallelshowSecretssuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file +

    Optional continueOnError

    continueOnError?: boolean

    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 onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Optional showSecrets

    showSecrets?: boolean

    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[]

    Optional targetDependents

    targetDependents?: boolean

    Optional tracing

    tracing?: string

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

    +

    Optional userAgent

    userAgent?: string

    Settings

    Member Visibility

    Theme

    On This Page

    colorcontinueOnErrordebugexcludeProtectedimportFilelogFlowlogToStdErrlogVerbositymessageonEventonOutputparallelshowSecretssuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    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 8ab89cbe5345..1c201a61c5f6 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,5 +1,5 @@ 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

    stdout

    stdout: string

    summary

    summary: UpdateSummary

    Settings

    Member Visibility

    Theme

    On This Page

    stderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    stderr

    stderr: string

    stdout

    stdout: string

    summary

    summary: UpdateSummary

    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 5b791fff96b6..7f43cfddb57d 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,8 +1,8 @@ -DiagnosticEvent | @pulumi/pulumi

    Interface DiagnosticEvent

    interface DiagnosticEvent {
        color: string;
        ephemeral?: boolean;
        message: string;
        prefix?: string;
        severity: "info" | "info#err" | "warning" | "error";
        streamID?: number;
        urn?: string;
    }

    Properties

    color +DiagnosticEvent | @pulumi/pulumi

    Interface DiagnosticEvent

    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 be012a0ce74f..a0a851e8f638 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,4 +1,4 @@ -EngineEvent | @pulumi/pulumi

    Interface EngineEvent

    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? +EngineEvent | @pulumi/pulumi

    Interface EngineEvent

    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? @@ -9,4 +9,4 @@ stdoutEvent? summaryEvent? timestamp -

    Properties

    Optional cancelEvent

    cancelEvent?: CancelEvent

    Optional diagnosticEvent

    diagnosticEvent?: DiagnosticEvent

    Optional policyEvent

    policyEvent?: PolicyEvent

    Optional preludeEvent

    preludeEvent?: PreludeEvent

    Optional resOpFailedEvent

    resOpFailedEvent?: ResOpFailedEvent

    Optional resOutputsEvent

    resOutputsEvent?: ResOutputsEvent

    Optional resourcePreEvent

    resourcePreEvent?: ResourcePreEvent

    sequence

    sequence: number

    Optional stdoutEvent

    stdoutEvent?: StdoutEngineEvent

    Optional summaryEvent

    summaryEvent?: SummaryEvent

    timestamp

    timestamp: number

    Settings

    Member Visibility

    Theme

    On This Page

    cancelEventdiagnosticEventpolicyEventpreludeEventresOpFailedEventresOutputsEventresourcePreEventsequencestdoutEventsummaryEventtimestamp

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional cancelEvent

    cancelEvent?: CancelEvent

    Optional diagnosticEvent

    diagnosticEvent?: DiagnosticEvent

    Optional policyEvent

    policyEvent?: PolicyEvent

    Optional preludeEvent

    preludeEvent?: PreludeEvent

    Optional resOpFailedEvent

    resOpFailedEvent?: ResOpFailedEvent

    Optional resOutputsEvent

    resOutputsEvent?: ResOutputsEvent

    Optional resourcePreEvent

    resourcePreEvent?: ResourcePreEvent

    sequence

    sequence: number

    Optional stdoutEvent

    stdoutEvent?: StdoutEngineEvent

    Optional summaryEvent

    summaryEvent?: SummaryEvent

    timestamp

    timestamp: number

    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 e5fba9a36154..7f207b938718 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 file

    -

    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 file

    +

    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.InlineProgramArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.InlineProgramArgs.html index 6f82f417c711..03d1f72ea4d8 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 name of the associated project

    -

    stackName

    stackName: string

    The name of the associated Stack

    -

    Settings

    Member Visibility

    Theme

    On This Page

    programprojectNamestackName

    Generated using TypeDoc

    \ No newline at end of file +

    projectName

    projectName: string

    The name of the associated project

    +

    stackName

    stackName: string

    The name of the associated Stack

    +

    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.LocalProgramArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalProgramArgs.html index 226f6cec0ae5..1bade476167b 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,4 +1,4 @@ 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

    workDir

    workDir: string

    Settings

    Member Visibility

    Theme

    On This Page

    stackNameworkDir

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    stackName

    stackName: string

    workDir

    workDir: string

    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 3567aa8fc1b7..a7f2569ab279 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 LocalWorkspace; 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,13 +9,13 @@ 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 operations if any. +

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsprogramprojectSettingspulumiCommandpulumiHomesecretsProviderstackSettingsworkDir

    Generated using TypeDoc

    \ No newline at end of file +

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

    +

    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 bf90005fd97a..a0cf6421c195 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,3 +1,3 @@ -OutputValue | @pulumi/pulumi

    Interface OutputValue

    interface OutputValue {
        secret: boolean;
        value: any;
    }

    Properties

    secret +OutputValue | @pulumi/pulumi

    Interface OutputValue

    interface OutputValue {
        secret: boolean;
        value: any;
    }

    Properties

    secret value -

    Properties

    secret

    secret: boolean

    value

    value: any

    Settings

    Member Visibility

    Theme

    On This Page

    secretvalue

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    secret

    secret: boolean

    value

    value: any

    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 b6bd04c74632..c1e6fc441edd 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 f06b99b6bff2..1147d4656ab5 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,4 +1,4 @@ -PolicyEvent | @pulumi/pulumi

    Interface PolicyEvent

    interface PolicyEvent {
        color: string;
        enforcementLevel: "warning" | "mandatory";
        message: string;
        policyName: string;
        policyPackName: string;
        policyPackVersion: string;
        policyPackVersionTag: string;
        resourceUrn?: string;
    }

    Properties

    color +PolicyEvent | @pulumi/pulumi

    Interface PolicyEvent

    interface PolicyEvent {
        color: string;
        enforcementLevel: "warning" | "mandatory";
        message: string;
        policyName: string;
        policyPackName: string;
        policyPackVersion: string;
        policyPackVersionTag: string;
        resourceUrn?: string;
    }

    Properties

    color enforcementLevel message policyName @@ -6,4 +6,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 55584d4bf3b6..68d0e23e5b73 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,2 +1,2 @@ -PreludeEvent | @pulumi/pulumi

    Interface PreludeEvent

    interface PreludeEvent {
        config: Record<string, string>;
    }

    Properties

    config -

    Properties

    config

    config: Record<string, string>

    Settings

    Member Visibility

    Theme

    On This Page

    config

    Generated using TypeDoc

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

    Interface PreludeEvent

    interface PreludeEvent {
        config: Record<string, string>;
    }

    Properties

    config +

    Properties

    config

    config: Record<string, string>

    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 79a7ac214a58..2fbf6b4692c2 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,14 +24,14 @@ 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

    Optional expectNoChanges

    expectNoChanges?: boolean

    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 onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Optional plan

    plan?: string

    Plan specifies the path where the update plan should be saved.

    -

    Optional policyPackConfigs

    policyPackConfigs?: string[]

    Optional policyPacks

    policyPacks?: string[]

    Optional program

    program?: PulumiFn

    Optional refresh

    refresh?: boolean

    Refresh the state of the stack's resources against the cloud provider before running preview.

    -

    Optional replace

    replace?: string[]

    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[]

    Optional targetDependents

    targetDependents?: boolean

    Optional tracing

    tracing?: string

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

    -

    Optional userAgent

    userAgent?: string

    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

    Optional expectNoChanges

    expectNoChanges?: boolean

    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 onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Optional plan

    plan?: string

    Plan specifies the path where the update plan should be saved.

    +

    Optional policyPackConfigs

    policyPackConfigs?: string[]

    Optional policyPacks

    policyPacks?: string[]

    Optional program

    program?: PulumiFn

    Optional refresh

    refresh?: boolean

    Refresh the state of the stack's resources against the cloud provider before running preview.

    +

    Optional replace

    replace?: string[]

    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[]

    Optional targetDependents

    targetDependents?: boolean

    Optional tracing

    tracing?: string

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

    +

    Optional userAgent

    userAgent?: string

    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 20902fdc6040..77d3d0903982 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,5 +1,5 @@ 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

    stderr

    stderr: string

    stdout

    stdout: string

    Settings

    Member Visibility

    Theme

    On This Page

    changeSummarystderrstdout

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    changeSummary

    changeSummary: OpMap

    stderr

    stderr: string

    stdout

    stdout: string

    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 888a9589a6e6..6cc47128b479 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 5d5c066c1890..454a5ad5d266 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 d8688ba00a8c..7919de5752d1 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,5 +1,5 @@ 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? @@ -9,4 +9,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 32d1f7b80c62..df49c4287c24 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 536690ccc01f..4e66e16244a6 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 fa8ef2985709..81a0076b4aa2 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,3 +1,3 @@ -PropertyDiff | @pulumi/pulumi

    Interface PropertyDiff

    interface PropertyDiff {
        diffKind: DiffKind;
        inputDiff: boolean;
    }

    Properties

    diffKind +PropertyDiff | @pulumi/pulumi

    Interface PropertyDiff

    interface PropertyDiff {
        diffKind: DiffKind;
        inputDiff: boolean;
    }

    Properties

    diffKind inputDiff -

    Properties

    diffKind

    diffKind: DiffKind

    inputDiff

    inputDiff: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    diffKindinputDiff

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    diffKind

    diffKind: DiffKind

    inputDiff

    inputDiff: boolean

    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 8720c25e0353..3f718bbd9b47 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 00b9137564c9..831ac4ea269a 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,12 +17,12 @@ 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

    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 onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Optional showSecrets

    showSecrets?: boolean

    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[]

    Optional tracing

    tracing?: string

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

    -

    Optional userAgent

    userAgent?: string

    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

    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 onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Optional showSecrets

    showSecrets?: boolean

    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[]

    Optional tracing

    tracing?: string

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

    +

    Optional userAgent

    userAgent?: string

    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 4f1c234ef2fd..47bdf8d01f4c 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,5 +1,5 @@ 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

    stdout

    stdout: string

    summary

    summary: UpdateSummary

    Settings

    Member Visibility

    Theme

    On This Page

    stderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    stderr

    stderr: string

    stdout

    stdout: string

    summary

    summary: UpdateSummary

    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 eb202cc00bb5..bbee7b90594b 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 44865998e4f6..6947dbbe41c3 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,14 +6,14 @@
  • Basic auth username and password

    • 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 or as part of an SSH Private Key.

    -

    Optional personalAccessToken

    personalAccessToken?: string

    PersonalAccessToken is a Git personal access token in replacement of your password.

    -

    Optional sshPrivateKey

    sshPrivateKey?: string

    The (contents) private key for access to the git repo.

    -

    Optional sshPrivateKeyPath

    sshPrivateKeyPath?: string

    The absolute path to a private key for access to the git repo.

    -

    Optional username

    username?: string

    Username is the username to use when authenticating to a git repository

    -

    Settings

    Member Visibility

    Theme

    On This Page

    passwordpersonalAccessTokensshPrivateKeysshPrivateKeyPathusername

    Generated using TypeDoc

    \ No newline at end of file +

    Optional personalAccessToken

    personalAccessToken?: string

    PersonalAccessToken is a Git personal access token in replacement of your password.

    +

    Optional sshPrivateKey

    sshPrivateKey?: string

    The (contents) private key for access to the git repo.

    +

    Optional sshPrivateKeyPath

    sshPrivateKeyPath?: string

    The absolute path to a private key for access to the git repo.

    +

    Optional username

    username?: string

    Username is the username to use when authenticating to a git repository

    +

    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 4f3416802ee7..0ed78f8b7778 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

    Optional branch to checkout.

    -

    Optional commitHash

    commitHash?: string

    Optional commit to checkout.

    -

    Optional projectPath

    projectPath?: string

    Optional path relative to the repo root specifying location of the Pulumi program.

    -

    stackName

    stackName: string

    The name of the associated Stack

    -

    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

    Optional branch to checkout.

    +

    Optional commitHash

    commitHash?: string

    Optional commit to checkout.

    +

    Optional projectPath

    projectPath?: string

    Optional path relative to the repo root specifying location of the Pulumi program.

    +

    stackName

    stackName: string

    The name of the associated Stack

    +

    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 1987b7d42c71..ddf8cadad838 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 72e3731a480f..4fb30dcbfe0f 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 01e1e02f32b7..d641b031bbe3 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 9adb0b4c21fc..9c35f4a59093 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,10 +1,10 @@ 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 false.

    -

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsinheritSettingspreRunCommandsskipInstallDependencies

    Generated using TypeDoc

    \ No newline at end of file +

    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 operation is invoked.

    +

    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 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 c39aec5fb15b..82ff19e8ccd4 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,4 +1,4 @@ -ResOpFailedEvent | @pulumi/pulumi

    Interface ResOpFailedEvent

    interface ResOpFailedEvent {
        metadata: StepEventMetadata;
        status: number;
        steps: number;
    }

    Properties

    metadata +ResOpFailedEvent | @pulumi/pulumi

    Interface ResOpFailedEvent

    interface ResOpFailedEvent {
        metadata: StepEventMetadata;
        status: number;
        steps: number;
    }

    Properties

    metadata status steps -

    Properties

    metadata

    metadata: StepEventMetadata

    status

    status: number

    steps

    steps: number

    Settings

    Member Visibility

    Theme

    On This Page

    metadatastatussteps

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    metadata

    metadata: StepEventMetadata

    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 3ff7d11f959a..ae42e12521b1 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,3 +1,3 @@ -ResOutputsEvent | @pulumi/pulumi

    Interface ResOutputsEvent

    interface ResOutputsEvent {
        metadata: StepEventMetadata;
        planning?: boolean;
    }

    Properties

    metadata +ResOutputsEvent | @pulumi/pulumi

    Interface ResOutputsEvent

    interface ResOutputsEvent {
        metadata: StepEventMetadata;
        planning?: boolean;
    }

    Properties

    metadata planning? -

    Properties

    metadata

    metadata: StepEventMetadata

    Optional planning

    planning?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    metadataplanning

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    metadata

    metadata: StepEventMetadata

    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 5ef44f58038b..a75cdb05337c 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,3 +1,3 @@ -ResourcePreEvent | @pulumi/pulumi

    Interface ResourcePreEvent

    interface ResourcePreEvent {
        metadata: StepEventMetadata;
        planning?: boolean;
    }

    Properties

    metadata +ResourcePreEvent | @pulumi/pulumi

    Interface ResourcePreEvent

    interface ResourcePreEvent {
        metadata: StepEventMetadata;
        planning?: boolean;
    }

    Properties

    metadata planning? -

    Properties

    metadata

    metadata: StepEventMetadata

    Optional planning

    planning?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    metadataplanning

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    metadata

    metadata: StepEventMetadata

    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 a3a9bd931007..a24e3de9e61e 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 the 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 d17b041e3066..60aaece8ee3f 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 config 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 6bfab8516fc6..3f84b5d7ffdb 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 3206be6b58a2..0b4ed0307255 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,3 +1,3 @@ -StdoutEngineEvent | @pulumi/pulumi

    Interface StdoutEngineEvent

    interface StdoutEngineEvent {
        color: string;
        message: string;
    }

    Properties

    color +StdoutEngineEvent | @pulumi/pulumi

    Interface StdoutEngineEvent

    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 1323c5a5c3ef..9a4be1342780 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,4 +1,4 @@ -StepEventMetadata | @pulumi/pulumi

    Interface StepEventMetadata

    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? +StepEventMetadata | @pulumi/pulumi

    Interface StepEventMetadata

    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? @@ -8,4 +8,4 @@ provider type urn -

    Properties

    Optional detailedDiff

    detailedDiff?: Record<string, PropertyDiff>

    Optional diffs

    diffs?: string[]

    Optional keys

    keys?: string[]

    Optional logical

    logical?: boolean

    Optional new

    new?: StepEventStateMetadata

    Optional old

    old?: StepEventStateMetadata

    op

    op: OpType

    provider

    provider: string

    type

    type: string

    urn

    urn: string

    Settings

    Member Visibility

    Theme

    On This Page

    detailedDiffdiffskeyslogicalnewoldopprovidertypeurn

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional detailedDiff

    detailedDiff?: Record<string, PropertyDiff>

    Optional diffs

    diffs?: string[]

    Optional keys

    keys?: string[]

    Optional logical

    logical?: boolean

    Optional new

    new?: StepEventStateMetadata

    Optional old

    old?: StepEventStateMetadata

    op

    op: OpType

    provider

    provider: string

    type

    type: string

    urn

    urn: string

    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 d9505bfe22c3..131730bc2ccc 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,4 +1,4 @@ -StepEventStateMetadata | @pulumi/pulumi

    Interface StepEventStateMetadata

    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? +StepEventStateMetadata | @pulumi/pulumi

    Interface StepEventStateMetadata

    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? @@ -10,4 +10,4 @@ retainOnDelete? type urn -

    Properties

    Optional custom

    custom?: boolean

    Optional delete

    delete?: boolean

    id

    id: string

    Optional initErrors

    initErrors?: string[]

    inputs

    inputs: Record<string, any>

    outputs

    outputs: Record<string, any>

    parent

    parent: string

    Optional protect

    protect?: boolean

    provider

    provider: string

    Optional retainOnDelete

    retainOnDelete?: boolean

    type

    type: string

    urn

    urn: string

    Settings

    Member Visibility

    Theme

    On This Page

    customdeleteidinitErrorsinputsoutputsparentprotectproviderretainOnDeletetypeurn

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional custom

    custom?: boolean

    Optional delete

    delete?: boolean

    id

    id: string

    Optional initErrors

    initErrors?: string[]

    inputs

    inputs: Record<string, any>

    outputs

    outputs: Record<string, any>

    parent

    parent: string

    Optional protect

    protect?: boolean

    provider

    provider: string

    Optional retainOnDelete

    retainOnDelete?: boolean

    type

    type: string

    urn

    urn: string

    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 211a48d9b0f1..c96691267565 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,5 +1,5 @@ -SummaryEvent | @pulumi/pulumi

    Interface SummaryEvent

    interface SummaryEvent {
        durationSeconds: number;
        maybeCorrupt: boolean;
        policyPacks: Record<string, string>;
        resourceChanges: OpMap;
    }

    Properties

    durationSeconds +SummaryEvent | @pulumi/pulumi

    Interface SummaryEvent

    interface SummaryEvent {
        durationSeconds: number;
        maybeCorrupt: boolean;
        policyPacks: Record<string, string>;
        resourceChanges: OpMap;
    }

    Properties

    durationSeconds maybeCorrupt policyPacks resourceChanges -

    Properties

    durationSeconds

    durationSeconds: number

    maybeCorrupt

    maybeCorrupt: boolean

    policyPacks

    policyPacks: Record<string, string>

    resourceChanges

    resourceChanges: OpMap

    Settings

    Member Visibility

    Theme

    On This Page

    durationSecondsmaybeCorruptpolicyPacksresourceChanges

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    durationSeconds

    durationSeconds: number

    maybeCorrupt

    maybeCorrupt: boolean

    policyPacks

    policyPacks: Record<string, string>

    resourceChanges

    resourceChanges: OpMap

    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 a95914c29aaa..07f01d7a7b71 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,16 +26,16 @@ tracing? userAgent?

    Properties

    Optional color

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

    Colorize output.

    -

    Optional continueOnError

    continueOnError?: boolean

    Continue to perform the update operation despite the occurrence of errors.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations

    -

    Optional diff

    diff?: boolean

    Optional expectNoChanges

    expectNoChanges?: boolean

    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 onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Optional plan

    plan?: string

    Plan specifies the path to an update plan to use for the update.

    -

    Optional policyPackConfigs

    policyPackConfigs?: string[]

    Optional policyPacks

    policyPacks?: string[]

    Optional program

    program?: PulumiFn

    Optional refresh

    refresh?: boolean

    Refresh the state of the stack's resources before this update.

    -

    Optional replace

    replace?: string[]

    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[]

    Optional targetDependents

    targetDependents?: boolean

    Optional tracing

    tracing?: string

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

    -

    Optional userAgent

    userAgent?: string

    Settings

    Member Visibility

    Theme

    On This Page

    colorcontinueOnErrordebugdiffexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonEventonOutputparallelplanpolicyPackConfigspolicyPacksprogramrefreshreplaceshowSecretssuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file +

    Optional continueOnError

    continueOnError?: boolean

    Continue to perform the update operation despite the occurrence of errors.

    +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations

    +

    Optional diff

    diff?: boolean

    Optional expectNoChanges

    expectNoChanges?: boolean

    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 onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Optional plan

    plan?: string

    Plan specifies the path to an update plan to use for the update.

    +

    Optional policyPackConfigs

    policyPackConfigs?: string[]

    Optional policyPacks

    policyPacks?: string[]

    Optional program

    program?: PulumiFn

    Optional refresh

    refresh?: boolean

    Refresh the state of the stack's resources before this update.

    +

    Optional replace

    replace?: string[]

    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[]

    Optional targetDependents

    targetDependents?: boolean

    Optional tracing

    tracing?: string

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

    +

    Optional userAgent

    userAgent?: string

    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 a9167ad90638..9910d0b15e5c 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,6 +1,6 @@ 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

    stderr

    stderr: string

    stdout

    stdout: string

    summary

    summary: UpdateSummary

    Settings

    Member Visibility

    Theme

    On This Page

    outputsstderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    outputs

    outputs: OutputMap

    stderr

    stderr: string

    stdout

    stdout: string

    summary

    summary: UpdateSummary

    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 980c5e650953..cf5fef33b155 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,4 +1,4 @@ -UpdateSummary | @pulumi/pulumi

    Interface UpdateSummary

    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? +UpdateSummary | @pulumi/pulumi

    Interface UpdateSummary

    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 @@ -8,4 +8,4 @@ result startTime version -

    Properties

    Optional Deployment

    Deployment?: string

    config

    config: ConfigMap

    endTime

    endTime: Date

    environment

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

    Type declaration

    • [key: string]: string

    kind

    kind: UpdateKind

    message

    message: string

    Optional resourceChanges

    resourceChanges?: OpMap

    result

    result: automation.UpdateResult

    startTime

    startTime: Date

    version

    version: number

    Settings

    Member Visibility

    Theme

    On This Page

    DeploymentconfigendTimeenvironmentkindmessageresourceChangesresultstartTimeversion

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Deployment

    Deployment?: string

    config

    config: ConfigMap

    endTime

    endTime: Date

    environment

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

    Type declaration

    • [key: string]: string

    kind

    kind: UpdateKind

    message

    message: string

    Optional resourceChanges

    resourceChanges?: OpMap

    result

    result: automation.UpdateResult

    startTime

    startTime: Date

    version

    version: number

    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 c66b83ee4a52..df50320acddf 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 4717293e8614..046919df8cc8 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 @@ -1,7 +1,7 @@ Workspace | @pulumi/pulumi

    Interface WorkspaceAlpha

    Workspace is the execution context containing a single Pulumi project, a program, and multiple stacks. Workspaces are used to 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(): 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): 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(): 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): 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? @@ -42,111 +42,111 @@ stackSettings 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 operations if any. +

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

    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 secrets. +

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

      +

    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>

    • exportStack exports the deployment state of the stack. +

    Returns Promise<void>

    exportStack

    • exportStack(stackName): Promise<Deployment>

    • exportStack exports the deployment state of the stack. This can be combined with Workspace.importStack to edit a stack's state (such as recovery from failed deployments).

      Parameters

      • stackName: string

        the name of the stack.

        -

      Returns Promise<Deployment>

    getAllConfig

    • getAllConfig(stackName): Promise<ConfigMap>

    • Returns the config map for the specified stack name, scoped to the current Workspace.

      +

    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>

    • importStack imports the specified deployment state into a pre-existing stack. +

    Returns Promise<string>

    importStack

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

    • importStack 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 third party plugin.

      +

    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 like AWS or GCP.

      +

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

      +

    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(): Promise<StackSummary[]>

    • Returns all Stacks created under the current Project. +

    Returns Promise<string[]>

    listPlugins

    listStacks

    listTags

    listTags

    postCommandCallback

    • postCommandCallback(stackName): Promise<void>

    • postCommandCallback is a hook executed after every command. Called with the stack name. +

    Returns Promise<TagMap>

    postCommandCallback

    • postCommandCallback(stackName): Promise<void>

    • postCommandCallback is 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) LocalWorkspace does not utilize this extensibility point.

      -

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

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

      • Optional kind: string

        he kind of plugin e.g. "resource"

        -

      Returns Promise<void>

    removeStack

    • removeStack(stackName): Promise<void>

    • Deletes the stack and all associated configuration and history.

      +

    Returns Promise<void>

    removeStack

    • removeStack(stackName): Promise<void>

    • Deletes the stack and all associated configuration and history.

      Parameters

      • stackName: string

        The stack to remove

        -

      Returns Promise<void>

    removeTag

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

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

      +

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

    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 is new project name does not match old.

      Parameters

      Returns Promise<void>

    saveStackSettings

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

    • overwrites the settings object for the stack matching the specified stack name.

      +

    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 none exists.

      +

    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[]>

    • serializeArgsForOp is hook to provide additional args to every CLI commands before they are executed. +

    Returns Promise<void>

    serializeArgsForOp

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

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

      -

      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 name if any.

      +

    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 9163d0307ca9..2baa0346b4e0 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,6 +1,6 @@ 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 6f9c730a0665..cd974931b6ac 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 2e818edcf3f7..136377036775 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,6 +1,6 @@ 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 f176fa3b2b49..699f5b282fc5 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,11 +1,11 @@ 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 before being recreated. This is to +

    Optional Readonly deleteBeforeReplace

    deleteBeforeReplace?: boolean

    If true, and a replacement occurs, the resource will first be deleted before being recreated. This is to void potential side-by-side issues with the default create before delete behavior.

    -

    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 0ef2444055bc..741ef45d2b38 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,5 +1,5 @@ -ReadResult | @pulumi/pulumi

    Interface ReadResult<Outputs>

    interface ReadResult<Outputs> {
        id?: string;
        props?: Outputs;
    }

    Type Parameters

    • Outputs = any

    Properties

    id? +ReadResult | @pulumi/pulumi

    Interface ReadResult<Outputs>

    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 11dc2340ffe1..0a55bdb221da 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,5 +1,5 @@ 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? @@ -8,20 +8,20 @@

    Properties

    Optional check

    check?: ((olds, news) => Promise<dynamic.CheckResult<Inputs>>)

    Check validates that the given property bag is valid for a resource of the given type.

    Type declaration

    create

    create: ((inputs) => Promise<dynamic.CreateResult<Outputs>>)

    Create allocates a new instance of the provided resource and returns its unique ID afterwards. +

    Returns Promise<dynamic.CheckResult<Inputs>>

    create

    create: ((inputs) => Promise<dynamic.CreateResult<Outputs>>)

    Create allocates a new instance of the provided resource and returns its unique ID afterwards. If this call fails, the resource must not have been created (i.e., it is "transactional").

    Type declaration

    Optional delete

    delete?: ((id, props) => Promise<void>)

    Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.

    +

    Returns Promise<dynamic.CreateResult<Outputs>>

    Optional delete

    delete?: ((id, props) => Promise<void>)

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

    Diff checks what impacts a hypothetical update will have on the resource's properties.

    +

    Returns Promise<void>

    Optional diff

    diff?: ((id, olds, news) => Promise<dynamic.DiffResult>)

    Diff 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 must be included in the inputs to uniquely +

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

    Update updates an existing resource with new values.

    +

    Type declaration

    Optional update

    update?: ((id, olds, news) => Promise<dynamic.UpdateResult<Outputs>>)

    Update 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 3e2aad1f9015..f25890c69119 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,4 +1,4 @@ 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 e5de7b16a3e0..3c1917262c32 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,6 +1,6 @@ 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 b4b1b58d448a..3850f15e42bb 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,6 +1,6 @@ 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 f20c0114e751..ee485a07d623 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,6 +1,6 @@ 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 4e9a9ab41086..e1d56c62061e 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,6 +1,6 @@ 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 71e5e3f6ba36..78a536af1c51 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,11 +1,11 @@ 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 before being recreated. This is to +

    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 02ec4177a191..1c0a177aaa86 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,6 +1,6 @@ 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 3475a3b19159..972543769d78 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,5 +1,5 @@ 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? @@ -13,33 +13,33 @@

    Properties

    Optional call

    call?: ((token, inputs) => Promise<InvokeResult>)

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

    Check validates that the given property bag is valid for a resource of the given type.

    +

    Returns Promise<InvokeResult>

    Optional check

    check?: ((urn, olds, news) => Promise<provider.CheckResult>)

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

    Construct creates a new component resource.

    +

    Returns Promise<provider.CheckResult>

    Optional construct

    construct?: ((name, type, inputs, options) => Promise<ConstructResult>)

    Construct creates a new component resource.

    Type declaration

    Optional create

    create?: ((urn, inputs) => Promise<provider.CreateResult>)

    Create allocates a new instance of the provided resource and returns its unique ID afterwards. +

    Returns Promise<ConstructResult>

    Optional create

    create?: ((urn, inputs) => Promise<provider.CreateResult>)

    Create allocates a new instance of the provided resource and returns its unique ID afterwards. If this call fails, the resource must not have been created (i.e., it is "transactional").

    Type declaration

    Optional delete

    delete?: ((id, urn, props) => Promise<void>)

    Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.

    +

    Returns Promise<provider.CreateResult>

    Optional delete

    delete?: ((id, urn, props) => Promise<void>)

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

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

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

    Invoke calls the indicated function.

    +

    Returns Promise<provider.DiffResult>

    Optional invoke

    invoke?: ((token, inputs) => Promise<InvokeResult>)

    Invoke 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 must be included in the inputs to uniquely +

    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 c0b462f8b1df..98ab4b1b215c 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,7 +1,7 @@ -ReadResult | @pulumi/pulumi

    Interface ReadResult

    interface ReadResult {
        id?: string;
        inputs?: any;
        props?: any;
    }

    Properties

    id? +ReadResult | @pulumi/pulumi

    Interface ReadResult

    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 9089833f5d0a..29f0faf24054 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,4 +1,4 @@ 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 9d300846d18c..aa1cabfe0826 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 @@ 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 closure. This can be +

    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 the Assets to be +

    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 b21348b4b94b..96c806769d9b 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,8 +1,8 @@ MockCallArgs | @pulumi/pulumi

    Interface MockCallArgs

    MockResourceArgs is used to construct call Mock.

    -
    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 the call.

    -

    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 +

    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 the form "package:module:function".

    +

    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 5f28541233f4..a6469cd78ffc 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,14 +1,14 @@ MockResourceArgs | @pulumi/pulumi

    Interface MockResourceArgs

    MockResourceArgs is used to construct a newResource 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 provider? 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 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 this resource.

    -

    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 +

    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 this resource.

    +

    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 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 e791f1b1baa1..640a6d8d7df5 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 @@ -1,11 +1,11 @@ Mocks | @pulumi/pulumi

    Interface Mocks

    Mocks allows implementations to replace operations normally 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

    • newResource(args): MockResourceResult | Promise<MockResourceResult>

    • Mocks resource construction calls. This function should return the physical identifier and the output properties +

    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 d00c7786bb0d..eed078637d99 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,5 +1,5 @@ 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? @@ -11,5 +11,5 @@ stack? syncDir? testModeEnabled? -

    Properties

    Optional Readonly cacheDynamicProviders

    cacheDynamicProviders?: boolean

    Optional Readonly dryRun

    dryRun?: boolean

    Optional Readonly engineAddr

    engineAddr?: string

    Optional Readonly legacyApply

    legacyApply?: boolean

    Optional Readonly monitorAddr

    monitorAddr?: string

    Optional Readonly organization

    organization?: string

    Optional Readonly parallel

    parallel?: number

    Optional Readonly project

    project?: string

    Optional Readonly queryMode

    queryMode?: boolean

    Optional Readonly stack

    stack?: string

    Optional Readonly syncDir

    syncDir?: string

    Directory containing the send/receive files for making synchronous invokes to the engine.

    -

    Optional Readonly testModeEnabled

    testModeEnabled?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    cacheDynamicProvidersdryRunengineAddrlegacyApplymonitorAddrorganizationparallelprojectqueryModestacksyncDirtestModeEnabled

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Readonly cacheDynamicProviders

    cacheDynamicProviders?: boolean

    Optional Readonly dryRun

    dryRun?: boolean

    Optional Readonly engineAddr

    engineAddr?: string

    Optional Readonly legacyApply

    legacyApply?: boolean

    Optional Readonly monitorAddr

    monitorAddr?: string

    Optional Readonly organization

    organization?: string

    Optional Readonly parallel

    parallel?: number

    Optional Readonly project

    project?: string

    Optional Readonly queryMode

    queryMode?: boolean

    Optional Readonly stack

    stack?: string

    Optional Readonly syncDir

    syncDir?: string

    Directory containing the send/receive files for making synchronous invokes to the engine.

    +

    Optional Readonly testModeEnabled

    testModeEnabled?: boolean

    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 735e69976a7e..96ea91194003 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,4 +1,4 @@ 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 3f1efce36da3..b76a4e2b1314 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,4 +1,4 @@ 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 44d5b85ae2fa..dfc91845f411 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 08fad8cefd2d..b5f5939a3d79 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,5 +1,5 @@ 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? @@ -8,14 +8,14 @@ code will handle this and propoerly wrap the resulting text in a Secret before passing it into any Resources or serializing it to any other output format. If set, the 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. Defaults to 'handler'.

    -

    Optional isFactoryFunction

    isFactoryFunction?: boolean

    If this is a function which, when invoked, will produce the actual entrypoint function. +

    Optional exportName

    exportName?: string

    The name to export from the module defined by the generated module text. Defaults to 'handler'.

    +

    Optional isFactoryFunction

    isFactoryFunction?: boolean

    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 only wants to be 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 the serialization. Primarily used to +

    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 c2743003e27f..acfc940a7c23 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,10 +1,10 @@ SerializedFunction | @pulumi/pulumi

    Interface SerializedFunction

    SerializeFunction 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 serialization of secret

    -

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

    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 61827c3937da..cbd9b1d7b9fa 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 167f215698d9..3aa4d6238cfa 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 3614166de407..db5aa7c09008 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 215c36b78d40..f55da7bc9dd5 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 770931964e41..08880bcf1f07 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 9562fbe9b0ae..3769af103eec 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 06223c79bda6..70127cafd500 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 25e2443485c5..ad5d6f898a96 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 714bbe02c006..171322bdff69 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 b049c63a83cf..19a72dba91c0 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 3bb1d3847fd1..2db3b5639c9c 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,3 +1,3 @@ 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 9c3c6231ce0f..a0cb2eb38433 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,2 +1,2 @@ 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/Lifted.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Lifted.html index bf5bc3d96797..23c0b734469f 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 @@ -17,4 +17,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 3ce2bb5d6c1e..2cc984c723a7 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 74211b4e949f..b4d1e9ee397d 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]: 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 b6b18fc2ceab..e3254e51d2fb 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 @@ -23,4 +23,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 e6b765690ef2..adde594a08ac 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 @@ -4,4 +4,4 @@ actually being created. The effect will be as though those props and opts were passed in 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 b4af17008383..c1a743f89689 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 @@ -4,4 +4,4 @@ actually being created. The effect will be as though those props 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 62698756e5eb..66f0dd48f5d5 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 2e7d47334aeb..f3e14d687781 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 @@ 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 201414270645..68e36ff98cb6 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 adccd8d5c91e..2f35f01cc1a7 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 cd20af9bfb61..46e9e36e4751 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 ecd2bbaceb53..a19720597a9b 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;
    }

    AssetMap is 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 8700b98f2215..0cf57a990e08 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 +1 @@ -CancelEvent | @pulumi/pulumi

    Type alias CancelEvent

    CancelEvent: {}

    Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

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

      Type alias CancelEvent

      CancelEvent: {}

      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 6e277baa64ff..0a990f1b0461 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;
        }

        ConfigMap is a map of string to ConfigValue

        -

        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 9b3d565bf6ae..3e1ca01f7fdb 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 0c5451a6b93f..6625a218f6d8 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 46942f4293ab..51cea2557592 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 +1 @@ -OutputMap | @pulumi/pulumi

        Type alias OutputMap

        OutputMap: {
            [key: string]: OutputValue;
        }

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Type alias OutputMap

        OutputMap: {
            [key: string]: OutputValue;
        }

        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 aa025fdb1ae1..e52f1c1bdd50 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 c8d35bec88bf..c705cf237dd9 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 f7451b0a1e81..3eccb2be702f 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 f60e458b2faf..768e395bd67b 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 9553669f3224..a644b600bf56 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

        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 ca6974cc4b08..34165bd8181e 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,2 +1,2 @@ TagMap | @pulumi/pulumi

        Type alias TagMap

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

        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 0bfbe0e67357..bd3c96e1557c 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 9c2db192432d..fa95bfc5cde1 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 43dfb8a1bcae..9fa005ac0b34 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 599e9949a866..181169bb227b 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,3 +1,3 @@ MockResourceResult | @pulumi/pulumi

        Type alias MockResourceResult

        MockResourceResult: {
            id: string | undefined;
            state: Record<string, any>;
        }

        MockResourceResult is the result of a newResource 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 fe0f29edb4a4..3b25bfb89a04 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 13de66f6cfc0..ef896f3ab843 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 06badf58082c..0a9d8ac0e02c 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 @@ -7,4 +7,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 7d2e295b5d7e..60aafb0fb1f1 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,2 +1,2 @@ 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 c0d5d896f499..62be8e7a172f 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"

        rootPulumiStackTypeName is 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 7774cc5b03aa..c32e065bb768 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,2 +1,2 @@ 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 cfb9fc063bbe..2e0a86cacfe6 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,2 +1,2 @@ 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 e368c83732ca..e83e16216b5c 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,3 +1,3 @@ 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 f35294f3cf8d..42337ef78ed4 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,3 +1,3 @@ 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 677c3fddc85b..0790fbf75ce3 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,3 +1,3 @@ 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 eb2b658eaa8d..83cb7d071fb9 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,2 +1,2 @@ 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 bf4bed9e486b..d8d771122540 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 29da45749e60..3c7c4c8901a3 100644 --- a/static-prebuilt/docs/reference/pkg/python/pulumi/index.html +++ b/static-prebuilt/docs/reference/pkg/python/pulumi/index.html @@ -1260,13 +1260,13 @@ dependency graph’ to be created, which properly tracks the relationship between resources.

        -static all(*args: Output[T_co]) → Output[List[T_co]]
        +static all(*args: Output[Any]) → Output[List[Any]]
        -static all(**kwargs: Output[T_co]) → Output[Dict[str, T_co]]
        +static all(**kwargs: Output[Any]) → Output[Dict[str, Any]]
        -static all(*args: T_co | Awaitable[T_co] | Output[T]) → Output[List[T_co]]
        +static all(*args: Any | Awaitable[Any] | Output[T]) → Output[List[Any]]
        -static all(**kwargs: T_co | Awaitable[T_co] | Output[T]) → Output[Dict[str, T_co]]
        +static all(**kwargs: Any | Awaitable[Any] | Output[T]) → Output[Dict[str, Any]]

        Produces an Output of a list (if args i.e a list of inputs are supplied) or dict (if kwargs i.e. keyworded arguments are supplied).

        This function can be used to combine multiple, separate Inputs into a single @@ -1361,20 +1361,20 @@

        -static from_input(val: Output[T_co]) → Output[T_co]
        +static from_input(val: Output[U]) → Output[U]
        -static from_input(val: T_co | Awaitable[T_co] | Output[T]) → Output[T_co]
        +static from_input(val: U | Awaitable[U] | Output[T]) → Output[U]

        Takes an Input value and produces an Output value from it, deeply unwrapping nested Input values through nested lists, dicts, and input classes. Nested objects of other types (including Resources) are not deeply unwrapped.

        Parameters:
        -

        val (Input[T_co]) – An Input to be converted to an Output.

        +

        val (Input[U]) – An Input to be converted to an Output.

        Returns:

        A deeply-unwrapped Output that is guaranteed to not contain any Input values.

        Return type:
        -

        Output[T_co]

        +

        Output[U]

        @@ -1395,7 +1395,7 @@
        -static secret(val: T | Awaitable[T] | Output[T]) → Output[T]
        +static secret(val: U | Awaitable[U] | Output[T]) → Output[U]

        Takes an Input value and produces an Output value from it, deeply unwrapping nested Input values as necessary given the type. It also marks the returned Output as a secret, so its contents will be persisted in an encrypted form in state files.

        @@ -1414,7 +1414,7 @@
        -static unsecret(val: Output[T]) → Output[T]
        +static unsecret(val: Output[U]) → Output[U]

        Takes an existing Output, deeply unwraps the nested values and returns a new Output without any secrets included

        Parameters:
        diff --git a/static/latest-version b/static/latest-version index 56cbeb4812b6..b3afb75114a6 100644 --- a/static/latest-version +++ b/static/latest-version @@ -1 +1 @@ -3.116.1 \ No newline at end of file +3.117.0 \ No newline at end of file