From 655a42c6ff07df354dd2dffc3f09628a92745b36 Mon Sep 17 00:00:00 2001 From: pulumi-bot Date: Tue, 19 Sep 2023 23:11:09 +0000 Subject: [PATCH] Regenerating docs for Pulumi@3.84.0 --- content/docs/cli/commands/pulumi.md | 2 +- content/docs/cli/commands/pulumi_about.md | 2 +- content/docs/cli/commands/pulumi_cancel.md | 2 +- content/docs/cli/commands/pulumi_config.md | 2 +- content/docs/cli/commands/pulumi_config_cp.md | 2 +- .../docs/cli/commands/pulumi_config_get.md | 2 +- .../cli/commands/pulumi_config_refresh.md | 2 +- .../docs/cli/commands/pulumi_config_rm-all.md | 2 +- content/docs/cli/commands/pulumi_config_rm.md | 2 +- .../cli/commands/pulumi_config_set-all.md | 2 +- .../docs/cli/commands/pulumi_config_set.md | 2 +- content/docs/cli/commands/pulumi_console.md | 2 +- content/docs/cli/commands/pulumi_convert.md | 2 +- content/docs/cli/commands/pulumi_destroy.md | 2 +- .../cli/commands/pulumi_gen-completion.md | 2 +- content/docs/cli/commands/pulumi_import.md | 2 +- content/docs/cli/commands/pulumi_login.md | 2 +- content/docs/cli/commands/pulumi_logout.md | 2 +- content/docs/cli/commands/pulumi_logs.md | 2 +- content/docs/cli/commands/pulumi_new.md | 2 +- content/docs/cli/commands/pulumi_org.md | 2 +- .../cli/commands/pulumi_org_get-default.md | 2 +- .../docs/cli/commands/pulumi_org_search.md | Bin 2533 -> 2533 bytes .../docs/cli/commands/pulumi_org_search_ai.md | Bin 2033 -> 2033 bytes .../cli/commands/pulumi_org_set-default.md | 2 +- content/docs/cli/commands/pulumi_package.md | 2 +- .../cli/commands/pulumi_package_gen-sdk.md | 2 +- .../commands/pulumi_package_get-mapping.md | 2 +- .../cli/commands/pulumi_package_get-schema.md | 2 +- content/docs/cli/commands/pulumi_plugin.md | 2 +- .../cli/commands/pulumi_plugin_install.md | 2 +- content/docs/cli/commands/pulumi_plugin_ls.md | 2 +- content/docs/cli/commands/pulumi_plugin_rm.md | 2 +- content/docs/cli/commands/pulumi_policy.md | 2 +- .../cli/commands/pulumi_policy_disable.md | 2 +- .../docs/cli/commands/pulumi_policy_enable.md | 2 +- .../docs/cli/commands/pulumi_policy_group.md | 2 +- .../cli/commands/pulumi_policy_group_ls.md | 2 +- content/docs/cli/commands/pulumi_policy_ls.md | 2 +- .../docs/cli/commands/pulumi_policy_new.md | 2 +- .../cli/commands/pulumi_policy_publish.md | 2 +- content/docs/cli/commands/pulumi_policy_rm.md | 2 +- .../commands/pulumi_policy_validate-config.md | 2 +- content/docs/cli/commands/pulumi_preview.md | 2 +- content/docs/cli/commands/pulumi_refresh.md | 2 +- content/docs/cli/commands/pulumi_schema.md | 2 +- .../docs/cli/commands/pulumi_schema_check.md | 2 +- content/docs/cli/commands/pulumi_stack.md | 2 +- .../pulumi_stack_change-secrets-provider.md | 2 +- .../docs/cli/commands/pulumi_stack_export.md | 2 +- .../docs/cli/commands/pulumi_stack_graph.md | 2 +- .../docs/cli/commands/pulumi_stack_history.md | 2 +- .../docs/cli/commands/pulumi_stack_import.md | 2 +- .../docs/cli/commands/pulumi_stack_init.md | 2 +- content/docs/cli/commands/pulumi_stack_ls.md | 2 +- .../docs/cli/commands/pulumi_stack_output.md | 2 +- .../docs/cli/commands/pulumi_stack_rename.md | 2 +- content/docs/cli/commands/pulumi_stack_rm.md | 2 +- .../docs/cli/commands/pulumi_stack_select.md | 2 +- content/docs/cli/commands/pulumi_stack_tag.md | 2 +- .../docs/cli/commands/pulumi_stack_tag_get.md | 2 +- .../docs/cli/commands/pulumi_stack_tag_ls.md | 2 +- .../docs/cli/commands/pulumi_stack_tag_rm.md | 2 +- .../docs/cli/commands/pulumi_stack_tag_set.md | 2 +- .../cli/commands/pulumi_stack_unselect.md | 2 +- content/docs/cli/commands/pulumi_state.md | 2 +- .../docs/cli/commands/pulumi_state_delete.md | 2 +- .../docs/cli/commands/pulumi_state_rename.md | 2 +- .../cli/commands/pulumi_state_unprotect.md | 2 +- .../docs/cli/commands/pulumi_state_upgrade.md | 2 +- content/docs/cli/commands/pulumi_up.md | 2 +- content/docs/cli/commands/pulumi_version.md | 2 +- content/docs/cli/commands/pulumi_watch.md | 2 +- content/docs/cli/commands/pulumi_whoami.md | 2 +- content/docs/install/versions.md | 1 + .../pkg/nodejs/pulumi/pulumi/_index.md | 434 +++++------ .../pkg/nodejs/pulumi/pulumi/asset/_index.md | 60 +- .../nodejs/pulumi/pulumi/automation/_index.md | 696 +++++++++--------- .../nodejs/pulumi/pulumi/dynamic/_index.md | 66 +- .../nodejs/pulumi/pulumi/iterable/_index.md | 6 +- .../pkg/nodejs/pulumi/pulumi/log/_index.md | 12 +- .../nodejs/pulumi/pulumi/provider/_index.md | 78 +- .../nodejs/pulumi/pulumi/runtime/_index.md | 260 +++---- .../pulumi/pulumi/runtime/closure/_index.md | 44 +- data/versions.json | 16 +- static/latest-version | 2 +- 86 files changed, 916 insertions(+), 903 deletions(-) diff --git a/content/docs/cli/commands/pulumi.md b/content/docs/cli/commands/pulumi.md index e0503a4a6d14..3bd3b897f93c 100644 --- a/content/docs/cli/commands/pulumi.md +++ b/content/docs/cli/commands/pulumi.md @@ -72,4 +72,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_about.md b/content/docs/cli/commands/pulumi_about.md index 0937288a94a3..cc396f6200ea 100644 --- a/content/docs/cli/commands/pulumi_about.md +++ b/content/docs/cli/commands/pulumi_about.md @@ -54,4 +54,4 @@ pulumi about [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_cancel.md b/content/docs/cli/commands/pulumi_cancel.md index 69b8b19cd014..17825680cbef 100644 --- a/content/docs/cli/commands/pulumi_cancel.md +++ b/content/docs/cli/commands/pulumi_cancel.md @@ -51,4 +51,4 @@ pulumi cancel [] [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_config.md b/content/docs/cli/commands/pulumi_config.md index 9ee76e677a2d..e9c11653fb73 100644 --- a/content/docs/cli/commands/pulumi_config.md +++ b/content/docs/cli/commands/pulumi_config.md @@ -55,4 +55,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_config_cp.md b/content/docs/cli/commands/pulumi_config_cp.md index 296c1c4a6c28..430f359664a1 100644 --- a/content/docs/cli/commands/pulumi_config_cp.md +++ b/content/docs/cli/commands/pulumi_config_cp.md @@ -47,4 +47,4 @@ pulumi config cp [key] [flags] * [pulumi config](/docs/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_config_get.md b/content/docs/cli/commands/pulumi_config_get.md index dd9c61ddd1d8..12ad65ddf3aa 100644 --- a/content/docs/cli/commands/pulumi_config_get.md +++ b/content/docs/cli/commands/pulumi_config_get.md @@ -51,4 +51,4 @@ pulumi config get [flags] * [pulumi config](/docs/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_config_refresh.md b/content/docs/cli/commands/pulumi_config_refresh.md index 887d245042e1..53430a71d9f4 100644 --- a/content/docs/cli/commands/pulumi_config_refresh.md +++ b/content/docs/cli/commands/pulumi_config_refresh.md @@ -41,4 +41,4 @@ pulumi config refresh [flags] * [pulumi config](/docs/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_config_rm-all.md b/content/docs/cli/commands/pulumi_config_rm-all.md index 37320125ee5d..a72f317fd6e1 100644 --- a/content/docs/cli/commands/pulumi_config_rm-all.md +++ b/content/docs/cli/commands/pulumi_config_rm-all.md @@ -51,4 +51,4 @@ pulumi config rm-all ... [flags] * [pulumi config](/docs/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_config_rm.md b/content/docs/cli/commands/pulumi_config_rm.md index 09303b47b1c3..da87d63d0721 100644 --- a/content/docs/cli/commands/pulumi_config_rm.md +++ b/content/docs/cli/commands/pulumi_config_rm.md @@ -50,4 +50,4 @@ pulumi config rm [flags] * [pulumi config](/docs/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_config_set-all.md b/content/docs/cli/commands/pulumi_config_set-all.md index 13c2b98665e6..b4221667c11d 100644 --- a/content/docs/cli/commands/pulumi_config_set-all.md +++ b/content/docs/cli/commands/pulumi_config_set-all.md @@ -61,4 +61,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_config_set.md b/content/docs/cli/commands/pulumi_config_set.md index 5b7a9f028da3..29b74c2758f2 100644 --- a/content/docs/cli/commands/pulumi_config_set.md +++ b/content/docs/cli/commands/pulumi_config_set.md @@ -56,4 +56,4 @@ pulumi config set [value] [flags] * [pulumi config](/docs/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_console.md b/content/docs/cli/commands/pulumi_console.md index 463c506e1a90..e82eed8e9ec1 100644 --- a/content/docs/cli/commands/pulumi_console.md +++ b/content/docs/cli/commands/pulumi_console.md @@ -39,4 +39,4 @@ pulumi console [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_convert.md b/content/docs/cli/commands/pulumi_convert.md index 00b72148928a..53a0c9c3b37f 100644 --- a/content/docs/cli/commands/pulumi_convert.md +++ b/content/docs/cli/commands/pulumi_convert.md @@ -51,4 +51,4 @@ pulumi convert [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_destroy.md b/content/docs/cli/commands/pulumi_destroy.md index e269724eae20..a2584a17edc5 100644 --- a/content/docs/cli/commands/pulumi_destroy.md +++ b/content/docs/cli/commands/pulumi_destroy.md @@ -70,4 +70,4 @@ pulumi destroy [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_gen-completion.md b/content/docs/cli/commands/pulumi_gen-completion.md index 9d1a6616d97a..6f02d3a3db01 100644 --- a/content/docs/cli/commands/pulumi_gen-completion.md +++ b/content/docs/cli/commands/pulumi_gen-completion.md @@ -38,4 +38,4 @@ pulumi gen-completion [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_import.md b/content/docs/cli/commands/pulumi_import.md index 8b8f4a6aa98c..ffcf5585f5a3 100644 --- a/content/docs/cli/commands/pulumi_import.md +++ b/content/docs/cli/commands/pulumi_import.md @@ -129,4 +129,4 @@ pulumi import [type] [name] [id] [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_login.md b/content/docs/cli/commands/pulumi_login.md index 9840ad00121b..e1d30e174c76 100644 --- a/content/docs/cli/commands/pulumi_login.md +++ b/content/docs/cli/commands/pulumi_login.md @@ -90,4 +90,4 @@ pulumi login [] [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_logout.md b/content/docs/cli/commands/pulumi_logout.md index 0e41c3b560c7..c3423199ead4 100644 --- a/content/docs/cli/commands/pulumi_logout.md +++ b/content/docs/cli/commands/pulumi_logout.md @@ -55,4 +55,4 @@ pulumi logout [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_logs.md b/content/docs/cli/commands/pulumi_logs.md index 6016216ebbb4..a96dbbb82d37 100644 --- a/content/docs/cli/commands/pulumi_logs.md +++ b/content/docs/cli/commands/pulumi_logs.md @@ -53,4 +53,4 @@ pulumi logs [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_new.md b/content/docs/cli/commands/pulumi_new.md index 0d3d079aebec..705f4bbf878e 100644 --- a/content/docs/cli/commands/pulumi_new.md +++ b/content/docs/cli/commands/pulumi_new.md @@ -92,4 +92,4 @@ pulumi new [template|url] [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_org.md b/content/docs/cli/commands/pulumi_org.md index d7b85a81310e..5c2031f70fec 100644 --- a/content/docs/cli/commands/pulumi_org.md +++ b/content/docs/cli/commands/pulumi_org.md @@ -47,4 +47,4 @@ pulumi org [flags] * [pulumi org search](/docs/cli/commands/pulumi_org_search/) - Search for resources in Pulumi Cloud * [pulumi org set-default](/docs/cli/commands/pulumi_org_set-default/) - Set the default organization for the current backend -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_org_get-default.md b/content/docs/cli/commands/pulumi_org_get-default.md index 66aad12d41a3..7e61d99e6952 100644 --- a/content/docs/cli/commands/pulumi_org_get-default.md +++ b/content/docs/cli/commands/pulumi_org_get-default.md @@ -46,4 +46,4 @@ pulumi org get-default [flags] * [pulumi org](/docs/cli/commands/pulumi_org/) - Manage Organization configuration -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_org_search.md b/content/docs/cli/commands/pulumi_org_search.md index c8032feb7da39ed33f5a1a6b1417f45e4c927bdb..f0ea721e29896e02cd3df9d0b9e1b4623eb54287 100644 GIT binary patch delta 19 acmaDV{8V_uElzGr-Qd&$T_Xb{V=e$oC [flags] * [pulumi package](/docs/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_package_get-mapping.md b/content/docs/cli/commands/pulumi_package_get-mapping.md index 97f79abffc50..869ea5d97c9a 100644 --- a/content/docs/cli/commands/pulumi_package_get-mapping.md +++ b/content/docs/cli/commands/pulumi_package_get-mapping.md @@ -45,4 +45,4 @@ pulumi package get-mapping [flags] * [pulumi package](/docs/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_package_get-schema.md b/content/docs/cli/commands/pulumi_package_get-schema.md index ec6c87271593..c47d71e18ef9 100644 --- a/content/docs/cli/commands/pulumi_package_get-schema.md +++ b/content/docs/cli/commands/pulumi_package_get-schema.md @@ -44,4 +44,4 @@ pulumi package get-schema [flags] * [pulumi package](/docs/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_plugin.md b/content/docs/cli/commands/pulumi_plugin.md index 4e24f93b1ae7..71e7c70e09f3 100644 --- a/content/docs/cli/commands/pulumi_plugin.md +++ b/content/docs/cli/commands/pulumi_plugin.md @@ -54,4 +54,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_plugin_install.md b/content/docs/cli/commands/pulumi_plugin_install.md index b55ccfbe77d8..f3954118d094 100644 --- a/content/docs/cli/commands/pulumi_plugin_install.md +++ b/content/docs/cli/commands/pulumi_plugin_install.md @@ -57,4 +57,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_plugin_ls.md b/content/docs/cli/commands/pulumi_plugin_ls.md index 81a2777a1808..093aa09a51c7 100644 --- a/content/docs/cli/commands/pulumi_plugin_ls.md +++ b/content/docs/cli/commands/pulumi_plugin_ls.md @@ -40,4 +40,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_plugin_rm.md b/content/docs/cli/commands/pulumi_plugin_rm.md index 18d7af484875..b2ed06eca8e0 100644 --- a/content/docs/cli/commands/pulumi_plugin_rm.md +++ b/content/docs/cli/commands/pulumi_plugin_rm.md @@ -53,4 +53,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_policy.md b/content/docs/cli/commands/pulumi_policy.md index 7bea3d7d8d39..fab83dcf4ab1 100644 --- a/content/docs/cli/commands/pulumi_policy.md +++ b/content/docs/cli/commands/pulumi_policy.md @@ -42,4 +42,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_policy_disable.md b/content/docs/cli/commands/pulumi_policy_disable.md index 7c84b05f6a9b..eac01ab8b105 100644 --- a/content/docs/cli/commands/pulumi_policy_disable.md +++ b/content/docs/cli/commands/pulumi_policy_disable.md @@ -44,4 +44,4 @@ pulumi policy disable / [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_policy_enable.md b/content/docs/cli/commands/pulumi_policy_enable.md index 10123ea44a08..be57f74e728c 100644 --- a/content/docs/cli/commands/pulumi_policy_enable.md +++ b/content/docs/cli/commands/pulumi_policy_enable.md @@ -44,4 +44,4 @@ pulumi policy enable / [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_policy_group.md b/content/docs/cli/commands/pulumi_policy_group.md index 6b2abea03986..5f6ee849b7f3 100644 --- a/content/docs/cli/commands/pulumi_policy_group.md +++ b/content/docs/cli/commands/pulumi_policy_group.md @@ -35,4 +35,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_policy_group_ls.md b/content/docs/cli/commands/pulumi_policy_group_ls.md index bb75b1133ba9..08b255150dd9 100644 --- a/content/docs/cli/commands/pulumi_policy_group_ls.md +++ b/content/docs/cli/commands/pulumi_policy_group_ls.md @@ -43,4 +43,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_policy_ls.md b/content/docs/cli/commands/pulumi_policy_ls.md index e7b2885bed89..a879aa170afc 100644 --- a/content/docs/cli/commands/pulumi_policy_ls.md +++ b/content/docs/cli/commands/pulumi_policy_ls.md @@ -43,4 +43,4 @@ pulumi policy ls [org-name] [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_policy_new.md b/content/docs/cli/commands/pulumi_policy_new.md index 10642f9c7ae9..b29b4641a394 100644 --- a/content/docs/cli/commands/pulumi_policy_new.md +++ b/content/docs/cli/commands/pulumi_policy_new.md @@ -53,4 +53,4 @@ pulumi policy new [template|url] [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_policy_publish.md b/content/docs/cli/commands/pulumi_policy_publish.md index 144b0a80cf23..73e2efa963fe 100644 --- a/content/docs/cli/commands/pulumi_policy_publish.md +++ b/content/docs/cli/commands/pulumi_policy_publish.md @@ -44,4 +44,4 @@ pulumi policy publish [org-name] [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_policy_rm.md b/content/docs/cli/commands/pulumi_policy_rm.md index 0e215d163535..4eb97a2320d6 100644 --- a/content/docs/cli/commands/pulumi_policy_rm.md +++ b/content/docs/cli/commands/pulumi_policy_rm.md @@ -43,4 +43,4 @@ pulumi policy rm / [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_policy_validate-config.md b/content/docs/cli/commands/pulumi_policy_validate-config.md index be6715f14768..c6defb8c46fe 100644 --- a/content/docs/cli/commands/pulumi_policy_validate-config.md +++ b/content/docs/cli/commands/pulumi_policy_validate-config.md @@ -43,4 +43,4 @@ pulumi policy validate-config / [flags] * [pulumi policy](/docs/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_preview.md b/content/docs/cli/commands/pulumi_preview.md index b374e10f9c26..4ca6177651ba 100644 --- a/content/docs/cli/commands/pulumi_preview.md +++ b/content/docs/cli/commands/pulumi_preview.md @@ -76,4 +76,4 @@ pulumi preview [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_refresh.md b/content/docs/cli/commands/pulumi_refresh.md index aa228555cfd3..4d8e05be9bba 100644 --- a/content/docs/cli/commands/pulumi_refresh.md +++ b/content/docs/cli/commands/pulumi_refresh.md @@ -68,4 +68,4 @@ pulumi refresh [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_schema.md b/content/docs/cli/commands/pulumi_schema.md index 566b89ed92ae..94a18705b6a9 100644 --- a/content/docs/cli/commands/pulumi_schema.md +++ b/content/docs/cli/commands/pulumi_schema.md @@ -42,4 +42,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_schema_check.md b/content/docs/cli/commands/pulumi_schema_check.md index 2cbd89ab1c02..7084a53277ce 100644 --- a/content/docs/cli/commands/pulumi_schema_check.md +++ b/content/docs/cli/commands/pulumi_schema_check.md @@ -46,4 +46,4 @@ pulumi schema check [flags] * [pulumi schema](/docs/cli/commands/pulumi_schema/) - Analyze package schemas -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack.md b/content/docs/cli/commands/pulumi_stack.md index 7d3d7c925b10..f986d472af6f 100644 --- a/content/docs/cli/commands/pulumi_stack.md +++ b/content/docs/cli/commands/pulumi_stack.md @@ -65,4 +65,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 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 638f3cecba06..06cd90254cc4 100644 --- a/content/docs/cli/commands/pulumi_stack_change-secrets-provider.md +++ b/content/docs/cli/commands/pulumi_stack_change-secrets-provider.md @@ -55,4 +55,4 @@ pulumi stack change-secrets-provider [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_export.md b/content/docs/cli/commands/pulumi_stack_export.md index 2744ab359a8f..ed9ff983b1a8 100644 --- a/content/docs/cli/commands/pulumi_stack_export.md +++ b/content/docs/cli/commands/pulumi_stack_export.md @@ -51,4 +51,4 @@ pulumi stack export [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_graph.md b/content/docs/cli/commands/pulumi_stack_graph.md index b7d2909ba484..2b3b9d06b925 100644 --- a/content/docs/cli/commands/pulumi_stack_graph.md +++ b/content/docs/cli/commands/pulumi_stack_graph.md @@ -52,4 +52,4 @@ pulumi stack graph [filename] [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_history.md b/content/docs/cli/commands/pulumi_stack_history.md index d70eb4d92186..2f4bc1bf2514 100644 --- a/content/docs/cli/commands/pulumi_stack_history.md +++ b/content/docs/cli/commands/pulumi_stack_history.md @@ -50,4 +50,4 @@ pulumi stack history [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_import.md b/content/docs/cli/commands/pulumi_stack_import.md index 694d4cab1c9d..e549cac441d8 100644 --- a/content/docs/cli/commands/pulumi_stack_import.md +++ b/content/docs/cli/commands/pulumi_stack_import.md @@ -50,4 +50,4 @@ pulumi stack import [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_init.md b/content/docs/cli/commands/pulumi_stack_init.md index 72e7551b14b4..1d3c315ab4b9 100644 --- a/content/docs/cli/commands/pulumi_stack_init.md +++ b/content/docs/cli/commands/pulumi_stack_init.md @@ -75,4 +75,4 @@ pulumi stack init [/] [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_ls.md b/content/docs/cli/commands/pulumi_stack_ls.md index dd71df4aafad..91f020edf423 100644 --- a/content/docs/cli/commands/pulumi_stack_ls.md +++ b/content/docs/cli/commands/pulumi_stack_ls.md @@ -56,4 +56,4 @@ pulumi stack ls [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_output.md b/content/docs/cli/commands/pulumi_stack_output.md index eb6f9a941b14..40660fcddfb9 100644 --- a/content/docs/cli/commands/pulumi_stack_output.md +++ b/content/docs/cli/commands/pulumi_stack_output.md @@ -49,4 +49,4 @@ pulumi stack output [property-name] [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_rename.md b/content/docs/cli/commands/pulumi_stack_rename.md index 2596154f7887..edb7977d2016 100644 --- a/content/docs/cli/commands/pulumi_stack_rename.md +++ b/content/docs/cli/commands/pulumi_stack_rename.md @@ -51,4 +51,4 @@ pulumi stack rename [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_rm.md b/content/docs/cli/commands/pulumi_stack_rm.md index 00079428bede..183911343543 100644 --- a/content/docs/cli/commands/pulumi_stack_rm.md +++ b/content/docs/cli/commands/pulumi_stack_rm.md @@ -51,4 +51,4 @@ pulumi stack rm [] [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_select.md b/content/docs/cli/commands/pulumi_stack_select.md index 88915a185c40..f33cbd5a2d96 100644 --- a/content/docs/cli/commands/pulumi_stack_select.md +++ b/content/docs/cli/commands/pulumi_stack_select.md @@ -52,4 +52,4 @@ pulumi stack select [] [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_tag.md b/content/docs/cli/commands/pulumi_stack_tag.md index 528f05d2b4e8..4d525df79672 100644 --- a/content/docs/cli/commands/pulumi_stack_tag.md +++ b/content/docs/cli/commands/pulumi_stack_tag.md @@ -49,4 +49,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_tag_get.md b/content/docs/cli/commands/pulumi_stack_tag_get.md index 3d7c909d052c..0300e05c5167 100644 --- a/content/docs/cli/commands/pulumi_stack_tag_get.md +++ b/content/docs/cli/commands/pulumi_stack_tag_get.md @@ -39,4 +39,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_tag_ls.md b/content/docs/cli/commands/pulumi_stack_tag_ls.md index c21dd88a3382..675f8a93342e 100644 --- a/content/docs/cli/commands/pulumi_stack_tag_ls.md +++ b/content/docs/cli/commands/pulumi_stack_tag_ls.md @@ -40,4 +40,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_tag_rm.md b/content/docs/cli/commands/pulumi_stack_tag_rm.md index 5567729735e0..6a66af29ca07 100644 --- a/content/docs/cli/commands/pulumi_stack_tag_rm.md +++ b/content/docs/cli/commands/pulumi_stack_tag_rm.md @@ -39,4 +39,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_tag_set.md b/content/docs/cli/commands/pulumi_stack_tag_set.md index cc920f375c67..86b405498c72 100644 --- a/content/docs/cli/commands/pulumi_stack_tag_set.md +++ b/content/docs/cli/commands/pulumi_stack_tag_set.md @@ -39,4 +39,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_stack_unselect.md b/content/docs/cli/commands/pulumi_stack_unselect.md index c19cf50a9ca3..f386c3379249 100644 --- a/content/docs/cli/commands/pulumi_stack_unselect.md +++ b/content/docs/cli/commands/pulumi_stack_unselect.md @@ -47,4 +47,4 @@ pulumi stack unselect [flags] * [pulumi stack](/docs/cli/commands/pulumi_stack/) - Manage stacks -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_state.md b/content/docs/cli/commands/pulumi_state.md index 7b930259a8f6..8a50d42d58ff 100644 --- a/content/docs/cli/commands/pulumi_state.md +++ b/content/docs/cli/commands/pulumi_state.md @@ -45,4 +45,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_state_delete.md b/content/docs/cli/commands/pulumi_state_delete.md index 6cd63e0899bb..74ee739a1293 100644 --- a/content/docs/cli/commands/pulumi_state_delete.md +++ b/content/docs/cli/commands/pulumi_state_delete.md @@ -63,4 +63,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_state_rename.md b/content/docs/cli/commands/pulumi_state_rename.md index b715c9888097..45b3ca395f5b 100644 --- a/content/docs/cli/commands/pulumi_state_rename.md +++ b/content/docs/cli/commands/pulumi_state_rename.md @@ -58,4 +58,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_state_unprotect.md b/content/docs/cli/commands/pulumi_state_unprotect.md index 508cc358efef..6e5b378bb3d7 100644 --- a/content/docs/cli/commands/pulumi_state_unprotect.md +++ b/content/docs/cli/commands/pulumi_state_unprotect.md @@ -49,4 +49,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_state_upgrade.md b/content/docs/cli/commands/pulumi_state_upgrade.md index c4c1afe7f0b7..2d78a1357d39 100644 --- a/content/docs/cli/commands/pulumi_state_upgrade.md +++ b/content/docs/cli/commands/pulumi_state_upgrade.md @@ -45,4 +45,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-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_up.md b/content/docs/cli/commands/pulumi_up.md index b5ae0d174282..4631ccf186ed 100644 --- a/content/docs/cli/commands/pulumi_up.md +++ b/content/docs/cli/commands/pulumi_up.md @@ -79,4 +79,4 @@ pulumi up [template|url] [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_version.md b/content/docs/cli/commands/pulumi_version.md index 1f7f59a3860e..e46a91d04be7 100644 --- a/content/docs/cli/commands/pulumi_version.md +++ b/content/docs/cli/commands/pulumi_version.md @@ -38,4 +38,4 @@ pulumi version [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_watch.md b/content/docs/cli/commands/pulumi_watch.md index 10f2e44a4464..0dbc14340b72 100644 --- a/content/docs/cli/commands/pulumi_watch.md +++ b/content/docs/cli/commands/pulumi_watch.md @@ -64,4 +64,4 @@ pulumi watch [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/cli/commands/pulumi_whoami.md b/content/docs/cli/commands/pulumi_whoami.md index fe900c67f241..75694b9e32fd 100644 --- a/content/docs/cli/commands/pulumi_whoami.md +++ b/content/docs/cli/commands/pulumi_whoami.md @@ -45,4 +45,4 @@ pulumi whoami [flags] * [pulumi](/docs/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 15-Sep-2023 +###### Auto generated by spf13/cobra on 19-Sep-2023 diff --git a/content/docs/install/versions.md b/content/docs/install/versions.md index e3b34aa13be3..23e596928766 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.84.0" date="2023-09-19" showChecksum="true" >}} {{< changelog-table-row version="3.83.0" date="2023-09-15" showChecksum="true" >}} {{< changelog-table-row version="3.82.1" date="2023-09-13" showChecksum="true" >}} {{< changelog-table-row version="3.82.0" date="2023-09-12" showChecksum="true" >}} diff --git a/content/docs/reference/pkg/nodejs/pulumi/pulumi/_index.md b/content/docs/reference/pkg/nodejs/pulumi/pulumi/_index.md index fbe576445abb..6783f0d5e1b9 100644 --- a/content/docs/reference/pkg/nodejs/pulumi/pulumi/_index.md +++ b/content/docs/reference/pkg/nodejs/pulumi/pulumi/_index.md @@ -3,7 +3,7 @@ title: "Package @pulumi/pulumi" title_tag: "Package @pulumi/pulumi | Node.js SDK" linktitle: "@pulumi/pulumi" meta_desc: "Explore members of the @pulumi/pulumi package." -git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" +git_sha: "ae0bc5013b5ecba279abc534f37a4398a859248a" --- @@ -155,7 +155,7 @@ import * as pulumi from "@pulumi/pulumi";

Resources

- + Resource ComponentResource

@@ -167,7 +167,7 @@ level abstraction. The component resource itself is a resource, but does not req operations for provisioning.

- constructor + constructor

@@ -186,7 +186,7 @@ perform resource operations. * `remote` True if this is a remote component resource.

-method getData +method getData

@@ -197,14 +197,14 @@ Retrieves the data produces by [initialize]. The data is immediately available derived class's constructor after the `super(...)` call to `ComponentResource`.

-method getProvider +method getProvider

public getProvider(moduleMember: string): ProviderResource | undefined

-method initialize +method initialize

@@ -216,7 +216,7 @@ automatically when constructed. The data will be available immediately for subc constructors to use. To access the data use `.getData`.

-method isInstance +method isInstance

@@ -227,7 +227,7 @@ Returns true if the given object is an instance of CustomResource. This is desi multiple copies of the Pulumi SDK have been loaded into the same process.

-method registerOutputs +method registerOutputs

@@ -242,7 +242,7 @@ done creating child resources. This is not strictly necessary as this will auto called after the `initialize` method completes.

-property urn +property urn

public urn: Output<URN>;
@@ -251,7 +251,7 @@ urn is the stable logical URN used to distinctly address a resource, both before deployments.

- + Resource CustomResource

@@ -264,7 +264,7 @@ and perform partial updates of them, and these CRUD operations are implemented i loaded plugin for the defining package.

- constructor + constructor

@@ -285,14 +285,14 @@ upon the diffing of the new goal state compared to the current known resource st * `dependency` True if this is a synthetic resource used internally for dependency tracking.

-method getProvider +method getProvider

public getProvider(moduleMember: string): ProviderResource | undefined

-method isInstance +method isInstance

@@ -303,7 +303,7 @@ Returns true if the given object is an instance of CustomResource. This is desi multiple copies of the Pulumi SDK have been loaded into the same process.

-property id +property id

public id: Output<ID>;
@@ -312,7 +312,7 @@ id is the provider-assigned unique ID for this managed resource. It is set duri deployments and may be missing (undefined) during planning phases.

-property urn +property urn

public urn: Output<URN>;
@@ -321,7 +321,7 @@ urn is the stable logical URN used to distinctly address a resource, both before deployments.

- + Resource DependencyProviderResource

@@ -332,21 +332,21 @@ A DependencyProviderResource is a resource that is used by the provider SDK as a is only used for its reference. Its only valid properties are its URN and ID.

- constructor + constructor

new DependencyProviderResource(ref: string)

-method getProvider +method getProvider

public getProvider(moduleMember: string): ProviderResource | undefined

-method isInstance +method isInstance

@@ -357,14 +357,14 @@ Returns true if the given object is an instance of CustomResource. This is desi multiple copies of the Pulumi SDK have been loaded into the same process.

-method register +method register

public static register(provider: ProviderResource | undefined): Promise<string | undefined>

-property id +property id

public id: Output<ID>;
@@ -373,7 +373,7 @@ id is the provider-assigned unique ID for this managed resource. It is set duri deployments and may be missing (undefined) during planning phases.

-property urn +property urn

public urn: Output<URN>;
@@ -382,7 +382,7 @@ urn is the stable logical URN used to distinctly address a resource, both before deployments.

- + Resource DependencyResource

@@ -393,21 +393,21 @@ A DependencyResource is a resource that is used to indicate that an Output has a resource. These resources are only created when dealing with remote component resources.

- constructor + constructor

new DependencyResource(urn: URN)

-method getProvider +method getProvider

public getProvider(moduleMember: string): ProviderResource | undefined

-method isInstance +method isInstance

@@ -418,7 +418,7 @@ Returns true if the given object is an instance of CustomResource. This is desi multiple copies of the Pulumi SDK have been loaded into the same process.

-property id +property id

public id: Output<ID>;
@@ -427,7 +427,7 @@ id is the provider-assigned unique ID for this managed resource. It is set duri deployments and may be missing (undefined) during planning phases.

-property urn +property urn

public urn: Output<URN>;
@@ -436,7 +436,7 @@ urn is the stable logical URN used to distinctly address a resource, both before deployments.

- + Resource ProviderResource

@@ -447,7 +447,7 @@ ProviderResource is a resource that implements CRUD operations for other custom managed similarly to other resources, including the usual diffing and update semantics.

- constructor + constructor

@@ -463,14 +463,14 @@ Creates and registers a new provider resource for a particular package. * `dependency` True if this is a synthetic resource used internally for dependency tracking.

-method getProvider +method getProvider

public getProvider(moduleMember: string): ProviderResource | undefined

-method isInstance +method isInstance

@@ -481,14 +481,14 @@ Returns true if the given object is an instance of CustomResource. This is desi multiple copies of the Pulumi SDK have been loaded into the same process.

-method register +method register

public static register(provider: ProviderResource | undefined): Promise<string | undefined>

-property id +property id

public id: Output<ID>;
@@ -497,7 +497,7 @@ id is the provider-assigned unique ID for this managed resource. It is set duri deployments and may be missing (undefined) during planning phases.

-property urn +property urn

public urn: Output<URN>;
@@ -506,7 +506,7 @@ urn is the stable logical URN used to distinctly address a resource, both before deployments.

- + Resource Resource

@@ -516,7 +516,7 @@ deployments. Resource represents a class whose CRUD operations are implemented by a provider plugin.

- constructor + constructor

@@ -537,21 +537,21 @@ the order in which we perform resource operations. * `dependency` True if this is a synthetic resource used internally for dependency tracking.

-method getProvider +method getProvider

public getProvider(moduleMember: string): ProviderResource | undefined

-method isInstance +method isInstance

public static isInstance(obj: any): obj is Resource

-property urn +property urn

public urn: Output<URN>;
@@ -560,7 +560,7 @@ urn is the stable logical URN used to distinctly address a resource, both before deployments.

- + Resource StackReference

@@ -571,7 +571,7 @@ Manages a reference to a Pulumi stack. The referenced stack's outputs are availa `outputs` property or the `output` method.

- constructor + constructor

@@ -587,7 +587,7 @@ If args is not specified, the name of the referenced stack will be the name of t * `opts` A bag of options that control this resource's behavior.

-method getOutput +method getOutput

@@ -597,7 +597,7 @@ If args is not specified, the name of the referenced stack will be the name of t Fetches the value of the named stack output, or undefined if the stack output was not found.

-method getOutputDetails +method getOutputDetails

@@ -612,7 +612,7 @@ depending on wehther the output is a secret. Neither field is set if the output was not found.

-method getOutputValue +method getOutputValue

@@ -625,14 +625,14 @@ not known for some reason. This operation is not supported (and will throw) if the named stack output is a secret.

-method getProvider +method getProvider

public getProvider(moduleMember: string): ProviderResource | undefined

-method isInstance +method isInstance

@@ -643,7 +643,7 @@ Returns true if the given object is an instance of CustomResource. This is desi multiple copies of the Pulumi SDK have been loaded into the same process.

-method requireOutput +method requireOutput

@@ -653,7 +653,7 @@ multiple copies of the Pulumi SDK have been loaded into the same process. Fetches the value of the named stack output, or throws an error if the output was not found.

-method requireOutputValue +method requireOutputValue

@@ -666,7 +666,7 @@ not found. This operation is not supported (and will throw) if the named stack output is a secret.

-property id +property id

public id: Output<ID>;
@@ -675,7 +675,7 @@ id is the provider-assigned unique ID for this managed resource. It is set duri deployments and may be missing (undefined) during planning phases.

-property name +property name

public name: Output<string>;
@@ -683,7 +683,7 @@ deployments and may be missing (undefined) during planning phases. The name of the referenced stack.

-property outputs +property outputs

public outputs: Output<{[name: string]: any}>;
@@ -691,7 +691,7 @@ The name of the referenced stack. The outputs of the referenced stack.

-property secretOutputNames +property secretOutputNames

public secretOutputNames: Output<string[]>;
@@ -699,7 +699,7 @@ The outputs of the referenced stack. The names of any stack outputs which contain secrets.

-property urn +property urn

public urn: Output<URN>;
@@ -711,7 +711,7 @@ deployments.

Others

- + interface Alias

@@ -743,7 +743,7 @@ This form is self-descriptive and makes the intent clearer than using: `aliases: [{ parent: undefined }]`

-property name +property name

name?: Input<string>;
@@ -752,7 +752,7 @@ The previous name of the resource. If not provided, the current name of the res used.

-property parent +property parent

parent?: Resource | Input<URN>;
@@ -764,7 +764,7 @@ parent). To specify no original parent, use `{ parent: pulumi.rootStackResource }`.

-property project +property project

project?: Input<string>;
@@ -772,7 +772,7 @@ To specify no original parent, use `{ parent: pulumi.rootStackResource }`. The previous project of the resource. If not provided, defaults to `pulumi.getProject()`.

-property stack +property stack

stack?: Input<string>;
@@ -780,7 +780,7 @@ The previous project of the resource. If not provided, defaults to `pulumi.getPr The previous stack of the resource. If not provided, defaults to `pulumi.getStack()`.

-property type +property type

type?: Input<string>;
@@ -788,7 +788,7 @@ The previous stack of the resource. If not provided, defaults to `pulumi.getSta The previous type of the resource. If not provided, the current type of the resource is used.

- + function all

@@ -837,7 +837,7 @@ d1 and d2.
all<T>(ds: Input<T>[]): Output<Unwrap<T>[]>

- + function allAliases

@@ -846,7 +846,7 @@ d1 and d2.
allAliases(childAliases: Input<URN | Alias>[], childName: string, childType: string, parent: Resource, parentName: string): Output<URN>[]

- + interface ComponentResourceOptions

@@ -856,7 +856,7 @@ d1 and d2. ComponentResourceOptions is a bag of optional settings that control a component resource's behavior.

-property aliases +property aliases

aliases?: Input<URN | Alias>[];
@@ -864,7 +864,7 @@ ComponentResourceOptions is a bag of optional settings that control a component An optional list of aliases to treat this resource as matching.

-property customTimeouts +property customTimeouts

customTimeouts?: CustomTimeouts;
@@ -872,7 +872,7 @@ An optional list of aliases to treat this resource as matching. An optional customTimeouts configuration block.

-property deletedWith +property deletedWith

deletedWith?: Resource;
@@ -881,7 +881,7 @@ If set, the providers Delete method will not be called for this resource if specified is being deleted as well.

-property dependsOn +property dependsOn

dependsOn?: Input<Input<Resource>[]> | Input<Resource>;
@@ -889,7 +889,7 @@ if specified is being deleted as well. An optional additional explicit dependencies on other resources.

-property id +property id

id?: Input<ID>;
@@ -897,7 +897,7 @@ An optional additional explicit dependencies on other resources. An optional existing ID to load, rather than create.

-property ignoreChanges +property ignoreChanges

ignoreChanges?: string[];
@@ -905,7 +905,7 @@ An optional existing ID to load, rather than create. Ignore changes to any of the specified properties.

-property parent +property parent

parent?: Resource;
@@ -913,7 +913,7 @@ Ignore changes to any of the specified properties. An optional parent resource to which this resource belongs.

-property pluginDownloadURL +property pluginDownloadURL

pluginDownloadURL?: undefined | string;
@@ -923,7 +923,7 @@ associated plugin. This version overrides the URL information inferred from the current package and should rarely be used.

-property protect +property protect

protect?: undefined | false | true;
@@ -931,7 +931,7 @@ from the current package and should rarely be used. When set to true, protect ensures this resource cannot be deleted.

-property provider +property provider

provider?: ProviderResource;
@@ -943,7 +943,7 @@ from the parent's provider bag (see also ComponentResourceOptions.providers). If this is a [ComponentResourceOptions] do not provide both [provider] and [providers]

-property providers +property providers

providers?: Record<string, ProviderResource> | ProviderResource[];
@@ -955,7 +955,7 @@ from the provider itself. Note: only a list should be used. Mapping keys are not respected.

-property replaceOnChanges +property replaceOnChanges

replaceOnChanges?: string[];
@@ -965,7 +965,7 @@ properties will force a replacement. Initialization errors from previous deploy instead of update only if `"*"` is passed.

-property retainOnDelete +property retainOnDelete

retainOnDelete?: undefined | false | true;
@@ -973,7 +973,7 @@ instead of update only if `"*"` is passed. If set to True, the providers Delete method will not be called for this resource.

-property transformations +property transformations

transformations?: ResourceTransformation[];
@@ -983,7 +983,7 @@ transformations are applied in order, and are applied prior to transformation ap parents walking from the resource up to the stack.

-property urn +property urn

urn?: URN;
@@ -991,7 +991,7 @@ parents walking from the resource up to the stack. The URN of a previously-registered resource of this type to read from the engine.

-property version +property version

version?: undefined | string;
@@ -1001,7 +1001,7 @@ this resource. This version overrides the version information inferred from the rarely be used.

- + function concat

@@ -1021,7 +1021,7 @@ final string. Individual inputs can be any sort of [Input] value. i.e. they ca

- + class Config

@@ -1035,14 +1035,14 @@ and `c`, is entirely separate from a bag whose name is `pulumi:bar` with the sam fully qualified names, such as `pulumi:foo:a`, ..., and `pulumi:bar:a`, respectively.

- constructor + constructor

new Config(name?: undefined | string)

-method get +method get

@@ -1052,7 +1052,7 @@ fully qualified names, such as `pulumi:foo:a`, ..., and `pulumi:bar:a`, respecti get loads an optional configuration value by its key, or undefined if it doesn't exist.

-method getBoolean +method getBoolean

@@ -1063,7 +1063,7 @@ getBoolean loads an optional configuration value, as a boolean, by its key, or u If the configuration value isn't a legal boolean, this function will throw an error.

-method getNumber +method getNumber

@@ -1074,7 +1074,7 @@ getNumber loads an optional configuration value, as a number, by its key, or und If the configuration value isn't a legal number, this function will throw an error.

-method getObject +method getObject

@@ -1085,7 +1085,7 @@ getObject loads an optional configuration value, as an object, by its key, or un This routine simply JSON parses and doesn't validate the shape of the contents.

-method getSecret +method getSecret

@@ -1096,7 +1096,7 @@ getSecret loads an optional configuration value by its key, marking it as a secr doesn't exist.

-method getSecretBoolean +method getSecretBoolean

@@ -1108,7 +1108,7 @@ or undefined if it doesn't exist. If the configuration value isn't a legal boole throw an error.

-method getSecretNumber +method getSecretNumber

@@ -1120,7 +1120,7 @@ or undefined if it doesn't exist. If the configuration value isn't a legal number, this function will throw an error.

-method getSecretObject +method getSecretObject

@@ -1132,7 +1132,7 @@ or undefined if it doesn't exist. This routine simply JSON parses and doesn't validate the shape of the contents.

-method require +method require

@@ -1142,7 +1142,7 @@ This routine simply JSON parses and doesn't validate the shape of the contents. require loads a configuration value by its given key. If it doesn't exist, an error is thrown.

-method requireBoolean +method requireBoolean

@@ -1153,7 +1153,7 @@ requireBoolean loads a configuration value, as a boolean, by its given key. If configuration value is not a legal boolean, an error is thrown.

-method requireNumber +method requireNumber

@@ -1164,7 +1164,7 @@ requireNumber loads a configuration value, as a number, by its given key. If it configuration value is not a legal number, an error is thrown.

-method requireObject +method requireObject

@@ -1175,7 +1175,7 @@ requireObject loads a configuration value as a JSON string and deserializes the it doesn't exist, or the configuration value is not a legal JSON string, an error is thrown.

-method requireSecret +method requireSecret

@@ -1186,7 +1186,7 @@ require loads a configuration value by its given key, marking it as a secret. I is thrown.

-method requireSecretBoolean +method requireSecretBoolean

@@ -1197,7 +1197,7 @@ requireSecretBoolean 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.

-method requireSecretNumber +method requireSecretNumber

@@ -1208,7 +1208,7 @@ requireSecretNumber 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.

-method requireSecretObject +method requireSecretObject

@@ -1220,7 +1220,7 @@ object, marking it as a secret. If it doesn't exist, or the configuration value string, an error is thrown.

-property name +property name

public name: string;
@@ -1229,7 +1229,7 @@ name is the configuration bag's logical name and uniquely identifies it. The de project.

- + function containsUnknowns

@@ -1241,7 +1241,7 @@ project. containsUnknowns returns true if the given value is or contains unknown values.

- + function createUrn

@@ -1254,7 +1254,7 @@ createUrn computes a URN from the combination of a resource name, resource type, optional project and optional stack.

- + interface CustomResourceOptions

@@ -1264,7 +1264,7 @@ optional project and optional stack. CustomResourceOptions is a bag of optional settings that control a custom resource's behavior.

-property additionalSecretOutputs +property additionalSecretOutputs

additionalSecretOutputs?: string[];
@@ -1274,7 +1274,7 @@ the resource provider and pulumi engine already determine based on inputs to you to mark certain ouputs as a secrets on a per resource basis.

-property aliases +property aliases

aliases?: Input<URN | Alias>[];
@@ -1282,7 +1282,7 @@ to mark certain ouputs as a secrets on a per resource basis. An optional list of aliases to treat this resource as matching.

-property customTimeouts +property customTimeouts

customTimeouts?: CustomTimeouts;
@@ -1290,7 +1290,7 @@ An optional list of aliases to treat this resource as matching. An optional customTimeouts configuration block.

-property deleteBeforeReplace +property deleteBeforeReplace

deleteBeforeReplace?: undefined | false | true;
@@ -1299,7 +1299,7 @@ When set to true, deleteBeforeReplace indicates that this resource should be del is created when replacement is necessary.

-property deletedWith +property deletedWith

deletedWith?: Resource;
@@ -1308,7 +1308,7 @@ If set, the providers Delete method will not be called for this resource if specified is being deleted as well.

-property dependsOn +property dependsOn

dependsOn?: Input<Input<Resource>[]> | Input<Resource>;
@@ -1316,7 +1316,7 @@ if specified is being deleted as well. An optional additional explicit dependencies on other resources.

-property id +property id

id?: Input<ID>;
@@ -1324,7 +1324,7 @@ An optional additional explicit dependencies on other resources. An optional existing ID to load, rather than create.

-property ignoreChanges +property ignoreChanges

ignoreChanges?: string[];
@@ -1332,7 +1332,7 @@ An optional existing ID to load, rather than create. Ignore changes to any of the specified properties.

-property import +property import

import?: ID;
@@ -1343,7 +1343,7 @@ current state. Once a resource has been imported, the import property must be re options.

-property parent +property parent

parent?: Resource;
@@ -1351,7 +1351,7 @@ options. An optional parent resource to which this resource belongs.

-property pluginDownloadURL +property pluginDownloadURL

pluginDownloadURL?: undefined | string;
@@ -1361,7 +1361,7 @@ associated plugin. This version overrides the URL information inferred from the current package and should rarely be used.

-property protect +property protect

protect?: undefined | false | true;
@@ -1369,7 +1369,7 @@ from the current package and should rarely be used. When set to true, protect ensures this resource cannot be deleted.

-property provider +property provider

provider?: ProviderResource;
@@ -1381,7 +1381,7 @@ from the parent's provider bag (see also ComponentResourceOptions.providers). If this is a [ComponentResourceOptions] do not provide both [provider] and [providers]

-property replaceOnChanges +property replaceOnChanges

replaceOnChanges?: string[];
@@ -1391,7 +1391,7 @@ properties will force a replacement. Initialization errors from previous deploy instead of update only if `"*"` is passed.

-property retainOnDelete +property retainOnDelete

retainOnDelete?: undefined | false | true;
@@ -1399,7 +1399,7 @@ instead of update only if `"*"` is passed. If set to True, the providers Delete method will not be called for this resource.

-property transformations +property transformations

transformations?: ResourceTransformation[];
@@ -1409,7 +1409,7 @@ transformations are applied in order, and are applied prior to transformation ap parents walking from the resource up to the stack.

-property urn +property urn

urn?: URN;
@@ -1417,7 +1417,7 @@ parents walking from the resource up to the stack. The URN of a previously-registered resource of this type to read from the engine.

-property version +property version

version?: undefined | string;
@@ -1427,14 +1427,14 @@ this resource. This version overrides the version information inferred from the rarely be used.

- + interface CustomTimeouts

interface CustomTimeouts

-property create +property create

create?: undefined | string;
@@ -1442,7 +1442,7 @@ rarely be used. The optional create timeout represented as a string e.g. 5m, 40s, 1d.

-property delete +property delete

delete?: undefined | string;
@@ -1450,7 +1450,7 @@ The optional create timeout represented as a string e.g. 5m, 40s, 1d. The optional delete timeout represented as a string e.g. 5m, 40s, 1d.

-property update +property update

update?: undefined | string;
@@ -1458,7 +1458,7 @@ The optional delete timeout represented as a string e.g. 5m, 40s, 1d. The optional update timeout represented as a string e.g. 5m, 40s, 1d.

- + function getOrganization

@@ -1470,7 +1470,7 @@ The optional update timeout represented as a string e.g. 5m, 40s, 1d. getOrganization returns the current organization name.

- + function getProject

@@ -1482,7 +1482,7 @@ getOrganization returns the current organization name. getProject returns the current project name. It throws an exception if none is registered.

- + function getStack

@@ -1494,14 +1494,14 @@ getProject returns the current project name. It throws an exception if none is r getStack returns the current stack name. It throws an exception if none is registered.

- + type ID

type ID = string;

- + type Input

@@ -1512,7 +1512,7 @@ getStack returns the current stack name. It throws an exception if none is regis or the output from a existing Resource.

- + type Inputs

@@ -1522,7 +1522,7 @@ or the output from a existing Resource. [Inputs] is a map of property name to property input, one for each resource property value.

- + function interpolate

@@ -1543,14 +1543,14 @@ As with [concat] the 'placeholders' between `${}` can be any Inputs. i.e. they [Promise]s, [Output]s, or just plain JavaScript values.

- + interface InvokeOptions

interface InvokeOptions

-property async +property async

async?: undefined | false | true;
@@ -1563,7 +1563,7 @@ synchronously is deprecated. The ability to do this will be removed at a later time.

-property parent +property parent

parent?: Resource;
@@ -1571,7 +1571,7 @@ time. An optional parent to use for default options for this invoke (e.g. the default provider to use).

-property pluginDownloadURL +property pluginDownloadURL

pluginDownloadURL?: undefined | string;
@@ -1581,7 +1581,7 @@ associated plugin. This version overrides the URL information inferred from the current package and should rarely be used.

-property provider +property provider

provider?: ProviderResource;
@@ -1590,7 +1590,7 @@ An optional provider to use for this invocation. If no provider is supplied, the invoked function's package will be used.

-property version +property version

version?: undefined | string;
@@ -1599,7 +1599,7 @@ An optional version, corresponding to the version of the provider plugin that sh invoke.

- + function isGrpcError

@@ -1608,7 +1608,7 @@ invoke.
isGrpcError(err: Error): boolean

- + function isSecret

@@ -1617,7 +1617,7 @@ invoke.
isSecret<T>(val: Output<T>): Promise<boolean>

- + function isUnknown

@@ -1629,7 +1629,7 @@ invoke. isUnknown returns true if the given value is unknown.

- + function jsonParse

@@ -1641,7 +1641,7 @@ isUnknown returns true if the given value is unknown. [jsonParse] Uses JSON.parse to deserialize the given Input JSON string into a value.

- + function jsonStringify

@@ -1653,7 +1653,7 @@ isUnknown returns true if the given value is unknown. [jsonStringify] Uses JSON.stringify to serialize the given Input value into a JSON string.

- + type Lifted

@@ -1693,7 +1693,7 @@ Instead, you still need to write; ```

- + type LiftedArray

@@ -1702,14 +1702,14 @@ Instead, you still need to write; length: Output<number>; };

- + type LiftedObject

type LiftedObject = { ... };

- + function mergeOptions

@@ -1739,7 +1739,7 @@ Conceptually property merging follows these basic rules:
mergeOptions(opts1: ResourceOptions | undefined, opts2: ResourceOptions | undefined): ResourceOptions

- + interface NumberConfigOptions

@@ -1749,7 +1749,7 @@ Conceptually property merging follows these basic rules: NumberConfigOptions may be used to constrain the set of legal values a number config value may contain.

-property max +property max

max?: undefined | number;
@@ -1757,7 +1757,7 @@ NumberConfigOptions may be used to constrain the set of legal values a number co The maximum number value, inclusive. If the number is greater than this, a ConfigRangeError is thrown.

-property min +property min

min?: undefined | number;
@@ -1765,7 +1765,7 @@ The maximum number value, inclusive. If the number is greater than this, a Confi The minimum number value, inclusive. If the number is less than this, a ConfigRangeError is thrown.

- + function output

@@ -1794,7 +1794,7 @@ The expected way to use this function is like so:
output<T>(val: Input<T> | undefined): Output<Unwrap<T | undefined>>

- + type Output

@@ -1843,7 +1843,7 @@ Instead of having to write: ```

- + interface OutputConstructor

@@ -1854,7 +1854,7 @@ Static side of the [Output] type. Can be used to [create] Outputs as well as arbitrary values to see if they are [Output]s.

-method create +method create

@@ -1864,14 +1864,14 @@ arbitrary values to see if they are [Output]s.
create<T>(val: Input<T> | undefined): Output<Unwrap<T | undefined>>

-method isInstance +method isInstance

isInstance<T>(obj: any): obj is Output<T>

- + interface OutputInstance

@@ -1882,7 +1882,7 @@ Instance side of the [Output] type. Exposes the deployment-time and run-time for working with the underlying value of an [Output].

-method apply +method apply

@@ -1921,7 +1921,7 @@ of the Output during cloud runtime execution, use `get()`.
apply<U>(func: (t: T) => U): Output<U>

-method get +method get

@@ -1937,7 +1937,7 @@ would allow Output values to flow into Resources while losing the data that woul the dependency graph to be changed.

- + class ResourceError

@@ -1950,14 +1950,14 @@ not a call stack should be returned as well. This should be very rare, and woul no usefulness of presenting that stack to the user.

- constructor + constructor

new ResourceError(message: string, resource: Resource | undefined, hideStack?: undefined | false | true)

-method isInstance +method isInstance

@@ -1968,37 +1968,37 @@ Returns true if the given object is an instance of a ResourceError. This is des multiple copies of the Pulumi SDK have been loaded into the same process.

-property Error +property Error

static Error: ErrorConstructor;

-property hideStack +property hideStack

public hideStack?: undefined | false | true;

-property message +property message

message: string;

-property name +property name

name: string;

-property resource +property resource

public resource: Resource | undefined;

-property stack +property stack

stack?: undefined | string;

- + interface ResourceOptions

@@ -2008,7 +2008,7 @@ multiple copies of the Pulumi SDK have been loaded into the same process. ResourceOptions is a bag of optional settings that control a resource's behavior.

-property aliases +property aliases

aliases?: Input<URN | Alias>[];
@@ -2016,7 +2016,7 @@ ResourceOptions is a bag of optional settings that control a resource's behavior An optional list of aliases to treat this resource as matching.

-property customTimeouts +property customTimeouts

customTimeouts?: CustomTimeouts;
@@ -2024,7 +2024,7 @@ An optional list of aliases to treat this resource as matching. An optional customTimeouts configuration block.

-property deletedWith +property deletedWith

deletedWith?: Resource;
@@ -2033,7 +2033,7 @@ If set, the providers Delete method will not be called for this resource if specified is being deleted as well.

-property dependsOn +property dependsOn

dependsOn?: Input<Input<Resource>[]> | Input<Resource>;
@@ -2041,7 +2041,7 @@ if specified is being deleted as well. An optional additional explicit dependencies on other resources.

-property id +property id

id?: Input<ID>;
@@ -2049,7 +2049,7 @@ An optional additional explicit dependencies on other resources. An optional existing ID to load, rather than create.

-property ignoreChanges +property ignoreChanges

ignoreChanges?: string[];
@@ -2057,7 +2057,7 @@ An optional existing ID to load, rather than create. Ignore changes to any of the specified properties.

-property parent +property parent

parent?: Resource;
@@ -2065,7 +2065,7 @@ Ignore changes to any of the specified properties. An optional parent resource to which this resource belongs.

-property pluginDownloadURL +property pluginDownloadURL

pluginDownloadURL?: undefined | string;
@@ -2075,7 +2075,7 @@ associated plugin. This version overrides the URL information inferred from the current package and should rarely be used.

-property protect +property protect

protect?: undefined | false | true;
@@ -2083,7 +2083,7 @@ from the current package and should rarely be used. When set to true, protect ensures this resource cannot be deleted.

-property provider +property provider

provider?: ProviderResource;
@@ -2095,7 +2095,7 @@ from the parent's provider bag (see also ComponentResourceOptions.providers). If this is a [ComponentResourceOptions] do not provide both [provider] and [providers]

-property replaceOnChanges +property replaceOnChanges

replaceOnChanges?: string[];
@@ -2105,7 +2105,7 @@ properties will force a replacement. Initialization errors from previous deploy instead of update only if `"*"` is passed.

-property retainOnDelete +property retainOnDelete

retainOnDelete?: undefined | false | true;
@@ -2113,7 +2113,7 @@ instead of update only if `"*"` is passed. If set to True, the providers Delete method will not be called for this resource.

-property transformations +property transformations

transformations?: ResourceTransformation[];
@@ -2123,7 +2123,7 @@ transformations are applied in order, and are applied prior to transformation ap parents walking from the resource up to the stack.

-property urn +property urn

urn?: URN;
@@ -2131,7 +2131,7 @@ parents walking from the resource up to the stack. The URN of a previously-registered resource of this type to read from the engine.

-property version +property version

version?: undefined | string;
@@ -2141,7 +2141,7 @@ this resource. This version overrides the version information inferred from the rarely be used.

- + type ResourceTransformation

@@ -2156,7 +2156,7 @@ of the original call to the `Resource` constructor. If the transformation retur this indicates that the resource will not be transformed.

- + interface ResourceTransformationArgs

@@ -2166,7 +2166,7 @@ this indicates that the resource will not be transformed. ResourceTransformationArgs is the argument bag passed to a resource transformation.

-property name +property name

name: string;
@@ -2174,7 +2174,7 @@ ResourceTransformationArgs is the argument bag passed to a resource transformati The name of the Resource.

-property opts +property opts

opts: ResourceOptions;
@@ -2182,7 +2182,7 @@ The name of the Resource. The original resource options passed to the Resource constructor.

-property props +property props

props: Inputs;
@@ -2190,7 +2190,7 @@ The original resource options passed to the Resource constructor. The original properties passed to the Resource constructor.

-property resource +property resource

resource: Resource;
@@ -2198,7 +2198,7 @@ The original properties passed to the Resource constructor. The Resource instance that is being transformed.

-property type +property type

type: string;
@@ -2206,7 +2206,7 @@ The Resource instance that is being transformed. The type of the Resource.

- + interface ResourceTransformationResult

@@ -2218,7 +2218,7 @@ callback. It includes new values to use for the `props` and `opts` of the `Reso the originally provided values.

-property opts +property opts

opts: ResourceOptions;
@@ -2226,7 +2226,7 @@ the originally provided values. The new resource options to use in place of the original `opts`

-property props +property props

props: Inputs;
@@ -2234,7 +2234,7 @@ The new resource options to use in place of the original `opts` The new properties to use in place of the original `props`

- + const rootStackResource

@@ -2256,7 +2256,7 @@ a bit confusing and may incorrectly look like something that could be removed wi semantics.

- + class RunError

@@ -2269,7 +2269,7 @@ stack trace. This type should be rarely used. Ideally ResourceError should alw that as many errors as possible can be associated with a Resource.

-method isInstance +method isInstance

@@ -2280,27 +2280,27 @@ Returns true if the given object is an instance of a RunError. This is designed multiple copies of the Pulumi SDK have been loaded into the same process.

-property Error +property Error

static Error: ErrorConstructor;

-property message +property message

message: string;

-property name +property name

name: string;

-property stack +property stack

stack?: undefined | string;

- + function secret

@@ -2315,7 +2315,7 @@ multiple copies of the Pulumi SDK have been loaded into the same process.
secret<T>(val: Input<T> | undefined): Output<Unwrap<T | undefined>>

- + interface StackReferenceArgs

@@ -2325,7 +2325,7 @@ multiple copies of the Pulumi SDK have been loaded into the same process. The set of arguments for constructing a StackReference resource.

-property name +property name

name?: Input<string>;
@@ -2333,7 +2333,7 @@ The set of arguments for constructing a StackReference resource. The name of the stack to reference.

- + interface StackReferenceOutputDetails

@@ -2344,7 +2344,7 @@ Records the output of a StackReference. At most one of th evalue and secretValue fields will be set.

-property secretValue +property secretValue

secretValue?: any;
@@ -2353,7 +2353,7 @@ Secret value returned by the StackReference. This is null if the value is not a secret or it does not exist.

-property value +property value

value?: any;
@@ -2362,7 +2362,7 @@ Output value returned by the StackReference. This is null if the value is a secret or it does not exist.

- + interface StringConfigOptions

@@ -2372,7 +2372,7 @@ This is null if the value is a secret or it does not exist. StringConfigOptions may be used to constrain the set of legal values a string config value may contain.

-property allowedValues +property allowedValues

allowedValues?: K[];
@@ -2380,7 +2380,7 @@ StringConfigOptions may be used to constrain the set of legal values a string co The legal enum values. If it does not match, a ConfigEnumError is thrown.

-property maxLength +property maxLength

maxLength?: undefined | number;
@@ -2388,7 +2388,7 @@ The legal enum values. If it does not match, a ConfigEnumError is thrown. The maximum string length. If the string is longer than this, a ConfigRangeError is thrown.

-property minLength +property minLength

minLength?: undefined | number;
@@ -2396,7 +2396,7 @@ The maximum string length. If the string is longer than this, a ConfigRangeError The minimum string length. If the string is not this long, a ConfigRangeError is thrown.

-property pattern +property pattern

pattern?: string | RegExp;
@@ -2404,7 +2404,7 @@ The minimum string length. If the string is not this long, a ConfigRangeError is A regular expression the string must match. If it does not match, a ConfigPatternError is thrown.

- + function unsecret

@@ -2416,7 +2416,7 @@ A regular expression the string must match. If it does not match, a ConfigPatter [unsecret] behaves the same as [output] except the returned output takes the existing output and unwraps the secret

- + type Unwrap

@@ -2447,21 +2447,21 @@ In other words, this should not be used as the shape of an object: `{ a: Promise It should always either be `{ a: Promise }` or just `{ a: Output<...> }`.

- + type UnwrappedArray

type UnwrappedArray = Array<Unwrap<T>>;

- + type UnwrappedObject

type UnwrappedObject = { ... };

- + type UnwrapSimple

@@ -2471,14 +2471,14 @@ It should always either be `{ a: Promise }` or just `{ a: Output<...> Handles encountering basic types when unwrapping.

- + type URN

type URN = string;

- + const version

diff --git a/content/docs/reference/pkg/nodejs/pulumi/pulumi/asset/_index.md b/content/docs/reference/pkg/nodejs/pulumi/pulumi/asset/_index.md index 898aaf88a14c..e5dfa5d38abe 100644 --- a/content/docs/reference/pkg/nodejs/pulumi/pulumi/asset/_index.md +++ b/content/docs/reference/pkg/nodejs/pulumi/pulumi/asset/_index.md @@ -3,7 +3,7 @@ title: "Module asset" title_tag: "Module asset | Package @pulumi/pulumi | Node.js SDK" linktitle: "asset" meta_desc: "Explore members of the asset module in the @pulumi/pulumi package." -git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" +git_sha: "ae0bc5013b5ecba279abc534f37a4398a859248a" --- @@ -34,7 +34,7 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9"

APIs

- + class Archive

@@ -44,7 +44,7 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" An Archive represents a collection of named assets.

-method isInstance +method isInstance

@@ -55,7 +55,7 @@ Returns true if the given object is an instance of an Archive. This is designed multiple copies of the Pulumi SDK have been loaded into the same process.

- + class Asset

@@ -65,7 +65,7 @@ multiple copies of the Pulumi SDK have been loaded into the same process. Asset represents a single blob of text or data that is managed as a first class entity.

-method isInstance +method isInstance

@@ -76,7 +76,7 @@ Returns true if the given object is an instance of an Asset. This is designed t multiple copies of the Pulumi SDK have been loaded into the same process.

- + class AssetArchive

@@ -86,14 +86,14 @@ multiple copies of the Pulumi SDK have been loaded into the same process. An AssetArchive is an archive created from an in-memory collection of named assets or other archives.

- constructor + constructor

new AssetArchive(assets: AssetMap | Promise<AssetMap>)

-method isInstance +method isInstance

@@ -104,7 +104,7 @@ Returns true if the given object is an instance of an Archive. This is designed multiple copies of the Pulumi SDK have been loaded into the same process.

-property assets +property assets

public assets: Promise<AssetMap>;
@@ -112,7 +112,7 @@ multiple copies of the Pulumi SDK have been loaded into the same process. A map of names to assets.

- + type AssetMap

@@ -122,7 +122,7 @@ A map of names to assets. AssetMap is a map of assets.

- + class FileArchive

@@ -133,14 +133,14 @@ A FileArchive is a file-based archive, or a collection of file-based assets. Th single archive file in one of the supported formats (.tar, .tar.gz, or .zip).

- constructor + constructor

new FileArchive(path: string | Promise<string>)

-method isInstance +method isInstance

@@ -151,7 +151,7 @@ Returns true if the given object is an instance of an Archive. This is designed multiple copies of the Pulumi SDK have been loaded into the same process.

-property path +property path

public path: Promise<string>;
@@ -159,7 +159,7 @@ multiple copies of the Pulumi SDK have been loaded into the same process. The path to the asset file.

- + class FileAsset

@@ -169,14 +169,14 @@ The path to the asset file. FileAsset is a kind of asset produced from a given path to a file on the local filesystem.

- constructor + constructor

new FileAsset(path: string | Promise<string>)

-method isInstance +method isInstance

@@ -187,7 +187,7 @@ Returns true if the given object is an instance of an Asset. This is designed t multiple copies of the Pulumi SDK have been loaded into the same process.

-property path +property path

public path: Promise<string>;
@@ -195,7 +195,7 @@ multiple copies of the Pulumi SDK have been loaded into the same process. The path to the asset file.

- + class RemoteArchive

@@ -207,14 +207,14 @@ protocol for fetching the archive's contents: `file://` is a local file (just li `https://` specify HTTP and HTTPS, respectively, and specific providers may recognize custom schemes.

- constructor + constructor

new RemoteArchive(uri: string | Promise<string>)

-method isInstance +method isInstance

@@ -225,7 +225,7 @@ Returns true if the given object is an instance of an Archive. This is designed multiple copies of the Pulumi SDK have been loaded into the same process.

-property uri +property uri

public uri: Promise<string>;
@@ -233,7 +233,7 @@ multiple copies of the Pulumi SDK have been loaded into the same process. The URI where the archive lives.

- + class RemoteAsset

@@ -245,14 +245,14 @@ contents: `file://` specifies a local file, `http://` and `https://` specify HTT specific providers may recognize alternative schemes; this is merely the base-most set that all providers support.

- constructor + constructor

new RemoteAsset(uri: string | Promise<string>)

-method isInstance +method isInstance

@@ -263,7 +263,7 @@ Returns true if the given object is an instance of an Asset. This is designed t multiple copies of the Pulumi SDK have been loaded into the same process.

-property uri +property uri

public uri: Promise<string>;
@@ -271,7 +271,7 @@ multiple copies of the Pulumi SDK have been loaded into the same process. The URI where the asset lives.

- + class StringAsset

@@ -281,14 +281,14 @@ The URI where the asset lives. StringAsset is a kind of asset produced from an in-memory UTF8-encoded string.

- constructor + constructor

new StringAsset(text: string | Promise<string>)

-method isInstance +method isInstance

@@ -299,7 +299,7 @@ Returns true if the given object is an instance of an Asset. This is designed t multiple copies of the Pulumi SDK have been loaded into the same process.

-property text +property text

public text: Promise<string>;
diff --git a/content/docs/reference/pkg/nodejs/pulumi/pulumi/automation/_index.md b/content/docs/reference/pkg/nodejs/pulumi/pulumi/automation/_index.md index 1cb91a281681..9d3999d9adcb 100644 --- a/content/docs/reference/pkg/nodejs/pulumi/pulumi/automation/_index.md +++ b/content/docs/reference/pkg/nodejs/pulumi/pulumi/automation/_index.md @@ -3,7 +3,7 @@ title: "Module automation" title_tag: "Module automation | Package @pulumi/pulumi | Node.js SDK" linktitle: "automation" meta_desc: "Explore members of the automation module in the @pulumi/pulumi package." -git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" +git_sha: "ae0bc5013b5ecba279abc534f37a4398a859248a" --- @@ -75,7 +75,7 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9"

APIs

- + type ConfigMap

@@ -85,7 +85,7 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" ConfigMap is a map of string to ConfigValue

- + interface ConfigValue

@@ -96,17 +96,17 @@ ConfigValue is the input/output of a `pulumi config` command. It has a plaintext value, and an option boolean indicating secretness.

-property secret +property secret

secret?: undefined | false | true;

-property value +property value

value: string;

- + interface Deployment

@@ -116,7 +116,7 @@ It has a plaintext value, and an option boolean indicating secretness. Deployment encapsulates the state of a stack deployment.

-property deployment +property deployment

deployment: any;
@@ -124,7 +124,7 @@ Deployment encapsulates the state of a stack deployment. The pulumi deployment.

-property version +property version

version: number;
@@ -132,7 +132,7 @@ The pulumi deployment. Version indicates the schema of the encoded deployment.

- + interface DestroyOptions

@@ -142,12 +142,12 @@ Version indicates the schema of the encoded deployment. Options controlling the behavior of a Stack.destroy() operation.

-property color +property color

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

-property debug +property debug

debug?: undefined | false | true;
@@ -155,7 +155,7 @@ Options controlling the behavior of a Stack.destroy() operation. Print detailed debugging output during resource operations

-property excludeProtected +property excludeProtected

excludeProtected?: undefined | false | true;
@@ -163,7 +163,7 @@ Print detailed debugging output during resource operations Do not destroy protected resources.

-property logFlow +property logFlow

logFlow?: undefined | false | true;
@@ -171,7 +171,7 @@ Do not destroy protected resources. Flow log settings to child processes (like plugins)

-property logToStdErr +property logToStdErr

logToStdErr?: undefined | false | true;
@@ -179,7 +179,7 @@ Flow log settings to child processes (like plugins) Log to stderr instead of to files

-property logVerbosity +property logVerbosity

logVerbosity?: undefined | number;
@@ -187,42 +187,42 @@ Log to stderr instead of to files Enable verbose logging (e.g., v=3); anything >3 is very verbose

-property message +property message

message?: undefined | string;

-property onEvent +property onEvent

onEvent?: undefined | (event: EngineEvent) => void;

-property onOutput +property onOutput

onOutput?: undefined | (out: string) => void;

-property parallel +property parallel

parallel?: undefined | number;

-property showSecrets +property showSecrets

showSecrets?: undefined | false | true;

-property target +property target

target?: string[];

-property targetDependents +property targetDependents

targetDependents?: undefined | false | true;

-property tracing +property tracing

tracing?: undefined | string;
@@ -230,12 +230,12 @@ Enable verbose logging (e.g., v=3); anything >3 is very verbose Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file

-property userAgent +property userAgent

userAgent?: undefined | string;

- + interface DestroyResult

@@ -245,22 +245,22 @@ Emit tracing to the specified endpoint. Use the file: scheme to write tracing da Output from destroying all resources in a Stack.

-property stderr +property stderr

stderr: string;

-property stdout +property stdout

stdout: string;

-property summary +property summary

summary: UpdateSummary;

- + function fullyQualifiedStackName

@@ -277,14 +277,14 @@ format, and instead only use the stack name without an org/user or project to qu See: https://github.com/pulumi/pulumi/issues/2522

- + interface GlobalOpts

interface GlobalOpts

-property color +property color

color?: "always" | "never" | "raw" | "auto";
@@ -292,7 +292,7 @@ See: https://github.com/pulumi/pulumi/issues/2522 Colorize output.

-property debug +property debug

debug?: undefined | false | true;
@@ -300,7 +300,7 @@ Colorize output. Print detailed debugging output during resource operations

-property logFlow +property logFlow

logFlow?: undefined | false | true;
@@ -308,7 +308,7 @@ Print detailed debugging output during resource operations Flow log settings to child processes (like plugins)

-property logToStdErr +property logToStdErr

logToStdErr?: undefined | false | true;
@@ -316,7 +316,7 @@ Flow log settings to child processes (like plugins) Log to stderr instead of to files

-property logVerbosity +property logVerbosity

logVerbosity?: undefined | number;
@@ -324,7 +324,7 @@ Log to stderr instead of to files Enable verbose logging (e.g., v=3); anything >3 is very verbose

-property tracing +property tracing

tracing?: undefined | string;
@@ -332,7 +332,7 @@ Enable verbose logging (e.g., v=3); anything >3 is very verbose Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file

- + interface InlineProgramArgs

@@ -342,7 +342,7 @@ Emit tracing to the specified endpoint. Use the file: scheme to write tracing da Description of a stack backed by an inline (in process) Pulumi program.

-property program +property program

program: PulumiFn;
@@ -350,7 +350,7 @@ Description of a stack backed by an inline (in process) Pulumi program. The inline (in process) Pulumi program to use with Update and Preview operations.

-property projectName +property projectName

projectName: string;
@@ -358,7 +358,7 @@ The inline (in process) Pulumi program to use with Update and Preview operations The name of the associated project

-property stackName +property stackName

stackName: string;
@@ -366,7 +366,7 @@ The name of the associated project The name of the associated Stack

- + interface LocalProgramArgs

@@ -376,17 +376,17 @@ The name of the associated Stack Description of a stack backed by pre-existing local Pulumi CLI program.

-property stackName +property stackName

stackName: string;

-property workDir +property workDir

workDir: string;

- + class LocalWorkspace

@@ -404,7 +404,7 @@ alter the Workspace Pulumi.yaml file, and setting config on a Stack will modify This is identical to the behavior of Pulumi CLI driven workspaces.

-accessor pulumiVersion +accessor pulumiVersion

public get pulumiVersion(): string;
@@ -412,7 +412,7 @@ This is identical to the behavior of Pulumi CLI driven workspaces. The version of the underlying Pulumi CLI/Engine.

-method create +method create

@@ -423,7 +423,7 @@ Creates a workspace using the specified options. Used for maximal control and cu of the underlying environment before any stacks are created or selected.

-method createOrSelectStack +method createOrSelectStack

@@ -445,7 +445,7 @@ on behalf of the user. Similarly, unless a `workDir` option is specified, the wo to a new temporary directory provided by the OS.

-method createStack +method createStack

@@ -455,7 +455,7 @@ to a new temporary directory provided by the OS. Creates and sets a new stack with the stack name, failing if one already exists.

-method createStack +method createStack

@@ -476,7 +476,7 @@ will be created on behalf of the user. Similarly, unless a `workDir` option is s will default to a new temporary directory provided by the OS.

-method exportStack +method exportStack

@@ -487,7 +487,7 @@ 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).

-method getAllConfig +method getAllConfig

@@ -498,7 +498,7 @@ Returns the config map for the specified stack name, scoped to the current works LocalWorkspace reads this config from the matching Pulumi.stack.yaml file.

-method getConfig +method getConfig

@@ -509,7 +509,7 @@ 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.

-method getTag +method getTag

@@ -520,7 +520,7 @@ Returns the value associated with the specified stack name and key, scoped to the LocalWorkspace.

-method importStack +method importStack

@@ -531,7 +531,7 @@ 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).

-method installPlugin +method installPlugin

@@ -541,7 +541,7 @@ This can be combined with Workspace.exportStack to edit a stack's state (such as Installs a plugin in the Workspace, for example to use cloud providers like AWS or GCP.

-method installPluginFromServer +method installPluginFromServer

@@ -551,7 +551,7 @@ Installs a plugin in the Workspace, for example to use cloud providers like AWS Installs a plugin in the Workspace, from a third party server.

-method listPlugins +method listPlugins

@@ -561,7 +561,7 @@ Installs a plugin in the Workspace, from a third party server. Returns a list of all plugins installed in the Workspace.

-method listStacks +method listStacks

@@ -572,7 +572,7 @@ Returns all Stacks created under the current Project. This queries underlying backend and may return stacks not present in the Workspace (as Pulumi..yaml files).

-method listTags +method listTags

@@ -582,7 +582,7 @@ This queries underlying backend and may return stacks not present in the Workspa Returns the tag map for the specified tag name, scoped to the current LocalWorkspace.

-method postCommandCallback +method postCommandCallback

@@ -594,7 +594,7 @@ An extensibility point to perform workspace cleanup (CLI operations may create/m LocalWorkspace does not utilize this extensibility point.

-method projectSettings +method projectSettings

@@ -606,7 +606,7 @@ LocalWorkspace reads settings from the Pulumi.yaml in the workspace. A workspace can contain only a single project at a time.

-method refreshConfig +method refreshConfig

@@ -617,7 +617,7 @@ Gets and sets the config map used with the last update for Stack matching stack It will overwrite all configuration in the Pulumi..yaml file in Workspace.WorkDir().

-method removeAllConfig +method removeAllConfig

@@ -628,7 +628,7 @@ 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().

-method removeConfig +method removeConfig

@@ -639,7 +639,7 @@ 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().

-method removePlugin +method removePlugin

@@ -649,7 +649,7 @@ It will remove any matching values in the Pulumi..yaml file in Workspace. Removes a plugin from the Workspace matching the specified name and version.

-method removeStack +method removeStack

@@ -659,7 +659,7 @@ Removes a plugin from the Workspace matching the specified name and version. Deletes the stack and all associated configuration and history.

-method removeTag +method removeTag

@@ -669,7 +669,7 @@ Deletes the stack and all associated configuration and history. Removes the specified key-value pair on the provided stack name.

-method saveProjectSettings +method saveProjectSettings

@@ -681,7 +681,7 @@ There can only be a single project per workspace. Fails if new project name does LocalWorkspace writes this value to a Pulumi.yaml file in Workspace.WorkDir().

-method saveStackSettings +method saveStackSettings

@@ -692,7 +692,7 @@ Overwrites the settings object for the stack matching the specified stack name. LocalWorkspace writes this value to a Pulumi..yaml file in Workspace.WorkDir()

-method selectStack +method selectStack

@@ -702,7 +702,7 @@ LocalWorkspace writes this value to a Pulumi..yaml file in Workspace.Work Selects and sets an existing stack matching the stack name, failing if none exists.

-method selectStack +method selectStack

@@ -723,7 +723,7 @@ will be created on behalf of the user. Similarly, unless a `workDir` option is s will default to a new temporary directory provided by the OS.

-method serializeArgsForOp +method serializeArgsForOp

@@ -736,7 +736,7 @@ returns a list of args to append to an invoked command ["--config=...", ] LocalWorkspace does not utilize this extensibility point.

-method setAllConfig +method setAllConfig

@@ -747,7 +747,7 @@ 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().

-method setConfig +method setConfig

@@ -758,7 +758,7 @@ Sets the specified key-value pair on the provided stack name. LocalWorkspace writes this value to the matching Pulumi..yaml file in Workspace.WorkDir().

-method setTag +method setTag

@@ -768,7 +768,7 @@ LocalWorkspace writes this value to the matching Pulumi..yaml file in Wor Sets the specified key-value pair on the provided stack name.

-method stack +method stack

@@ -778,7 +778,7 @@ Sets the specified key-value pair on the provided stack name. Returns a summary of the currently selected stack, if any.

-method stackOutputs +method stackOutputs

@@ -788,7 +788,7 @@ Returns a summary of the currently selected stack, if any. Gets the current set of Stack outputs from the last Stack.up().

-method stackSettings +method stackSettings

@@ -799,7 +799,7 @@ Returns the settings object for the stack matching the specified stack name if a LocalWorkspace reads this from a Pulumi..yaml file in Workspace.WorkDir().

-method whoAmI +method whoAmI

@@ -809,7 +809,7 @@ LocalWorkspace reads this from a Pulumi..yaml file in Workspace.WorkDir() Returns the currently authenticated user.

-property envVars +property envVars

envVars: {[key: string]: string};
@@ -817,7 +817,7 @@ Returns the currently authenticated user. Environment values scoped to the current workspace. These will be supplied to every Pulumi command.

-property program +property program

program?: PulumiFn;
@@ -826,7 +826,7 @@ Environment values scoped to the current workspace. These will be supplied to ev If none is specified, the stack will refer to ProjectSettings for this information.

-property pulumiHome +property pulumiHome

pulumiHome?: undefined | string;
@@ -835,7 +835,7 @@ The directory override for CLI metadata if set. This customizes the location of $PULUMI_HOME where metadata is stored and plugins are installed.

-property secretsProvider +property secretsProvider

secretsProvider?: undefined | string;
@@ -844,7 +844,7 @@ The secrets provider to use for encryption and decryption of stack secrets. See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providers

-property workDir +property workDir

workDir: string;
@@ -852,7 +852,7 @@ See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-pr The working directory to run Pulumi CLI commands

- + interface LocalWorkspaceOptions

@@ -863,7 +863,7 @@ Extensibility options to configure a LocalWorkspace; e.g: settings to seed and environment variables to pass through to every command.

-property envVars +property envVars

envVars?: undefined | {[key: string]: string};
@@ -871,7 +871,7 @@ and environment variables to pass through to every command. Environment values scoped to the current workspace. These will be supplied to every Pulumi command.

-property program +property program

program?: PulumiFn;
@@ -880,7 +880,7 @@ Environment values scoped to the current workspace. These will be supplied to ev If none is specified, the stack will refer to ProjectSettings for this information.

-property projectSettings +property projectSettings

projectSettings?: ProjectSettings;
@@ -888,7 +888,7 @@ Environment values scoped to the current workspace. These will be supplied to ev The settings object for the current project.

-property pulumiHome +property pulumiHome

pulumiHome?: undefined | string;
@@ -896,7 +896,7 @@ The settings object for the current project. The directory to override for CLI metadata

-property secretsProvider +property secretsProvider

secretsProvider?: undefined | string;
@@ -905,7 +905,7 @@ The secrets provider to use for encryption and decryption of stack secrets. See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providers

-property stackSettings +property stackSettings

stackSettings?: undefined | {[key: string]: StackSettings};
@@ -913,7 +913,7 @@ See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-pr A map of Stack names and corresponding settings objects.

-property workDir +property workDir

workDir?: undefined | string;
@@ -921,7 +921,7 @@ A map of Stack names and corresponding settings objects. The directory to run Pulumi commands and read settings (Pulumi.yaml and Pulumi..yaml)l.

- + type OpMap

@@ -931,7 +931,7 @@ The directory to run Pulumi commands and read settings (Pulumi.yaml and Pulumi.< A map of operation types and their corresponding counts.

- + type OpType

@@ -941,85 +941,85 @@ A map of operation types and their corresponding counts. The granular CRUD operation performed on a particular resource during an update.

- + type OutputMap

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

- + interface OutputValue

interface OutputValue

-property secret +property secret

secret: boolean;

-property value +property value

value: any;

- + interface PluginInfo

interface PluginInfo

-property installTime +property installTime

installTime: Date;

-property kind +property kind

kind: PluginKind;

-property lastUsedTime +property lastUsedTime

lastUsedTime: Date;

-property name +property name

name: string;

-property path +property path

path: string;

-property serverURL +property serverURL

serverURL: string;

-property size +property size

size: number;

-property version +property version

version?: undefined | string;

- + type PluginKind

type PluginKind = "analyzer" | "language" | "resource";

- + interface PreviewOptions

@@ -1029,12 +1029,12 @@ The granular CRUD operation performed on a particular resource during an update. Options controlling the behavior of a Stack.preview() operation.

-property color +property color

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

-property debug +property debug

debug?: undefined | false | true;
@@ -1042,17 +1042,17 @@ Options controlling the behavior of a Stack.preview() operation. Print detailed debugging output during resource operations

-property diff +property diff

diff?: undefined | false | true;

-property expectNoChanges +property expectNoChanges

expectNoChanges?: undefined | false | true;

-property logFlow +property logFlow

logFlow?: undefined | false | true;
@@ -1060,7 +1060,7 @@ Print detailed debugging output during resource operations Flow log settings to child processes (like plugins)

-property logToStdErr +property logToStdErr

logToStdErr?: undefined | false | true;
@@ -1068,7 +1068,7 @@ Flow log settings to child processes (like plugins) Log to stderr instead of to files

-property logVerbosity +property logVerbosity

logVerbosity?: undefined | number;
@@ -1076,27 +1076,27 @@ Log to stderr instead of to files Enable verbose logging (e.g., v=3); anything >3 is very verbose

-property message +property message

message?: undefined | string;

-property onEvent +property onEvent

onEvent?: undefined | (event: EngineEvent) => void;

-property onOutput +property onOutput

onOutput?: undefined | (out: string) => void;

-property parallel +property parallel

parallel?: undefined | number;

-property plan +property plan

plan?: undefined | string;
@@ -1104,22 +1104,22 @@ Enable verbose logging (e.g., v=3); anything >3 is very verbose Plan specifies the path where the update plan should be saved.

-property policyPackConfigs +property policyPackConfigs

policyPackConfigs?: string[];

-property policyPacks +property policyPacks

policyPacks?: string[];

-property program +property program

program?: PulumiFn;

-property refresh +property refresh

refresh?: undefined | false | true;
@@ -1127,22 +1127,22 @@ Plan specifies the path where the update plan should be saved. Refresh the state of the stack's resources against the cloud provider before running preview.

-property replace +property replace

replace?: string[];

-property target +property target

target?: string[];

-property targetDependents +property targetDependents

targetDependents?: undefined | false | true;

-property tracing +property tracing

tracing?: undefined | string;
@@ -1150,12 +1150,12 @@ Refresh the state of the stack's resources against the cloud provider before run Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file

-property userAgent +property userAgent

userAgent?: undefined | string;

- + interface PreviewResult

@@ -1165,22 +1165,22 @@ Emit tracing to the specified endpoint. Use the file: scheme to write tracing da Output from running a Pulumi program preview.

-property changeSummary +property changeSummary

changeSummary: OpMap;

-property stderr +property stderr

stderr: string;

-property stdout +property stdout

stdout: string;

- + interface ProjectBackend

@@ -1190,12 +1190,12 @@ Output from running a Pulumi program preview. Configuration for the project's Pulumi state storage backend.

-property url +property url

url?: undefined | string;

- + type ProjectRuntime

@@ -1205,7 +1205,7 @@ Configuration for the project's Pulumi state storage backend. Supported Pulumi program language runtimes.

- + interface ProjectRuntimeInfo

@@ -1215,17 +1215,17 @@ Supported Pulumi program language runtimes. A description of the Project's program runtime and associated metadata.

-property name +property name

name: string;

-property options +property options

options?: undefined | {[key: string]: any};

- + interface ProjectSettings

@@ -1235,57 +1235,57 @@ A description of the Project's program runtime and associated metadata. A Pulumi project manifest. It describes metadata applying to all sub-stacks created from the project.

-property author +property author

author?: undefined | string;

-property backend +property backend

backend?: ProjectBackend;

-property config +property config

config?: undefined | string;

-property description +property description

description?: undefined | string;

-property license +property license

license?: undefined | string;

-property main +property main

main?: undefined | string;

-property name +property name

name: string;

-property runtime +property runtime

runtime: ProjectRuntimeInfo | ProjectRuntime;

-property template +property template

template?: ProjectTemplate;

-property website +property website

website?: undefined | string;

- + interface ProjectTemplate

@@ -1295,27 +1295,27 @@ A Pulumi project manifest. It describes metadata applying to all sub-stacks crea A template used to seed new stacks created from this project.

-property config +property config

config?: undefined | {[key: string]: ProjectTemplateConfigValue};

-property description +property description

description?: undefined | string;

-property important +property important

important?: undefined | false | true;

-property quickstart +property quickstart

quickstart?: undefined | string;

- + interface ProjectTemplateConfigValue

@@ -1325,22 +1325,22 @@ A template used to seed new stacks created from this project. A placeholder config value for a project template.

-property default +property default

default?: undefined | string;

-property description +property description

description?: undefined | string;

-property secret +property secret

secret?: undefined | false | true;

- + type PulumiFn

@@ -1350,7 +1350,7 @@ A placeholder config value for a project template. A Pulumi program as an inline function (in process).

- + type RawJSON

@@ -1360,7 +1360,7 @@ A Pulumi program as an inline function (in process). An unstructured JSON string used for back-compat with versioned APIs (such as Deployment).

- + interface RefreshOptions

@@ -1370,12 +1370,12 @@ An unstructured JSON string used for back-compat with versioned APIs (such as De Options controlling the behavior of a Stack.refresh() operation.

-property color +property color

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

-property debug +property debug

debug?: undefined | false | true;
@@ -1383,12 +1383,12 @@ Options controlling the behavior of a Stack.refresh() operation. Print detailed debugging output during resource operations

-property expectNoChanges +property expectNoChanges

expectNoChanges?: undefined | false | true;

-property logFlow +property logFlow

logFlow?: undefined | false | true;
@@ -1396,7 +1396,7 @@ Print detailed debugging output during resource operations Flow log settings to child processes (like plugins)

-property logToStdErr +property logToStdErr

logToStdErr?: undefined | false | true;
@@ -1404,7 +1404,7 @@ Flow log settings to child processes (like plugins) Log to stderr instead of to files

-property logVerbosity +property logVerbosity

logVerbosity?: undefined | number;
@@ -1412,37 +1412,37 @@ Log to stderr instead of to files Enable verbose logging (e.g., v=3); anything >3 is very verbose

-property message +property message

message?: undefined | string;

-property onEvent +property onEvent

onEvent?: undefined | (event: EngineEvent) => void;

-property onOutput +property onOutput

onOutput?: undefined | (out: string) => void;

-property parallel +property parallel

parallel?: undefined | number;

-property showSecrets +property showSecrets

showSecrets?: undefined | false | true;

-property target +property target

target?: string[];

-property tracing +property tracing

tracing?: undefined | string;
@@ -1450,12 +1450,12 @@ Enable verbose logging (e.g., v=3); anything >3 is very verbose Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file

-property userAgent +property userAgent

userAgent?: undefined | string;

- + interface RefreshResult

@@ -1465,22 +1465,22 @@ Emit tracing to the specified endpoint. Use the file: scheme to write tracing da Output from refreshing the resources in a given Stack.

-property stderr +property stderr

stderr: string;

-property stdout +property stdout

stdout: string;

-property summary +property summary

summary: UpdateSummary;

- + interface RemoteDestroyOptions

@@ -1490,17 +1490,17 @@ Output from refreshing the resources in a given Stack. Options controlling the behavior of a RemoteStack.destroy() operation.

-property onEvent +property onEvent

onEvent?: undefined | (event: EngineEvent) => void;

-property onOutput +property onOutput

onOutput?: undefined | (out: string) => void;

- + interface RemoteGitAuthArgs

@@ -1516,7 +1516,7 @@ There are three different authentication paths: Only one authentication path is valid.

-property password +property password

password?: undefined | string;
@@ -1524,7 +1524,7 @@ Only one authentication path is valid. The password that pairs with a username or as part of an SSH Private Key.

-property personalAccessToken +property personalAccessToken

personalAccessToken?: undefined | string;
@@ -1532,7 +1532,7 @@ The password that pairs with a username or as part of an SSH Private Key. PersonalAccessToken is a Git personal access token in replacement of your password.

-property sshPrivateKey +property sshPrivateKey

sshPrivateKey?: undefined | string;
@@ -1540,7 +1540,7 @@ PersonalAccessToken is a Git personal access token in replacement of your passwo The (contents) private key for access to the git repo.

-property sshPrivateKeyPath +property sshPrivateKeyPath

sshPrivateKeyPath?: undefined | string;
@@ -1548,7 +1548,7 @@ The (contents) private key for access to the git repo. The absolute path to a private key for access to the git repo.

-property username +property username

username?: undefined | string;
@@ -1556,7 +1556,7 @@ The absolute path to a private key for access to the git repo. Username is the username to use when authenticating to a git repository

- + interface RemoteGitProgramArgs

@@ -1566,7 +1566,7 @@ Username is the username to use when authenticating to a git repository Description of a stack backed by a remote Pulumi program in a Git repository.

-property auth +property auth

auth?: RemoteGitAuthArgs;
@@ -1574,7 +1574,7 @@ Description of a stack backed by a remote Pulumi program in a Git repository. Authentication options for the repository.

-property branch +property branch

branch?: undefined | string;
@@ -1582,7 +1582,7 @@ Authentication options for the repository. Optional branch to checkout.

-property commitHash +property commitHash

commitHash?: undefined | string;
@@ -1590,7 +1590,7 @@ Optional branch to checkout. Optional commit to checkout.

-property projectPath +property projectPath

projectPath?: undefined | string;
@@ -1598,7 +1598,7 @@ Optional commit to checkout. Optional path relative to the repo root specifying location of the Pulumi program.

-property stackName +property stackName

stackName: string;
@@ -1606,7 +1606,7 @@ Optional path relative to the repo root specifying location of the Pulumi progra The name of the associated Stack

-property url +property url

url: string;
@@ -1614,7 +1614,7 @@ The name of the associated Stack The URL of the repository.

- + interface RemotePreviewOptions

@@ -1624,17 +1624,17 @@ The URL of the repository. Options controlling the behavior of a RemoteStack.preview() operation.

-property onEvent +property onEvent

onEvent?: undefined | (event: EngineEvent) => void;

-property onOutput +property onOutput

onOutput?: undefined | (out: string) => void;

- + interface RemoteRefreshOptions

@@ -1644,17 +1644,17 @@ Options controlling the behavior of a RemoteStack.preview() operation. Options controlling the behavior of a RemoteStack.refresh() operation.

-property onEvent +property onEvent

onEvent?: undefined | (event: EngineEvent) => void;

-property onOutput +property onOutput

onOutput?: undefined | (out: string) => void;

- + class RemoteStack

@@ -1665,7 +1665,7 @@ RemoteStack is an isolated, independencly configurable instance of a Pulumi prog operated on remotely (up/preview/refresh/destroy).

-accessor name +accessor name

get name(): string;
@@ -1673,7 +1673,7 @@ operated on remotely (up/preview/refresh/destroy). The name identifying the Stack.

-method cancel +method cancel

@@ -1686,7 +1686,7 @@ if a resource operation was pending when the update was canceled. This command is not supported for local backends.

-method destroy +method destroy

@@ -1697,7 +1697,7 @@ Destroy deletes all resources in a stack, leaving all history and configuration This operation runs remotely.

-method exportStack +method exportStack

@@ -1708,7 +1708,7 @@ exportStack exports the deployment state of the stack. This can be combined with Stack.importStack to edit a stack's state (such as recovery from failed deployments).

-method history +method history

@@ -1719,7 +1719,7 @@ Returns a list summarizing all previous and current results from Stack lifecycle (up/preview/refresh/destroy).

-method importStack +method importStack

@@ -1730,7 +1730,7 @@ 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).

-method outputs +method outputs

@@ -1740,7 +1740,7 @@ This can be combined with Stack.exportStack to edit a stack's state (such as rec Gets the current set of Stack outputs from the last Stack.up().

-method preview +method preview

@@ -1752,7 +1752,7 @@ https://www.pulumi.com/docs/cli/commands/pulumi_preview/ This operation runs remotely.

-method refresh +method refresh

@@ -1764,7 +1764,7 @@ cloud provider. Any such changes are adopted into the current stack. This operation runs remotely.

-method up +method up

@@ -1776,7 +1776,7 @@ https://www.pulumi.com/docs/cli/commands/pulumi_up/ This operation runs remotely.

- + interface RemoteUpOptions

@@ -1786,17 +1786,17 @@ This operation runs remotely. Options controlling the behavior of a RemoteStack.up() operation.

-property onEvent +property onEvent

onEvent?: undefined | (event: EngineEvent) => void;

-property onOutput +property onOutput

onOutput?: undefined | (out: string) => void;

- + class RemoteWorkspace

@@ -1806,7 +1806,7 @@ Options controlling the behavior of a RemoteStack.up() operation. RemoteWorkspace is the execution context containing a single remote Pulumi project.

-method createOrSelectStack +method createOrSelectStack

@@ -1817,7 +1817,7 @@ PREVIEW: Creates or selects an existing Stack backed by a RemoteWorkspace with s Git repository. Pulumi operations on the stack (Preview, Update, Refresh, and Destroy) are performed remotely.

-method createStack +method createStack

@@ -1828,7 +1828,7 @@ PREVIEW: Creates a Stack backed by a RemoteWorkspace with source code from the s Pulumi operations on the stack (Preview, Update, Refresh, and Destroy) are performed remotely.

-method selectStack +method selectStack

@@ -1839,7 +1839,7 @@ PREVIEW: Selects an existing Stack backed by a RemoteWorkspace with source code repository. Pulumi operations on the stack (Preview, Update, Refresh, and Destroy) are performed remotely.

- + interface RemoteWorkspaceOptions

@@ -1849,7 +1849,7 @@ repository. Pulumi operations on the stack (Preview, Update, Refresh, and Destro Extensibility options to configure a RemoteWorkspace.

-property envVars +property envVars

envVars?: undefined | {[key: string]: string | {
@@ -1859,7 +1859,7 @@ Extensibility options to configure a RemoteWorkspace.
 Environment values scoped to the remote workspace. These will be passed to remote operations.
 
 

-property preRunCommands +property preRunCommands

preRunCommands?: string[];
@@ -1867,7 +1867,7 @@ Environment values scoped to the remote workspace. These will be passed to remot An optional list of arbitrary commands to run before a remote Pulumi operation is invoked.

-property skipInstallDependencies +property skipInstallDependencies

skipInstallDependencies?: undefined | false | true;
@@ -1875,7 +1875,7 @@ An optional list of arbitrary commands to run before a remote Pulumi operation i Whether to skip the default dependency installation step. Defaults to false.

- + class Stack

@@ -1888,7 +1888,7 @@ 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).

-method cancel +method cancel

@@ -1901,7 +1901,7 @@ if a resource operation was pending when the update was canceled. This command is not supported for local backends.

-method create +method create

@@ -1912,7 +1912,7 @@ Creates a new stack using the given workspace, and stack name. It fails if a stack with that name already exists

-method createOrSelect +method createOrSelect

@@ -1925,7 +1925,7 @@ or falls back to selecting the existing stack. If the stack does not exist, it will be created and selected.

-method destroy +method destroy

@@ -1935,7 +1935,7 @@ it will be created and selected. Destroy deletes all resources in a stack, leaving all history and configuration intact.

-method exportStack +method exportStack

@@ -1946,7 +1946,7 @@ exportStack exports the deployment state of the stack. This can be combined with Stack.importStack to edit a stack's state (such as recovery from failed deployments).

-method getAllConfig +method getAllConfig

@@ -1956,7 +1956,7 @@ This can be combined with Stack.importStack to edit a stack's state (such as rec Returns the full config map associated with the stack in the Workspace.

-method getConfig +method getConfig

@@ -1966,7 +1966,7 @@ Returns the full config map associated with the stack in the Workspace. Returns the config value associated with the specified key.

-method getTag +method getTag

@@ -1976,7 +1976,7 @@ Returns the config value associated with the specified key. Returns the tag value associated with specified key.

-method history +method history

@@ -1987,7 +1987,7 @@ Returns a list summarizing all previous and current results from Stack lifecycle (up/preview/refresh/destroy).

-method importStack +method importStack

@@ -1998,14 +1998,14 @@ 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).

-method info +method info

info(showSecrets?: undefined | false | true): Promise<UpdateSummary | undefined>

-method listTags +method listTags

@@ -2015,7 +2015,7 @@ This can be combined with Stack.exportStack to edit a stack's state (such as rec Returns the full tag map associated with the stack in the Workspace.

-method outputs +method outputs

@@ -2025,7 +2025,7 @@ Returns the full tag map associated with the stack in the Workspace. Gets the current set of Stack outputs from the last Stack.up().

-method preview +method preview

@@ -2036,7 +2036,7 @@ Performs a dry-run update to a stack, returning pending changes. https://www.pulumi.com/docs/cli/commands/pulumi_preview/

-method refresh +method refresh

@@ -2047,7 +2047,7 @@ Compares the current stack’s resource state with the state known to exist in t cloud provider. Any such changes are adopted into the current stack.

-method refreshConfig +method refreshConfig

@@ -2057,7 +2057,7 @@ cloud provider. Any such changes are adopted into the current stack. Gets and sets the config map used with the last update.

-method removeAllConfig +method removeAllConfig

@@ -2067,7 +2067,7 @@ Gets and sets the config map used with the last update. Removes the specified config keys from the Stack in the associated Workspace.

-method removeConfig +method removeConfig

@@ -2077,7 +2077,7 @@ Removes the specified config keys from the Stack in the associated Workspace. Removes the specified config key from the Stack in the associated Workspace.

-method removeTag +method removeTag

@@ -2087,7 +2087,7 @@ Removes the specified config key from the Stack in the associated Workspace. Removes the specified tag key-value pair from the Stack in the associated Workspace.

-method select +method select

@@ -2098,7 +2098,7 @@ Selects stack using the given workspace, and stack name. It returns an error if the given Stack does not exist.

-method setAllConfig +method setAllConfig

@@ -2108,7 +2108,7 @@ It returns an error if the given Stack does not exist. Sets all specified config values on the stack in the associated Workspace.

-method setConfig +method setConfig

@@ -2118,7 +2118,7 @@ Sets all specified config values on the stack in the associated Workspace. Sets a config key-value pair on the Stack in the associated Workspace.

-method setTag +method setTag

@@ -2128,7 +2128,7 @@ Sets a config key-value pair on the Stack in the associated Workspace. Sets a tag key-value pair on the Stack in the associated Workspace.

-method up +method up

@@ -2139,7 +2139,7 @@ Creates or updates the resources in a stack by executing the program in the Work https://www.pulumi.com/docs/cli/commands/pulumi_up/

-property name +property name

name: string;
@@ -2147,7 +2147,7 @@ https://www.pulumi.com/docs/cli/commands/pulumi_up/ The name identifying the Stack.

-property workspace +property workspace

workspace: Workspace;
@@ -2155,7 +2155,7 @@ The name identifying the Stack. The Workspace the Stack was created from.

- + interface StackSettings

@@ -2165,27 +2165,27 @@ The Workspace the Stack was created from. A description of the Stack's configuration and encryption metadata.

-property config +property config

config?: undefined | {[key: string]: StackSettingsConfigValue};

-property encryptedKey +property encryptedKey

encryptedKey?: undefined | string;

-property encryptionSalt +property encryptionSalt

encryptionSalt?: undefined | string;

-property secretsProvider +property secretsProvider

secretsProvider?: undefined | string;

- + type StackSettingsConfigValue

@@ -2195,7 +2195,7 @@ A description of the Stack's configuration and encryption metadata. Stack configuration entry

- + interface StackSettingsSecureConfigValue

@@ -2205,12 +2205,12 @@ Stack configuration entry A secret Stack config entry

-property secure +property secure

secure: string;

- + interface StackSummary

@@ -2220,37 +2220,37 @@ A secret Stack config entry A summary of the status of a given stack.

-property current +property current

current: boolean;

-property lastUpdate +property lastUpdate

lastUpdate?: undefined | string;

-property name +property name

name: string;

-property resourceCount +property resourceCount

resourceCount?: undefined | number;

-property updateInProgress +property updateInProgress

updateInProgress: boolean;

-property url +property url

url?: undefined | string;

- + type UpdateKind

@@ -2260,7 +2260,7 @@ A summary of the status of a given stack. The kind of update that was performed on the stack.

- + type UpdateResult

@@ -2270,64 +2270,64 @@ The kind of update that was performed on the stack. Represents the current status of a given update.

- + interface UpdateSummary

interface UpdateSummary

-property Deployment +property Deployment

Deployment?: RawJSON;

-property config +property config

config: ConfigMap;

-property endTime +property endTime

endTime: Date;

-property environment +property environment

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

-property kind +property kind

kind: UpdateKind;

-property message +property message

message: string;

-property resourceChanges +property resourceChanges

resourceChanges?: OpMap;

-property result +property result

result: UpdateResult;

-property startTime +property startTime

startTime: Date;

-property version +property version

version: number;

- + interface UpOptions

@@ -2337,7 +2337,7 @@ Represents the current status of a given update. Options controlling the behavior of a Stack.up() operation.

-property color +property color

color?: "always" | "never" | "raw" | "auto";
@@ -2345,7 +2345,7 @@ Options controlling the behavior of a Stack.up() operation. Colorize output.

-property debug +property debug

debug?: undefined | false | true;
@@ -2353,17 +2353,17 @@ Colorize output. Print detailed debugging output during resource operations

-property diff +property diff

diff?: undefined | false | true;

-property expectNoChanges +property expectNoChanges

expectNoChanges?: undefined | false | true;

-property logFlow +property logFlow

logFlow?: undefined | false | true;
@@ -2371,7 +2371,7 @@ Print detailed debugging output during resource operations Flow log settings to child processes (like plugins)

-property logToStdErr +property logToStdErr

logToStdErr?: undefined | false | true;
@@ -2379,7 +2379,7 @@ Flow log settings to child processes (like plugins) Log to stderr instead of to files

-property logVerbosity +property logVerbosity

logVerbosity?: undefined | number;
@@ -2387,27 +2387,27 @@ Log to stderr instead of to files Enable verbose logging (e.g., v=3); anything >3 is very verbose

-property message +property message

message?: undefined | string;

-property onEvent +property onEvent

onEvent?: undefined | (event: EngineEvent) => void;

-property onOutput +property onOutput

onOutput?: undefined | (out: string) => void;

-property parallel +property parallel

parallel?: undefined | number;

-property plan +property plan

plan?: undefined | string;
@@ -2415,27 +2415,27 @@ Enable verbose logging (e.g., v=3); anything >3 is very verbose Plan specifies the path to an update plan to use for the update.

-property policyPackConfigs +property policyPackConfigs

policyPackConfigs?: string[];

-property policyPacks +property policyPacks

policyPacks?: string[];

-property program +property program

program?: PulumiFn;

-property replace +property replace

replace?: string[];

-property showSecrets +property showSecrets

showSecrets?: undefined | false | true;
@@ -2443,17 +2443,17 @@ Plan specifies the path to an update plan to use for the update. Include secrets in the UpSummary.

-property target +property target

target?: string[];

-property targetDependents +property targetDependents

targetDependents?: undefined | false | true;

-property tracing +property tracing

tracing?: undefined | string;
@@ -2461,12 +2461,12 @@ Include secrets in the UpSummary. Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file

-property userAgent +property userAgent

userAgent?: undefined | string;

- + interface UpResult

@@ -2476,27 +2476,27 @@ Emit tracing to the specified endpoint. Use the file: scheme to write tracing da The deployment output from running a Pulumi program update.

-property outputs +property outputs

outputs: OutputMap;

-property stderr +property stderr

stderr: string;

-property stdout +property stdout

stdout: string;

-property summary +property summary

summary: UpdateSummary;

- + interface WhoAmIResult

@@ -2506,22 +2506,22 @@ The deployment output from running a Pulumi program update. The currently logged-in Pulumi identity.

-property organizations +property organizations

organizations?: string[];

-property url +property url

url?: undefined | string;

-property user +property user

user: string;

- + interface Workspace

@@ -2533,7 +2533,7 @@ Workspaces are used to manage the execution environment, providing various utili installation, environment configuration ($PULUMI_HOME), and creation, deletion, and listing of Stacks.

-method createStack +method createStack

@@ -2543,7 +2543,7 @@ installation, environment configuration ($PULUMI_HOME), and creation, deletion, Creates and sets a new stack with the stack name, failing if one already exists.

-method exportStack +method exportStack

@@ -2554,7 +2554,7 @@ 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).

-method getAllConfig +method getAllConfig

@@ -2564,7 +2564,7 @@ This can be combined with Workspace.importStack to edit a stack's state (such as Returns the config map for the specified stack name, scoped to the current Workspace.

-method getConfig +method getConfig

@@ -2575,7 +2575,7 @@ Returns the value associated with the specified stack name and key, scoped to the Workspace.

-method getTag +method getTag

@@ -2586,7 +2586,7 @@ Returns the value associated with the specified stack name and key, scoped to the Workspace.

-method importStack +method importStack

@@ -2597,7 +2597,7 @@ 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).

-method installPlugin +method installPlugin

@@ -2607,7 +2607,7 @@ This can be combined with Workspace.exportStack to edit a stack's state (such as Installs a plugin in the Workspace from a remote server, for example a third party plugin.

-method installPluginFromServer +method installPluginFromServer

@@ -2617,7 +2617,7 @@ Installs a plugin in the Workspace from a remote server, for example a third par Installs a plugin in the Workspace, for example to use cloud providers like AWS or GCP.

-method listPlugins +method listPlugins

@@ -2627,7 +2627,7 @@ Installs a plugin in the Workspace, for example to use cloud providers like AWS Returns a list of all plugins installed in the Workspace.

-method listStacks +method listStacks

@@ -2638,7 +2638,7 @@ Returns all Stacks created under the current Project. This queries underlying backend and may return stacks not present in the Workspace (as Pulumi..yaml files).

-method listTags +method listTags

@@ -2648,7 +2648,7 @@ This queries underlying backend and may return stacks not present in the Workspa Returns the tag map for the specified tag name, scoped to the current Workspace.

-method postCommandCallback +method postCommandCallback

@@ -2660,7 +2660,7 @@ An extensibility point to perform workspace cleanup (CLI operations may create/m LocalWorkspace does not utilize this extensibility point.

-method projectSettings +method projectSettings

@@ -2670,7 +2670,7 @@ LocalWorkspace does not utilize this extensibility point. Returns the settings object for the current project if any.

-method refreshConfig +method refreshConfig

@@ -2680,7 +2680,7 @@ Returns the settings object for the current project if any. Gets and sets the config map used with the last update for Stack matching stack name.

-method removeAllConfig +method removeAllConfig

@@ -2690,7 +2690,7 @@ Gets and sets the config map used with the last update for Stack matching stack Removes all values in the provided key list for the specified stack name.

-method removeConfig +method removeConfig

@@ -2700,7 +2700,7 @@ Removes all values in the provided key list for the specified stack name. Removes the specified key-value pair on the provided stack name.

-method removePlugin +method removePlugin

@@ -2710,7 +2710,7 @@ Removes the specified key-value pair on the provided stack name. Removes a plugin from the Workspace matching the specified name and version.

-method removeStack +method removeStack

@@ -2720,7 +2720,7 @@ Removes a plugin from the Workspace matching the specified name and version. Deletes the stack and all associated configuration and history.

-method removeTag +method removeTag

@@ -2730,7 +2730,7 @@ Deletes the stack and all associated configuration and history. Removes the specified key-value pair on the provided stack name.

-method saveProjectSettings +method saveProjectSettings

@@ -2741,7 +2741,7 @@ 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.

-method saveStackSettings +method saveStackSettings

@@ -2751,7 +2751,7 @@ There can only be a single project per workspace. Fails is new project name does overwrites the settings object for the stack matching the specified stack name.

-method selectStack +method selectStack

@@ -2761,7 +2761,7 @@ overwrites the settings object for the stack matching the specified stack name. Selects and sets an existing stack matching the stack name, failing if none exists.

-method serializeArgsForOp +method serializeArgsForOp

@@ -2774,7 +2774,7 @@ returns a list of args to append to an invoked command ["--config=...", ] LocalWorkspace does not utilize this extensibility point.

-method setAllConfig +method setAllConfig

@@ -2784,7 +2784,7 @@ LocalWorkspace does not utilize this extensibility point. Sets all values in the provided config map for the specified stack name.

-method setConfig +method setConfig

@@ -2794,7 +2794,7 @@ Sets all values in the provided config map for the specified stack name. Sets the specified key-value pair on the provided stack name.

-method setTag +method setTag

@@ -2804,7 +2804,7 @@ Sets the specified key-value pair on the provided stack name. Sets the specified key-value pair on the provided stack name.

-method stack +method stack

@@ -2814,7 +2814,7 @@ Sets the specified key-value pair on the provided stack name. Returns a summary of the currently selected stack, if any.

-method stackOutputs +method stackOutputs

@@ -2824,7 +2824,7 @@ Returns a summary of the currently selected stack, if any. Gets the current set of Stack outputs from the last Stack.up().

-method stackSettings +method stackSettings

@@ -2834,7 +2834,7 @@ Gets the current set of Stack outputs from the last Stack.up(). Returns the settings object for the stack matching the specified stack name if any.

-method whoAmI +method whoAmI

@@ -2844,7 +2844,7 @@ Returns the settings object for the stack matching the specified stack name if a Returns the currently authenticated user.

-property envVars +property envVars

envVars: {[key: string]: string};
@@ -2852,7 +2852,7 @@ Returns the currently authenticated user. Environment values scoped to the current workspace. These will be supplied to every Pulumi command.

-property program +property program

program?: PulumiFn;
@@ -2861,7 +2861,7 @@ Environment values scoped to the current workspace. These will be supplied to ev If none is specified, the stack will refer to ProjectSettings for this information.

-property pulumiHome +property pulumiHome

pulumiHome?: undefined | string;
@@ -2870,7 +2870,7 @@ The directory override for CLI metadata if set. This customizes the location of $PULUMI_HOME where metadata is stored and plugins are installed.

-property pulumiVersion +property pulumiVersion

pulumiVersion: string;
@@ -2878,7 +2878,7 @@ This customizes the location of $PULUMI_HOME where metadata is stored and plugin The version of the underlying Pulumi CLI/Engine.

-property secretsProvider +property secretsProvider

secretsProvider?: undefined | string;
@@ -2887,7 +2887,7 @@ The secrets provider to use for encryption and decryption of stack secrets. See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providers

-property workDir +property workDir

workDir: string;
diff --git a/content/docs/reference/pkg/nodejs/pulumi/pulumi/dynamic/_index.md b/content/docs/reference/pkg/nodejs/pulumi/pulumi/dynamic/_index.md index 81fbe019eb8a..6c61a798b959 100644 --- a/content/docs/reference/pkg/nodejs/pulumi/pulumi/dynamic/_index.md +++ b/content/docs/reference/pkg/nodejs/pulumi/pulumi/dynamic/_index.md @@ -3,7 +3,7 @@ title: "Module dynamic" title_tag: "Module dynamic | Package @pulumi/pulumi | Node.js SDK" linktitle: "dynamic" meta_desc: "Explore members of the dynamic module in the @pulumi/pulumi package." -git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" +git_sha: "ae0bc5013b5ecba279abc534f37a4398a859248a" --- @@ -34,7 +34,7 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9"

Resources

- + Resource Resource

@@ -44,7 +44,7 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" Resource represents a Pulumi Resource that incorporates an inline implementation of the Resource's CRUD operations.

- constructor + constructor

@@ -62,14 +62,14 @@ Creates a new dynamic resource. * `type` The type of the resource.

-method getProvider +method getProvider

public getProvider(moduleMember: string): ProviderResource | undefined

-method isInstance +method isInstance

@@ -80,7 +80,7 @@ Returns true if the given object is an instance of CustomResource. This is desi multiple copies of the Pulumi SDK have been loaded into the same process.

-property id +property id

public id: Output<ID>;
@@ -89,7 +89,7 @@ id is the provider-assigned unique ID for this managed resource. It is set duri deployments and may be missing (undefined) during planning phases.

-property urn +property urn

public urn: Output<URN>;
@@ -101,7 +101,7 @@ deployments.

Others

- + interface CheckFailure

@@ -111,7 +111,7 @@ deployments. CheckFailure represents a single failure in the results of a call to `ResourceProvider.check`

-property property +property property

property: string;
@@ -119,7 +119,7 @@ CheckFailure represents a single failure in the results of a call to `ResourcePr The property that failed validation.

-property reason +property reason

reason: string;
@@ -127,7 +127,7 @@ The property that failed validation. The reason that the property failed validation.

- + interface CheckResult

@@ -137,7 +137,7 @@ The reason that the property failed validation. CheckResult represents the results of a call to `ResourceProvider.check`.

-property failures +property failures

failures?: CheckFailure[];
@@ -145,7 +145,7 @@ CheckResult represents the results of a call to `ResourceProvider.check`. Any validation failures that occurred.

-property inputs +property inputs

inputs?: Inputs;
@@ -153,7 +153,7 @@ Any validation failures that occurred. The inputs to use, if any.

- + interface CreateResult

@@ -163,7 +163,7 @@ The inputs to use, if any. CreateResult represents the results of a call to `ResourceProvider.create`.

-property id +property id

id: resource.ID;
@@ -171,7 +171,7 @@ CreateResult represents the results of a call to `ResourceProvider.create`. The ID of the created resource.

-property outs +property outs

outs?: Outputs;
@@ -179,7 +179,7 @@ The ID of the created resource. Any properties that were computed during creation.

- + interface DiffResult

@@ -189,7 +189,7 @@ Any properties that were computed during creation. DiffResult represents the results of a call to `ResourceProvider.diff`.

-property changes +property changes

changes?: undefined | false | true;
@@ -197,7 +197,7 @@ DiffResult represents the results of a call to `ResourceProvider.diff`. If true, this diff detected changes and suggests an update.

-property deleteBeforeReplace +property deleteBeforeReplace

deleteBeforeReplace?: undefined | false | true;
@@ -206,7 +206,7 @@ If true, and a replacement occurs, the resource will first be deleted before bei void potential side-by-side issues with the default create before delete behavior.

-property replaces +property replaces

replaces?: string[];
@@ -214,7 +214,7 @@ void potential side-by-side issues with the default create before delete behavio If this update requires a replacement, the set of properties triggering it.

-property stables +property stables

stables?: string[];
@@ -222,14 +222,14 @@ If this update requires a replacement, the set of properties triggering it. An optional list of properties that will not ever change.

- + interface ReadResult

interface ReadResult

-property id +property id

id?: resource.ID;
@@ -237,7 +237,7 @@ An optional list of properties that will not ever change. The ID of the resource ready back (or blank if missing).

-property props +property props

props?: Outputs;
@@ -245,7 +245,7 @@ The ID of the resource ready back (or blank if missing). The current property state read from the live environment.

- + interface ResourceProvider

@@ -255,7 +255,7 @@ The current property state read from the live environment. ResourceProvider represents an object that provides CRUD operations for a particular type of resource.

-property check +property check

check?: undefined | (olds: Inputs, news: Inputs) => Promise<CheckResult<Inputs>>;
@@ -263,7 +263,7 @@ ResourceProvider represents an object that provides CRUD operations for a partic Check validates that the given property bag is valid for a resource of the given type.

-property create +property create

create: (inputs: Inputs) => Promise<CreateResult<Outputs>>;
@@ -272,7 +272,7 @@ Create allocates a new instance of the provided resource and returns its unique If this call fails, the resource must not have been created (i.e., it is "transactional").

-property delete +property delete

delete?: undefined | (id: resource.ID, props: Outputs) => Promise<void>;
@@ -280,7 +280,7 @@ If this call fails, the resource must not have been created (i.e., it is "transa Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.

-property diff +property diff

diff?: undefined | (id: resource.ID, olds: Outputs, news: Inputs) => Promise<DiffResult>;
@@ -288,7 +288,7 @@ Delete tears down an existing resource with the given ID. If it fails, the reso Diff checks what impacts a hypothetical update will have on the resource's properties.

-property read +property read

read?: undefined | (id: resource.ID, props?: Outputs) => Promise<ReadResult<Outputs>>;
@@ -297,7 +297,7 @@ Reads the current live state associated with a resource. Enough state must be i identify the resource; this is typically just the resource ID, but it may also include some properties.

-property update +property update

update?: undefined | (id: resource.ID, olds: Outputs, news: Inputs) => Promise<UpdateResult<Outputs>>;
@@ -305,7 +305,7 @@ identify the resource; this is typically just the resource ID, but it may also i Update updates an existing resource with new values.

- + interface UpdateResult

@@ -315,7 +315,7 @@ Update updates an existing resource with new values. UpdateResult represents the results of a call to `ResourceProvider.update`.

-property outs +property outs

outs?: Outputs;
diff --git a/content/docs/reference/pkg/nodejs/pulumi/pulumi/iterable/_index.md b/content/docs/reference/pkg/nodejs/pulumi/pulumi/iterable/_index.md index a4dc129e2cc3..f26abe2a5cfa 100644 --- a/content/docs/reference/pkg/nodejs/pulumi/pulumi/iterable/_index.md +++ b/content/docs/reference/pkg/nodejs/pulumi/pulumi/iterable/_index.md @@ -3,7 +3,7 @@ title: "Module iterable" title_tag: "Module iterable | Package @pulumi/pulumi | Node.js SDK" linktitle: "iterable" meta_desc: "Explore members of the iterable module in the @pulumi/pulumi package." -git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" +git_sha: "ae0bc5013b5ecba279abc534f37a4398a859248a" --- @@ -27,7 +27,7 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9"

APIs

- + function groupBy

@@ -50,7 +50,7 @@ and whose selector is roughly `(e) => [e.s, e.n]`, the resulting object will be

- + function toObject

diff --git a/content/docs/reference/pkg/nodejs/pulumi/pulumi/log/_index.md b/content/docs/reference/pkg/nodejs/pulumi/pulumi/log/_index.md index e0059aa3afbb..92c2d77751bb 100644 --- a/content/docs/reference/pkg/nodejs/pulumi/pulumi/log/_index.md +++ b/content/docs/reference/pkg/nodejs/pulumi/pulumi/log/_index.md @@ -3,7 +3,7 @@ title: "Module log" title_tag: "Module log | Package @pulumi/pulumi | Node.js SDK" linktitle: "log" meta_desc: "Explore members of the log module in the @pulumi/pulumi package." -git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" +git_sha: "ae0bc5013b5ecba279abc534f37a4398a859248a" --- @@ -30,7 +30,7 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9"

APIs

- + function debug

@@ -42,7 +42,7 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" debug logs a debug-level message that is generally hidden from end-users.

- + function error

@@ -54,7 +54,7 @@ debug logs a debug-level message that is generally hidden from end-users. error logs a fatal condition. Consider raising an exception after calling error to stop the Pulumi program.

- + function hasErrors

@@ -66,7 +66,7 @@ error logs a fatal condition. Consider raising an exception after calling error hasErrors returns true if any errors have occurred in the program.

- + function info

@@ -78,7 +78,7 @@ hasErrors returns true if any errors have occurred in the program. info logs an informational message that is generally printed to stdout during resource operations.

- + function warn

diff --git a/content/docs/reference/pkg/nodejs/pulumi/pulumi/provider/_index.md b/content/docs/reference/pkg/nodejs/pulumi/pulumi/provider/_index.md index 54a92320589b..edb03e062f64 100644 --- a/content/docs/reference/pkg/nodejs/pulumi/pulumi/provider/_index.md +++ b/content/docs/reference/pkg/nodejs/pulumi/pulumi/provider/_index.md @@ -3,7 +3,7 @@ title: "Module provider" title_tag: "Module provider | Package @pulumi/pulumi | Node.js SDK" linktitle: "provider" meta_desc: "Explore members of the provider module in the @pulumi/pulumi package." -git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" +git_sha: "ae0bc5013b5ecba279abc534f37a4398a859248a" --- @@ -35,7 +35,7 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9"

APIs

- + interface CheckFailure

@@ -45,7 +45,7 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" CheckFailure represents a single failure in the results of a call to `ResourceProvider.check`

-property property +property property

property: string;
@@ -53,7 +53,7 @@ CheckFailure represents a single failure in the results of a call to `ResourcePr The property that failed validation.

-property reason +property reason

reason: string;
@@ -61,7 +61,7 @@ The property that failed validation. The reason that the property failed validation.

- + interface CheckResult

@@ -71,7 +71,7 @@ The reason that the property failed validation. CheckResult represents the results of a call to `ResourceProvider.check`.

-property failures +property failures

failures?: CheckFailure[];
@@ -79,7 +79,7 @@ CheckResult represents the results of a call to `ResourceProvider.check`. Any validation failures that occurred.

-property inputs +property inputs

inputs?: any;
@@ -87,7 +87,7 @@ Any validation failures that occurred. The inputs to use, if any.

- + interface ConstructResult

@@ -97,7 +97,7 @@ The inputs to use, if any. ConstructResult represents the results of a call to `ResourceProvider.construct`.

-property state +property state

state: Inputs;
@@ -105,7 +105,7 @@ ConstructResult represents the results of a call to `ResourceProvider.construct` Any state that was computed during construction.

-property urn +property urn

urn: Input<resource.URN>;
@@ -113,7 +113,7 @@ Any state that was computed during construction. The URN of the constructed resource.

- + interface CreateResult

@@ -123,7 +123,7 @@ The URN of the constructed resource. CreateResult represents the results of a call to `ResourceProvider.create`.

-property id +property id

id: resource.ID;
@@ -131,7 +131,7 @@ CreateResult represents the results of a call to `ResourceProvider.create`. The ID of the created resource.

-property outs +property outs

outs?: any;
@@ -139,7 +139,7 @@ The ID of the created resource. Any properties that were computed during creation.

- + interface DiffResult

@@ -149,7 +149,7 @@ Any properties that were computed during creation. DiffResult represents the results of a call to `ResourceProvider.diff`.

-property changes +property changes

changes?: undefined | false | true;
@@ -157,7 +157,7 @@ DiffResult represents the results of a call to `ResourceProvider.diff`. If true, this diff detected changes and suggests an update.

-property deleteBeforeReplace +property deleteBeforeReplace

deleteBeforeReplace?: undefined | false | true;
@@ -166,7 +166,7 @@ If true, and a replacement occurs, the resource will first be deleted before bei avoid potential side-by-side issues with the default create before delete behavior.

-property replaces +property replaces

replaces?: string[];
@@ -174,7 +174,7 @@ avoid potential side-by-side issues with the default create before delete behavi If this update requires a replacement, the set of properties triggering it.

-property stables +property stables

stables?: string[];
@@ -182,7 +182,7 @@ If this update requires a replacement, the set of properties triggering it. An optional list of properties that will not ever change.

- + interface InvokeResult

@@ -192,7 +192,7 @@ An optional list of properties that will not ever change. InvokeResult represents the results of a call to `ResourceProvider.invoke`.

-property failures +property failures

failures?: CheckFailure[];
@@ -200,7 +200,7 @@ InvokeResult represents the results of a call to `ResourceProvider.invoke`. Any validation failures that occurred.

-property outputs +property outputs

outputs?: any;
@@ -208,7 +208,7 @@ Any validation failures that occurred. The outputs returned by the invoked function, if any.

- + function main

@@ -217,7 +217,7 @@ The outputs returned by the invoked function, if any.
main(provider: Provider, args: string[]): Promise<void>

- + interface Provider

@@ -227,7 +227,7 @@ The outputs returned by the invoked function, if any. Provider represents an object that implements the resources and functions for a particular Pulumi package.

-property call +property call

call?: undefined | (token: string, inputs: Inputs) => Promise<InvokeResult>;
@@ -235,7 +235,7 @@ Provider represents an object that implements the resources and functions for a Call calls the indicated method.

-property check +property check

check?: undefined | (urn: resource.URN, olds: any, news: any) => Promise<CheckResult>;
@@ -243,7 +243,7 @@ Call calls the indicated method. Check validates that the given property bag is valid for a resource of the given type.

-property construct +property construct

construct?: undefined | (name: string, type: string, inputs: Inputs, options: ComponentResourceOptions) => Promise<ConstructResult>;
@@ -251,7 +251,7 @@ Check validates that the given property bag is valid for a resource of the given Construct creates a new component resource.

-property create +property create

create?: undefined | (urn: resource.URN, inputs: any) => Promise<CreateResult>;
@@ -260,7 +260,7 @@ Create allocates a new instance of the provided resource and returns its unique If this call fails, the resource must not have been created (i.e., it is "transactional").

-property delete +property delete

delete?: undefined | (id: resource.ID, urn: resource.URN, props: any) => Promise<void>;
@@ -268,7 +268,7 @@ If this call fails, the resource must not have been created (i.e., it is "transa Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.

-property diff +property diff

diff?: undefined | (id: resource.ID, urn: resource.URN, olds: any, news: any) => Promise<DiffResult>;
@@ -276,7 +276,7 @@ Delete tears down an existing resource with the given ID. If it fails, the reso Diff checks what impacts a hypothetical update will have on the resource's properties.

-property invoke +property invoke

invoke?: undefined | (token: string, inputs: any) => Promise<InvokeResult>;
@@ -284,7 +284,7 @@ Diff checks what impacts a hypothetical update will have on the resource's prope Invoke calls the indicated function.

-property read +property read

read?: undefined | (id: resource.ID, urn: resource.URN, props?: any) => Promise<ReadResult>;
@@ -293,7 +293,7 @@ Reads the current live state associated with a resource. Enough state must be i identify the resource; this is typically just the resource ID, but it may also include some properties.

-property schema +property schema

schema?: undefined | string;
@@ -301,7 +301,7 @@ identify the resource; this is typically just the resource ID, but it may also i The JSON-encoded schema for this provider's package.

-property update +property update

update?: undefined | (id: resource.ID, urn: resource.URN, olds: any, news: any) => Promise<UpdateResult>;
@@ -309,7 +309,7 @@ The JSON-encoded schema for this provider's package. Update updates an existing resource with new values.

-property version +property version

version: string;
@@ -317,14 +317,14 @@ Update updates an existing resource with new values. The version of the provider. Must be valid semver.

- + interface ReadResult

interface ReadResult

-property id +property id

id?: resource.ID;
@@ -332,7 +332,7 @@ The version of the provider. Must be valid semver. The ID of the resource ready back (or blank if missing).

-property props +property props

props?: any;
@@ -340,7 +340,7 @@ The ID of the resource ready back (or blank if missing). The current property state read from the live environment.

- + interface UpdateResult

@@ -350,7 +350,7 @@ The current property state read from the live environment. UpdateResult represents the results of a call to `ResourceProvider.update`.

-property outs +property outs

outs?: any;
diff --git a/content/docs/reference/pkg/nodejs/pulumi/pulumi/runtime/_index.md b/content/docs/reference/pkg/nodejs/pulumi/pulumi/runtime/_index.md index 91cca76d47b1..4b930983dd26 100644 --- a/content/docs/reference/pkg/nodejs/pulumi/pulumi/runtime/_index.md +++ b/content/docs/reference/pkg/nodejs/pulumi/pulumi/runtime/_index.md @@ -3,7 +3,7 @@ title: "Module runtime" title_tag: "Module runtime | Package @pulumi/pulumi | Node.js SDK" linktitle: "runtime" meta_desc: "Explore members of the runtime module in the @pulumi/pulumi package." -git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" +git_sha: "ae0bc5013b5ecba279abc534f37a4398a859248a" --- @@ -109,7 +109,7 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9"

Resources

- + Resource Stack

@@ -120,14 +120,14 @@ Stack is the root resource for a Pulumi stack. Before invoking the `init` callba resource with the Pulumi engine.

- constructor + constructor

new Stack(init: () => Promise<Inputs>)

-method getData +method getData

@@ -138,14 +138,14 @@ Retrieves the data produces by [initialize]. The data is immediately available derived class's constructor after the `super(...)` call to `ComponentResource`.

-method getProvider +method getProvider

public getProvider(moduleMember: string): ProviderResource | undefined

-method initialize +method initialize

@@ -158,7 +158,7 @@ runInit invokes the given init callback with this resource set as the root resou used as the stack's output properties.

-method isInstance +method isInstance

@@ -169,7 +169,7 @@ Returns true if the given object is an instance of CustomResource. This is desi multiple copies of the Pulumi SDK have been loaded into the same process.

-method registerOutputs +method registerOutputs

@@ -184,7 +184,7 @@ done creating child resources. This is not strictly necessary as this will auto called after the `initialize` method completes.

-property outputs +property outputs

public outputs: Output<Inputs>;
@@ -192,7 +192,7 @@ called after the `initialize` method completes. The outputs of this stack, if the `init` callback exited normally.

-property urn +property urn

public urn: Output<URN>;
@@ -204,7 +204,7 @@ deployments.

Others

- + function allConfig

@@ -216,7 +216,7 @@ deployments. allConfig returns a copy of the full config map.

- + function cacheDynamicProviders

@@ -228,7 +228,7 @@ allConfig returns a copy of the full config map. Returns true (default) if we will cache serialized dynamic providers on the program side

- + function call

@@ -240,7 +240,7 @@ Returns true (default) if we will cache serialized dynamic providers on the prog `call` dynamically calls the function, `tok`, which is offered by a provider plugin.

- + function deserializeProperties

@@ -252,7 +252,7 @@ Returns true (default) if we will cache serialized dynamic providers on the prog deserializeProperties fetches the raw outputs and deserializes them from a gRPC call result.

- + function deserializeProperty

@@ -264,7 +264,7 @@ deserializeProperties fetches the raw outputs and deserializes them from a gRPC deserializeProperty unpacks some special types, reversing the above process.

- + function disconnect

@@ -277,7 +277,7 @@ disconnect permanently disconnects from the server, closing the connections. It queue to drain. If any RPCs come in afterwards, however, they will crash the process.

- + function disconnectSync

@@ -290,7 +290,7 @@ disconnectSync permanently disconnects from the server, closing the connections. wait for the existing RPC queue to drain. Any RPCs that come in after this call will crash the process.

- + const excessiveDebugOutput

@@ -300,7 +300,7 @@ wait for the existing RPC queue to drain. Any RPCs that come in after this call excessiveDebugOutput enables, well, pretty excessive debug output pertaining to resources and properties.

- + function getConfig

@@ -312,7 +312,7 @@ excessiveDebugOutput enables, well, pretty excessive debug output pertaining to getConfig returns a configuration variable's value or undefined if it is unset.

- + function getEngine

@@ -324,7 +324,7 @@ getConfig returns a configuration variable's value or undefined if it is unset. getEngine returns the current engine, if any, for RPC communications back to the resource engine.

- + function getMaximumListeners

@@ -336,7 +336,7 @@ getEngine returns the current engine, if any, for RPC communications back to the getMaximumListeners returns the configured number of process listeners available

- + function getMonitor

@@ -348,7 +348,7 @@ getMaximumListeners returns the configured number of process listeners available getMonitor returns the current resource monitoring service client for RPC communications.

- + function getOrganization

@@ -360,7 +360,7 @@ getMonitor returns the current resource monitoring service client for RPC commun Get the organization being run by the current update.

- + function getProject

@@ -372,7 +372,7 @@ Get the organization being run by the current update. Get the project being run by the current update.

- + function getResource

@@ -384,7 +384,7 @@ Get the project being run by the current update. Get an existing resource's state from the engine.

- + function getResourceModule

@@ -393,7 +393,7 @@ Get an existing resource's state from the engine.
getResourceModule(pkg: string, mod: string, version: string): ResourceModule | undefined

- + function getResourcePackage

@@ -402,7 +402,7 @@ Get an existing resource's state from the engine.
getResourcePackage(pkg: string, version: string): ResourcePackage | undefined

- + function getStack

@@ -414,7 +414,7 @@ Get an existing resource's state from the engine. Get the stack being targeted by the current update.

- + function getStackResource

@@ -423,7 +423,7 @@ Get the stack being targeted by the current update.
getStackResource(): Stack | undefined

- + function hasEngine

@@ -435,7 +435,7 @@ Get the stack being targeted by the current update. hasEngine returns true if we are currently connected to an engine.

- + function hasMonitor

@@ -447,7 +447,7 @@ hasEngine returns true if we are currently connected to an engine. hasMonitor returns true if we are currently connected to a resource monitoring service.

- + function invoke

@@ -490,7 +490,7 @@ All of these contain async values that would prevent `invoke from being able to synchronously.

- + function invokeSingle

@@ -499,7 +499,7 @@ synchronously.
invokeSingle(tok: string, props: Inputs, opts: InvokeOptions): Promise<any>

- + function isDryRun

@@ -513,7 +513,7 @@ Returns whether or not we are currently doing a preview. When writing unit tests, you can set this flag via either `setMocks` or `_setIsDryRun`.

- + function isLegacyApplyEnabled

@@ -525,7 +525,7 @@ When writing unit tests, you can set this flag via either `setMocks` or `_setIsD Returns true if we will resolve missing outputs to inputs during preview (PULUMI_ENABLE_LEGACY_APPLY).

- + function isQueryMode

@@ -537,7 +537,7 @@ Returns true if we will resolve missing outputs to inputs during preview (PULUMI Returns true if query mode is enabled.

- + function isRpcSecret

@@ -549,7 +549,7 @@ Returns true if query mode is enabled. isRpcSecret returns true if obj is a wrapped secret value (i.e. it's an object with the special key set).

- + function listResourceOutputs

@@ -563,7 +563,7 @@ cannot be found. Resources are retrieved from the latest stack snapshot, which m ongoing updates.

- + interface MockCallArgs

@@ -573,7 +573,7 @@ ongoing updates. MockResourceArgs is used to construct call Mock.

-property inputs +property inputs

inputs: any;
@@ -581,7 +581,7 @@ MockResourceArgs is used to construct call Mock. The arguments provided to the function call.

-property provider +property provider

provider?: undefined | string;
@@ -589,7 +589,7 @@ The arguments provided to the function call. If provided, the identifier of the provider instance being used to make the call.

-property token +property token

token: string;
@@ -597,7 +597,7 @@ If provided, the identifier of the provider instance being used to make the call The token that indicates which function is being called. This token is of the form "package:module:function".

- + type MockCallResult

@@ -607,61 +607,61 @@ The token that indicates which function is being called. This token is of the fo MockCallResult is the result of a call Mock.

- + class MockMonitor

class MockMonitor

- constructor + constructor

new MockMonitor(mocks: Mocks)

-method invoke +method invoke

public invoke(req: any, callback: (err: any, innerResponse: any) => void): Promise<void>

-method readResource +method readResource

public readResource(req: any, callback: (err: any, innterResponse: any) => void): Promise<void>

-method registerResource +method registerResource

public registerResource(req: any, callback: (err: any, innerResponse: any) => void): Promise<void>

-method registerResourceOutputs +method registerResourceOutputs

public registerResourceOutputs(req: any, callback: (err: any, innerResponse: any) => void): void

-method supportsFeature +method supportsFeature

public supportsFeature(req: any, callback: (err: any, innerResponse: any) => void): void

-property mocks +property mocks

mocks: Mocks;

-property resources +property resources

resources: Map<string, {
@@ -670,7 +670,7 @@ MockCallResult is the result of a call Mock.
     urn: string;
 }> = new Map<string, { urn: string; id: string | undefined; state: any }>();

- + interface MockResourceArgs

@@ -680,7 +680,7 @@ MockCallResult is the result of a call Mock. MockResourceArgs is used to construct a newResource Mock.

-property custom +property custom

custom?: undefined | false | true;
@@ -688,7 +688,7 @@ MockResourceArgs is used to construct a newResource Mock. Specifies whether or not the resource is Custom (i.e. managed by a resource provider).

-property id +property id

id?: undefined | string;
@@ -696,7 +696,7 @@ Specifies whether or not the resource is Custom (i.e. managed by a resource prov If provided, the physical identifier of an existing resource to read or import.

-property inputs +property inputs

inputs: any;
@@ -704,7 +704,7 @@ If provided, the physical identifier of an existing resource to read or import. The inputs for the resource.

-property name +property name

name: string;
@@ -712,7 +712,7 @@ The inputs for the resource. The logical name of the resource instance.

-property provider +property provider

provider?: undefined | string;
@@ -720,7 +720,7 @@ The logical name of the resource instance. If provided, the identifier of the provider instance being used to manage this resource.

-property type +property type

type: string;
@@ -728,7 +728,7 @@ If provided, the identifier of the provider instance being used to manage this r The token that indicates which resource type is being constructed. This token is of the form "package:module:type".

- + type MockResourceResult

@@ -742,7 +742,7 @@ MockResourceResult is the result of a newResource Mock, returning a physical ide for the resource being constructed.

- + interface Mocks

@@ -754,7 +754,7 @@ their own implementations. This can be used during testing to ensure that calls return predictable values.

-method call +method call

@@ -764,7 +764,7 @@ return predictable values. Mocks provider-implemented function calls (e.g. aws.get_availability_zones).

-method newResource +method newResource

@@ -775,7 +775,7 @@ Mocks resource construction calls. This function should return the physical iden for the resource being constructed.

- + function monitorSupportsDeletedWith

@@ -788,7 +788,7 @@ monitorSupportsDeletedWith returns a promise that when resolved tells you if the connected to is able to support the deletedWith resource option across its RPC interface.

- + function monitorSupportsFeature

@@ -801,7 +801,7 @@ monitorSupportsFeature returns a promise that when resolved tells you if the res to is able to support a particular feature.

- + function monitorSupportsOutputValues

@@ -815,7 +815,7 @@ connected to is able to support output values across its RPC interface. When it in a special way.

- + function monitorSupportsResourceReferences

@@ -829,7 +829,7 @@ connected to is able to support resource references across its RPC interface. Wh in a special way.

- + function monitorSupportsSecrets

@@ -843,7 +843,7 @@ to is able to support secrets across its RPC interface. When it does, we marshal bit in a special way.

- + interface Options

@@ -853,57 +853,57 @@ bit in a special way. Options is a bag of settings that controls the behavior of previews and deployments

-property cacheDynamicProviders +property cacheDynamicProviders

cacheDynamicProviders?: undefined | false | true;

-property dryRun +property dryRun

dryRun?: undefined | false | true;

-property engineAddr +property engineAddr

engineAddr?: undefined | string;

-property legacyApply +property legacyApply

legacyApply?: undefined | false | true;

-property monitorAddr +property monitorAddr

monitorAddr?: undefined | string;

-property organization +property organization

organization?: undefined | string;

-property parallel +property parallel

parallel?: undefined | number;

-property project +property project

project?: undefined | string;

-property queryMode +property queryMode

queryMode?: undefined | false | true;

-property stack +property stack

stack?: undefined | string;

-property syncDir +property syncDir

syncDir?: undefined | string;
@@ -911,19 +911,19 @@ Options is a bag of settings that controls the behavior of previews and deployme Directory containing the send/receive files for making synchronous invokes to the engine.

-property testModeEnabled +property testModeEnabled

testModeEnabled?: undefined | false | true;

- + type OutputResolvers

type OutputResolvers = Record<string, (value: any, isStable: boolean, isSecret: boolean, deps?: Resource[], err?: Error) => void>;

- + function readResource

@@ -936,7 +936,7 @@ Reads an existing custom resource's state from the resource monitor. Note that will not be part of the resulting stack's state, as they are presumed to belong to another.

- + function registerResource

@@ -950,7 +950,7 @@ URN and the ID that will resolve after the deployment has completed. All proper objects that the registration operation will resolve at the right time (or remain unresolved for deployments).

- + function registerResourceModule

@@ -963,7 +963,7 @@ registerResourceModule registers a resource module that will be used to construc the module name and version that are deserialized by the current instance of the Pulumi JavaScript SDK.

- + function registerResourceOutputs

@@ -975,7 +975,7 @@ the module name and version that are deserialized by the current instance of the registerResourceOutputs completes the resource registration, attaching an optional set of computed outputs.

- + function registerResourcePackage

@@ -988,7 +988,7 @@ registerResourcePackage registers a resource package that will be used to constr the package name and version that are deserialized by the current instance of the Pulumi JavaScript SDK.

- + function registerStackTransformation

@@ -1000,7 +1000,7 @@ the package name and version that are deserialized by the current instance of th Add a transformation to all future resources constructed in this Pulumi stack.

- + function resetOptions

@@ -1009,7 +1009,7 @@ Add a transformation to all future resources constructed in this Pulumi stack.
resetOptions(project: string, stack: string, parallel: number, engineAddr: string, monitorAddr: string, preview: boolean, organization: string): void

- + function resolveProperties

@@ -1026,7 +1026,7 @@ output properties to work correctly w.r.t. knowns/unknowns: this function assume `allProps`represents an unknown value that was returned by an engine operation.

- + interface ResourceModule

@@ -1036,19 +1036,19 @@ output properties to work correctly w.r.t. knowns/unknowns: this function assume A ResourceModule is a type that understands how to construct resources given a name, type, args, and URN.

-method construct +method construct

construct(name: string, type: string, urn: string): Resource

-property version +property version

version?: undefined | string;

- + interface ResourcePackage

@@ -1058,19 +1058,19 @@ A ResourceModule is a type that understands how to construct resources given a n A ResourcePackage is a type that understands how to construct resource providers given a name, type, args, and URN.

-method constructProvider +method constructProvider

constructProvider(name: string, type: string, urn: string): ProviderResource

-property version +property version

version?: undefined | string;

- + const rootPulumiStackTypeName

@@ -1082,7 +1082,7 @@ resources allocated by a deployment. This must be kept up to date with `github.com/pulumi/pulumi/sdk/v3/go/common/resource/stack.RootStackType`.

- + function rpcKeepAlive

@@ -1095,7 +1095,7 @@ rpcKeepAlive registers a pending call to ensure that we don't prematurely discon a function that, when invoked, signals that the RPC has completed.

- + function runInPulumiStack

@@ -1108,7 +1108,7 @@ runInPulumiStack creates a new Pulumi stack resource and executes the callback i returned by the callback will be stored as output properties on this resulting Stack object.

- + interface SerializationOptions

@@ -1118,7 +1118,7 @@ returned by the callback will be stored as output properties on this resulting S Controls the serialization of RPC structures.

-property keepOutputValues +property keepOutputValues

keepOutputValues?: undefined | false | true;
@@ -1127,7 +1127,7 @@ 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.

- + function serialize

@@ -1139,7 +1139,7 @@ If the monitor does not support output values, they will not be kept, even when serialize returns true if resource operations should be serialized.

- + function serializeProperties

@@ -1152,7 +1152,7 @@ serializeProperties walks the props object passed in, awaiting all interior prom POJO object that can be remoted over to registerResource.

- + function serializeProperty

@@ -1165,7 +1165,7 @@ serializeProperty serializes properties deeply. This understands how to wait on appropriate, in addition to translating certain "special" values so that they are ready to go on the wire.

- + function serializeResourceProperties

@@ -1178,7 +1178,7 @@ serializeResourceProperties walks the props object passed in, awaiting all inter and `urn`, creating a reasonable POJO object that can be remoted over to registerResource.

- + function setAllConfig

@@ -1190,7 +1190,7 @@ and `urn`, creating a reasonable POJO object that can be remoted over to registe setAllConfig overwrites the config map.

- + function setConfig

@@ -1202,7 +1202,7 @@ setAllConfig overwrites the config map. setConfig sets a configuration variable.

- + function setMockOptions

@@ -1211,7 +1211,7 @@ setConfig sets a configuration variable.
setMockOptions(mockMonitor: any, project?: undefined | string, stack?: undefined | string, preview?: undefined | false | true, organization?: undefined | string): void

- + function setMocks

@@ -1223,7 +1223,7 @@ setConfig sets a configuration variable. setMocks configures the Pulumi runtime to use the given mocks for testing.

- + function setRootResource

@@ -1235,29 +1235,29 @@ setMocks configures the Pulumi runtime to use the given mocks for testing. setRootResource registers a resource that will become the default parent for all resources without explicit parents.

- + interface SourcePosition

interface SourcePosition

-property column +property column

column: number;

-property line +property line

line: number;

-property uri +property uri

uri: string;

- + const specialArchiveSig

@@ -1267,7 +1267,7 @@ setRootResource registers a resource that will become the default parent for all specialArchiveSig is a randomly assigned hash used to identify archives in maps. See sdk/go/common/resource/asset.go.

- + const specialAssetSig

@@ -1277,7 +1277,7 @@ specialArchiveSig is a randomly assigned hash used to identify archives in maps. specialAssetSig is a randomly assigned hash used to identify assets in maps. See sdk/go/common/resource/asset.go.

- + const specialOutputValueSig

@@ -1288,7 +1288,7 @@ specialOutputValueSig is a randomly assigned hash used to identify outputs in ma See sdk/go/common/resource/properties.go.

- + const specialResourceSig

@@ -1299,7 +1299,7 @@ specialResourceSig is a randomly assigned hash used to identify resources in map See sdk/go/common/resource/properties.go.

- + const specialSecretSig

@@ -1310,7 +1310,7 @@ specialSecretSig is a randomly assigned hash used to identify secrets in maps. See sdk/go/common/resource/properties.go.

- + const specialSigKey

@@ -1320,7 +1320,7 @@ See sdk/go/common/resource/properties.go. specialSigKey is sometimes used to encode type identity inside of a map. See sdk/go/common/resource/properties.go.

- + function streamInvoke

@@ -1329,35 +1329,35 @@ specialSigKey is sometimes used to encode type identity inside of a map. See sdk
streamInvoke(tok: string, props: Inputs, opts: InvokeOptions): Promise<StreamInvokeResponse<any>>

- + class StreamInvokeResponse

 implements AsyncIterable<T>

- constructor + constructor

new StreamInvokeResponse(source: AsyncIterable<T>, cancelSource: () => void)

-method [Symbol.asyncIterator] +method [Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncIterator<T>

-method cancel +method cancel

public cancel(): void

- + function suppressUnhandledGrpcRejections

@@ -1370,7 +1370,7 @@ suppressUnhandledGrpcRejections silences any unhandled promise rejections that o promise may still be rejected.

- + function terminateRpcs

@@ -1379,7 +1379,7 @@ promise may still be rejected.
terminateRpcs(): void

- + function transferProperties

@@ -1400,7 +1400,7 @@ that the engine actualy produced will be used to resolve all the unresolved prom 'onto'.

- + const unknownValue

@@ -1410,7 +1410,7 @@ that the engine actualy produced will be used to resolve all the unresolved prom Unknown values are encoded as a distinguished string value.

- + function unwrapRpcSecret

diff --git a/content/docs/reference/pkg/nodejs/pulumi/pulumi/runtime/closure/_index.md b/content/docs/reference/pkg/nodejs/pulumi/pulumi/runtime/closure/_index.md index 20f9e3fa0ebf..db7aecf177bb 100644 --- a/content/docs/reference/pkg/nodejs/pulumi/pulumi/runtime/closure/_index.md +++ b/content/docs/reference/pkg/nodejs/pulumi/pulumi/runtime/closure/_index.md @@ -3,7 +3,7 @@ title: "Module runtime/closure" title_tag: "Module runtime/closure | Package @pulumi/pulumi | Node.js SDK" linktitle: "closure" meta_desc: "Explore members of the closure module in the @pulumi/pulumi package." -git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" +git_sha: "ae0bc5013b5ecba279abc534f37a4398a859248a" --- @@ -32,24 +32,24 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9"

APIs

- + interface ClosureInfo

interface ClosureInfo

-property containsSecrets +property containsSecrets

containsSecrets: boolean;

-property func +property func

func: FunctionInfo;

- + interface CodePathOptions

@@ -59,7 +59,7 @@ git_sha: "e509307b2e46f172a29a6cbb53aea0e23d92f2d9" Options for controlling what gets returned by [computeCodePaths].

-property extraExcludePackages +property extraExcludePackages

extraExcludePackages?: string[];
@@ -70,7 +70,7 @@ ever actually be needed at runtime, but is still a dependency of some package th used at runtime.

-property extraIncludePackages +property extraIncludePackages

extraIncludePackages?: string[];
@@ -81,7 +81,7 @@ For example, if there was some sort of module that was pulled in based off of a string.

-property extraIncludePaths +property extraIncludePaths

extraIncludePaths?: string[];
@@ -90,7 +90,7 @@ Local file/directory paths that we always want to include when producing the Ass included for a serialized closure.

-property logResource +property logResource

logResource?: Resource;
@@ -98,7 +98,7 @@ included for a serialized closure. The resource to log any errors we encounter against.

- + function computeCodePaths

@@ -134,7 +134,7 @@ Use the [computeCodePaths] overload that takes a [CodePathOptions] instead.
computeCodePaths(extraIncludePaths?: string[], extraIncludePackages?: string[], extraExcludePackages?: string[]): Promise<Map<string, Asset | Archive>>

- + interface SerializedFunction

@@ -144,7 +144,7 @@ Use the [computeCodePaths] overload that takes a [CodePathOptions] instead. SerializeFunction is a representation of a serialized JavaScript function.

-property containsSecrets +property containsSecrets

containsSecrets: boolean;
@@ -152,7 +152,7 @@ SerializeFunction is a representation of a serialized JavaScript function. True if the serialized function text includes serialization of secret

-property exportName +property exportName

exportName: string;
@@ -160,7 +160,7 @@ True if the serialized function text includes serialization of secret The name of the exported module member.

-property text +property text

text: string;
@@ -170,7 +170,7 @@ In the case of a normal function, this value will just be serialized function. of a factory function this value will be the result of invoking the factory function.

- + function serializeFunction

@@ -193,7 +193,7 @@ There are several known limitations: function.

- + interface SerializeFunctionArgs

@@ -203,7 +203,7 @@ There are several known limitations: SerializeFunctionArgs are arguments used to serialize a JavaScript function

-property allowSecrets +property allowSecrets

allowSecrets?: undefined | false | true;
@@ -214,7 +214,7 @@ or serializing it to any other output format. If set, the `containsSecrets` prop SerializedFunction object will indicate whether secrets were serialized into the function text.

-property exportName +property exportName

exportName?: undefined | string;
@@ -222,7 +222,7 @@ SerializedFunction object will indicate whether secrets were serialized into the The name to export from the module defined by the generated module text. Defaults to 'handler'.

-property isFactoryFunction +property isFactoryFunction

isFactoryFunction?: undefined | false | true;
@@ -237,7 +237,7 @@ In other words, the function will be invoked (once) and the resulting inner func be what is exported.

-property logResource +property logResource

logResource?: Resource;
@@ -245,7 +245,7 @@ be what is exported. The resource to log any errors we encounter against.

-property serialize +property serialize

serialize?: undefined | (o: any) => boolean;
@@ -254,7 +254,7 @@ A function to prevent serialization of certain objects captured during the seria prevent potential cycles.

- + function serializeFunctionAsync

diff --git a/data/versions.json b/data/versions.json index dc417c76edf0..68eccac88dee 100644 --- a/data/versions.json +++ b/data/versions.json @@ -1,4 +1,17 @@ [ + { + "version": "v3.84.0", + "date": "2023-09-19T20:03:43Z", + "downloads": { + "linux-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.84.0-linux-x64.tar.gz", + "linux-arm64": "https://get.pulumi.com/releases/sdk/pulumi-v3.84.0-linux-arm64.tar.gz", + "darwin-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.84.0-darwin-x64.tar.gz", + "darwin-arm64": "https://get.pulumi.com/releases/sdk/pulumi-v3.84.0-darwin-arm64.tar.gz", + "windows-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.84.0-windows-x64.zip" + }, + "checksums": "https://get.pulumi.com/releases/sdk/pulumi-3.84.0-checksums.txt", + "latest": true + }, { "version": "v3.83.0", "date": "2023-09-15T21:39:33Z", @@ -9,8 +22,7 @@ "darwin-arm64": "https://get.pulumi.com/releases/sdk/pulumi-v3.83.0-darwin-arm64.tar.gz", "windows-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.83.0-windows-x64.zip" }, - "checksums": "https://get.pulumi.com/releases/sdk/pulumi-3.83.0-checksums.txt", - "latest": true + "checksums": "https://get.pulumi.com/releases/sdk/pulumi-3.83.0-checksums.txt" }, { "version": "v3.82.1", diff --git a/static/latest-version b/static/latest-version index 82f73dffbbe6..575dedb6d479 100644 --- a/static/latest-version +++ b/static/latest-version @@ -1 +1 @@ -3.83.0 \ No newline at end of file +3.84.0 \ No newline at end of file