From aff1ed9ed2f5088cc02f59df1b10fb1e77450e51 Mon Sep 17 00:00:00 2001 From: pulumi-bot Date: Wed, 7 May 2025 19:38:57 +0000 Subject: [PATCH] Regenerating docs for Pulumi@3.168.0 --- content/docs/iac/cli/commands/pulumi.md | 2 +- content/docs/iac/cli/commands/pulumi_about.md | 2 +- .../docs/iac/cli/commands/pulumi_about_env.md | 2 +- content/docs/iac/cli/commands/pulumi_ai.md | 2 +- .../docs/iac/cli/commands/pulumi_ai_web.md | 2 +- .../docs/iac/cli/commands/pulumi_cancel.md | 2 +- .../docs/iac/cli/commands/pulumi_config.md | 2 +- .../docs/iac/cli/commands/pulumi_config_cp.md | 2 +- .../iac/cli/commands/pulumi_config_env.md | 2 +- .../iac/cli/commands/pulumi_config_env_add.md | 2 +- .../cli/commands/pulumi_config_env_init.md | 2 +- .../iac/cli/commands/pulumi_config_env_ls.md | 2 +- .../iac/cli/commands/pulumi_config_env_rm.md | 2 +- .../iac/cli/commands/pulumi_config_get.md | 2 +- .../iac/cli/commands/pulumi_config_refresh.md | 2 +- .../iac/cli/commands/pulumi_config_rm-all.md | 2 +- .../docs/iac/cli/commands/pulumi_config_rm.md | 2 +- .../iac/cli/commands/pulumi_config_set-all.md | 2 +- .../iac/cli/commands/pulumi_config_set.md | 2 +- .../docs/iac/cli/commands/pulumi_console.md | 2 +- .../docs/iac/cli/commands/pulumi_convert.md | 2 +- .../docs/iac/cli/commands/pulumi_destroy.md | 2 +- content/docs/iac/cli/commands/pulumi_env.md | 2 +- .../docs/iac/cli/commands/pulumi_env_clone.md | 2 +- .../docs/iac/cli/commands/pulumi_env_diff.md | 2 +- .../docs/iac/cli/commands/pulumi_env_edit.md | 2 +- .../docs/iac/cli/commands/pulumi_env_get.md | 2 +- .../docs/iac/cli/commands/pulumi_env_init.md | 2 +- .../docs/iac/cli/commands/pulumi_env_ls.md | 2 +- .../docs/iac/cli/commands/pulumi_env_open.md | 2 +- .../docs/iac/cli/commands/pulumi_env_rm.md | 2 +- .../iac/cli/commands/pulumi_env_rotate.md | 2 +- .../docs/iac/cli/commands/pulumi_env_run.md | 2 +- .../docs/iac/cli/commands/pulumi_env_set.md | 2 +- .../docs/iac/cli/commands/pulumi_env_tag.md | 2 +- .../iac/cli/commands/pulumi_env_tag_get.md | 2 +- .../iac/cli/commands/pulumi_env_tag_ls.md | 2 +- .../iac/cli/commands/pulumi_env_tag_mv.md | 2 +- .../iac/cli/commands/pulumi_env_tag_rm.md | 2 +- .../iac/cli/commands/pulumi_env_version.md | 2 +- .../commands/pulumi_env_version_history.md | 2 +- .../commands/pulumi_env_version_retract.md | 2 +- .../commands/pulumi_env_version_rollback.md | 2 +- .../cli/commands/pulumi_env_version_tag.md | 2 +- .../cli/commands/pulumi_env_version_tag_ls.md | 2 +- .../cli/commands/pulumi_env_version_tag_rm.md | 2 +- .../iac/cli/commands/pulumi_gen-completion.md | 2 +- .../docs/iac/cli/commands/pulumi_import.md | 2 +- .../docs/iac/cli/commands/pulumi_install.md | 2 +- content/docs/iac/cli/commands/pulumi_login.md | 2 +- .../docs/iac/cli/commands/pulumi_logout.md | 2 +- content/docs/iac/cli/commands/pulumi_logs.md | 2 +- content/docs/iac/cli/commands/pulumi_new.md | 2 +- content/docs/iac/cli/commands/pulumi_org.md | 2 +- .../cli/commands/pulumi_org_get-default.md | 2 +- .../iac/cli/commands/pulumi_org_search.md | Bin 2614 -> 2614 bytes .../iac/cli/commands/pulumi_org_search_ai.md | Bin 2102 -> 2102 bytes .../cli/commands/pulumi_org_set-default.md | 2 +- .../docs/iac/cli/commands/pulumi_package.md | 2 +- .../iac/cli/commands/pulumi_package_add.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 +- .../iac/cli/commands/pulumi_package_info.md | 2 +- .../cli/commands/pulumi_package_publish.md | 2 +- .../docs/iac/cli/commands/pulumi_plugin.md | 2 +- .../iac/cli/commands/pulumi_plugin_install.md | 2 +- .../docs/iac/cli/commands/pulumi_plugin_ls.md | 2 +- .../docs/iac/cli/commands/pulumi_plugin_rm.md | 2 +- .../docs/iac/cli/commands/pulumi_policy.md | 2 +- .../iac/cli/commands/pulumi_policy_disable.md | 2 +- .../iac/cli/commands/pulumi_policy_enable.md | 2 +- .../iac/cli/commands/pulumi_policy_group.md | 2 +- .../cli/commands/pulumi_policy_group_ls.md | 2 +- .../docs/iac/cli/commands/pulumi_policy_ls.md | 2 +- .../iac/cli/commands/pulumi_policy_new.md | 2 +- .../iac/cli/commands/pulumi_policy_publish.md | 2 +- .../docs/iac/cli/commands/pulumi_policy_rm.md | 2 +- .../commands/pulumi_policy_validate-config.md | 2 +- .../docs/iac/cli/commands/pulumi_preview.md | 2 +- .../docs/iac/cli/commands/pulumi_project.md | 2 +- .../iac/cli/commands/pulumi_project_ls.md | 2 +- .../docs/iac/cli/commands/pulumi_refresh.md | 2 +- .../docs/iac/cli/commands/pulumi_schema.md | 2 +- .../iac/cli/commands/pulumi_schema_check.md | 5 +- content/docs/iac/cli/commands/pulumi_stack.md | 2 +- .../pulumi_stack_change-secrets-provider.md | 2 +- .../iac/cli/commands/pulumi_stack_export.md | 2 +- .../iac/cli/commands/pulumi_stack_graph.md | 2 +- .../iac/cli/commands/pulumi_stack_history.md | 2 +- .../iac/cli/commands/pulumi_stack_import.md | 2 +- .../iac/cli/commands/pulumi_stack_init.md | 2 +- .../docs/iac/cli/commands/pulumi_stack_ls.md | 2 +- .../iac/cli/commands/pulumi_stack_output.md | 2 +- .../iac/cli/commands/pulumi_stack_rename.md | 2 +- .../docs/iac/cli/commands/pulumi_stack_rm.md | 4 +- .../iac/cli/commands/pulumi_stack_select.md | 2 +- .../docs/iac/cli/commands/pulumi_stack_tag.md | 2 +- .../iac/cli/commands/pulumi_stack_tag_get.md | 2 +- .../iac/cli/commands/pulumi_stack_tag_ls.md | 2 +- .../iac/cli/commands/pulumi_stack_tag_rm.md | 2 +- .../iac/cli/commands/pulumi_stack_tag_set.md | 2 +- .../iac/cli/commands/pulumi_stack_unselect.md | 2 +- content/docs/iac/cli/commands/pulumi_state.md | 3 +- .../iac/cli/commands/pulumi_state_delete.md | 2 +- .../iac/cli/commands/pulumi_state_edit.md | 2 +- .../iac/cli/commands/pulumi_state_move.md | 2 +- .../iac/cli/commands/pulumi_state_protect.md | 63 +++++++++++ .../iac/cli/commands/pulumi_state_rename.md | 2 +- .../iac/cli/commands/pulumi_state_repair.md | 2 +- .../cli/commands/pulumi_state_unprotect.md | 4 +- .../iac/cli/commands/pulumi_state_upgrade.md | 2 +- content/docs/iac/cli/commands/pulumi_up.md | 2 +- .../docs/iac/cli/commands/pulumi_version.md | 2 +- content/docs/iac/cli/commands/pulumi_watch.md | 2 +- .../docs/iac/cli/commands/pulumi_whoami.md | 2 +- content/docs/iac/download-install/versions.md | 1 + data/versions.json | 16 ++- .../pulumi/classes/ComponentResource.html | 16 +-- .../nodejs/pulumi/pulumi/classes/Config.html | 38 +++---- .../pulumi/pulumi/classes/CustomResource.html | 12 +-- .../classes/DependencyProviderResource.html | 12 +-- .../pulumi/classes/DependencyResource.html | 12 +-- .../pulumi/classes/InputPropertiesError.html | 4 +- .../pulumi/classes/InputPropertyError.html | 4 +- .../pulumi/classes/ProviderResource.html | 12 +-- .../pulumi/pulumi/classes/Resource.html | 8 +- .../pulumi/pulumi/classes/ResourceError.html | 6 +- .../pulumi/pulumi/classes/RunError.html | 4 +- .../pulumi/pulumi/classes/StackReference.html | 28 ++--- .../pulumi/pulumi/classes/asset.Archive.html | 4 +- .../pulumi/pulumi/classes/asset.Asset.html | 4 +- .../pulumi/classes/asset.AssetArchive.html | 8 +- .../pulumi/classes/asset.FileArchive.html | 8 +- .../pulumi/classes/asset.FileAsset.html | 8 +- .../pulumi/classes/asset.RemoteArchive.html | 8 +- .../pulumi/classes/asset.RemoteAsset.html | 8 +- .../pulumi/classes/asset.StringAsset.html | 8 +- .../classes/automation.CommandError.html | 2 +- .../automation.ConcurrentUpdateError.html | 2 +- .../classes/automation.LocalWorkspace.html | 100 +++++++++--------- .../classes/automation.PulumiCommand.html | 8 +- .../classes/automation.RemoteStack.html | 22 ++-- .../classes/automation.RemoteWorkspace.html | 8 +- .../pulumi/classes/automation.Stack.html | 62 +++++------ .../automation.StackAlreadyExistsError.html | 2 +- .../automation.StackNotFoundError.html | 2 +- .../pulumi/classes/dynamic.Resource.html | 12 +-- .../pulumi/pulumi/classes/runtime.Stack.html | 18 ++-- .../pulumi/enums/automation.DiffKind.html | 14 +-- .../nodejs/pulumi/pulumi/functions/all.html | 2 +- .../pulumi/pulumi/functions/allAliases.html | 2 +- .../automation.fullyQualifiedStackName.html | 2 +- .../pulumi/pulumi/functions/concat.html | 2 +- .../pulumi/functions/containsUnknowns.html | 2 +- .../pulumi/pulumi/functions/createUrn.html | 2 +- .../pulumi/functions/deferredOutput.html | 2 +- .../pulumi/functions/getAllResources.html | 2 +- .../pulumi/functions/getOrganization.html | 2 +- .../pulumi/pulumi/functions/getProject.html | 2 +- .../pulumi/pulumi/functions/getStack.html | 2 +- .../pulumi/pulumi/functions/interpolate.html | 2 +- .../pulumi/pulumi/functions/isGrpcError.html | 2 +- .../pulumi/pulumi/functions/isSecret.html | 2 +- .../pulumi/pulumi/functions/isUnknown.html | 2 +- .../pulumi/functions/iterable.groupBy.html | 2 +- .../pulumi/functions/iterable.toObject.html | 2 +- .../pulumi/pulumi/functions/jsonParse.html | 2 +- .../pulumi/functions/jsonStringify.html | 2 +- .../pulumi/pulumi/functions/log.debug.html | 2 +- .../pulumi/pulumi/functions/log.error.html | 2 +- .../pulumi/functions/log.hasErrors.html | 2 +- .../pulumi/pulumi/functions/log.info.html | 2 +- .../pulumi/pulumi/functions/log.warn.html | 2 +- .../pulumi/pulumi/functions/mergeOptions.html | 2 +- .../pulumi/pulumi/functions/output-2.html | 2 +- .../pulumi/functions/provider.main.html | 2 +- .../pulumi/pulumi/functions/resourceName.html | 2 +- .../pulumi/pulumi/functions/resourceType.html | 2 +- .../pulumi/functions/runtime.allConfig.html | 2 +- .../runtime.awaitStackRegistrations.html | 2 +- .../runtime.cacheDynamicProviders.html | 2 +- .../pulumi/pulumi/functions/runtime.call.html | 2 +- .../functions/runtime.computeCodePaths.html | 4 +- .../runtime.deserializeProperties.html | 2 +- .../runtime.deserializeProperty.html | 2 +- .../pulumi/functions/runtime.disconnect.html | 2 +- .../functions/runtime.disconnectSync.html | 2 +- .../functions/runtime.getCallbacks.html | 2 +- .../pulumi/functions/runtime.getConfig.html | 2 +- .../pulumi/functions/runtime.getEngine.html | 2 +- .../runtime.getMaximumListeners.html | 2 +- .../pulumi/functions/runtime.getMonitor.html | 2 +- .../functions/runtime.getOrganization.html | 2 +- .../pulumi/functions/runtime.getProject.html | 2 +- .../pulumi/functions/runtime.getResource.html | 2 +- .../functions/runtime.getResourceModule.html | 2 +- .../functions/runtime.getResourcePackage.html | 2 +- .../functions/runtime.getRootDirectory.html | 2 +- .../pulumi/functions/runtime.getStack.html | 2 +- .../functions/runtime.getStackResource.html | 2 +- .../pulumi/functions/runtime.hasEngine.html | 2 +- .../pulumi/functions/runtime.hasMonitor.html | 2 +- .../pulumi/functions/runtime.invoke.html | 2 +- .../functions/runtime.invokeOutput.html | 2 +- .../functions/runtime.invokeSingle.html | 2 +- .../functions/runtime.invokeSingleOutput.html | 2 +- .../pulumi/functions/runtime.isDryRun.html | 2 +- .../runtime.isLegacyApplyEnabled.html | 2 +- .../pulumi/functions/runtime.isRpcSecret.html | 2 +- .../runtime.mapAliasesForRequest.html | 2 +- .../functions/runtime.readResource.html | 2 +- .../runtime.registerInvokeTransform.html | 2 +- .../functions/runtime.registerResource.html | 2 +- .../runtime.registerResourceModule.html | 2 +- .../runtime.registerResourceOutputs.html | 2 +- .../runtime.registerResourcePackage.html | 2 +- .../runtime.registerResourceTransform.html | 2 +- .../runtime.registerStackTransform.html | 2 +- .../runtime.registerStackTransformation.html | 2 +- .../functions/runtime.resetOptions.html | 2 +- .../functions/runtime.resolveProperties.html | 2 +- .../functions/runtime.rpcKeepAlive.html | 2 +- .../functions/runtime.runInPulumiStack.html | 2 +- .../pulumi/functions/runtime.serialize.html | 2 +- .../functions/runtime.serializeFunction.html | 2 +- .../runtime.serializeFunctionAsync.html | 2 +- .../runtime.serializeProperties.html | 2 +- .../functions/runtime.serializeProperty.html | 2 +- .../runtime.serializeResourceProperties.html | 2 +- .../functions/runtime.setAllConfig.html | 2 +- .../pulumi/functions/runtime.setConfig.html | 2 +- .../functions/runtime.setMockOptions.html | 2 +- .../pulumi/functions/runtime.setMocks.html | 2 +- .../functions/runtime.setRootResource.html | 2 +- .../runtime.supportsParameterization.html | 2 +- ...ntime.suppressUnhandledGrpcRejections.html | 2 +- .../functions/runtime.terminateRpcs.html | 2 +- .../functions/runtime.transferProperties.html | 2 +- .../functions/runtime.unwrapRpcSecret.html | 2 +- .../pulumi/pulumi/functions/secret.html | 2 +- .../pulumi/pulumi/functions/unsecret.html | 2 +- .../pulumi/pulumi/interfaces/Alias.html | 12 +-- .../interfaces/ComponentResourceOptions.html | 36 +++---- .../interfaces/CustomResourceOptions.html | 40 +++---- .../pulumi/interfaces/CustomTimeouts.html | 8 +- .../interfaces/InputPropertyErrorDetails.html | 4 +- .../pulumi/interfaces/InvokeOptions.html | 12 +-- .../interfaces/InvokeOutputOptions.html | 14 +-- .../interfaces/InvokeTransformArgs.html | 8 +- .../interfaces/InvokeTransformResult.html | 6 +- .../interfaces/NumberConfigOptions.html | 6 +- .../pulumi/interfaces/OutputConstructor.html | 4 +- .../pulumi/interfaces/OutputInstance.html | 6 +- .../pulumi/interfaces/ResourceOptions.html | 34 +++--- .../interfaces/ResourceTransformArgs.html | 12 +-- .../interfaces/ResourceTransformResult.html | 6 +- .../ResourceTransformationArgs.html | 12 +-- .../ResourceTransformationResult.html | 6 +- .../pulumi/interfaces/StackReferenceArgs.html | 4 +- .../StackReferenceOutputDetails.html | 6 +- .../interfaces/StringConfigOptions.html | 10 +- .../interfaces/automation.ConfigValue.html | 6 +- .../interfaces/automation.Deployment.html | 6 +- .../interfaces/automation.DestroyOptions.html | 56 +++++----- .../interfaces/automation.DestroyResult.html | 8 +- .../automation.DiagnosticEvent.html | 4 +- .../automation.DockerImageCredentials.html | 4 +- .../interfaces/automation.EngineEvent.html | 26 ++--- .../interfaces/automation.ExecutorImage.html | 4 +- .../interfaces/automation.GlobalOpts.html | 20 ++-- .../interfaces/automation.ImportOptions.html | 36 +++---- .../interfaces/automation.ImportResource.html | 10 +- .../interfaces/automation.ImportResult.html | 4 +- .../automation.InlineProgramArgs.html | 8 +- .../interfaces/automation.InstallOptions.html | 10 +- .../interfaces/automation.ListOptions.html | 4 +- .../automation.LocalProgramArgs.html | 6 +- .../automation.LocalWorkspaceOptions.html | 20 ++-- .../interfaces/automation.OutputValue.html | 6 +- .../interfaces/automation.PluginInfo.html | 4 +- .../interfaces/automation.PolicyEvent.html | 4 +- .../interfaces/automation.PreludeEvent.html | 4 +- .../interfaces/automation.PreviewOptions.html | 60 +++++------ .../interfaces/automation.PreviewResult.html | 8 +- .../interfaces/automation.ProjectBackend.html | 4 +- .../automation.ProjectRuntimeInfo.html | 4 +- .../automation.ProjectSettings.html | 4 +- .../automation.ProjectTemplate.html | 4 +- ...automation.ProjectTemplateConfigValue.html | 4 +- .../interfaces/automation.PropertyDiff.html | 6 +- .../automation.PulumiCommandOptions.html | 8 +- .../interfaces/automation.RefreshOptions.html | 52 ++++----- .../interfaces/automation.RefreshResult.html | 8 +- .../automation.RemoteDestroyOptions.html | 4 +- .../automation.RemoteGitAuthArgs.html | 12 +-- .../automation.RemoteGitProgramArgs.html | 14 +-- .../automation.RemotePreviewOptions.html | 4 +- .../automation.RemoteRefreshOptions.html | 4 +- .../automation.RemoteUpOptions.html | 4 +- .../automation.RemoteWorkspaceOptions.html | 12 +-- .../interfaces/automation.RemoveOptions.html | 6 +- .../interfaces/automation.RenameOptions.html | 30 +++--- .../interfaces/automation.RenameResult.html | 8 +- .../automation.ResOpFailedEvent.html | 4 +- .../automation.ResOutputsEvent.html | 4 +- .../automation.ResourcePreEvent.html | 4 +- .../interfaces/automation.StackSettings.html | 4 +- ...mation.StackSettingsSecureConfigValue.html | 4 +- .../interfaces/automation.StackSummary.html | 4 +- .../automation.StartDebuggingEvent.html | 4 +- .../automation.StdoutEngineEvent.html | 4 +- .../automation.StepEventMetadata.html | 22 ++-- .../automation.StepEventStateMetadata.html | 26 ++--- .../interfaces/automation.SummaryEvent.html | 10 +- .../automation.TokenInfomation.html | 4 +- .../interfaces/automation.UpOptions.html | 64 +++++------ .../interfaces/automation.UpResult.html | 10 +- .../interfaces/automation.UpdateSummary.html | 22 ++-- .../interfaces/automation.WhoAmIResult.html | 4 +- .../interfaces/automation.Workspace.html | 82 +++++++------- .../interfaces/dynamic.CheckFailure.html | 6 +- .../interfaces/dynamic.CheckResult.html | 6 +- .../pulumi/interfaces/dynamic.Config.html | 6 +- .../interfaces/dynamic.ConfigureRequest.html | 4 +- .../interfaces/dynamic.CreateResult.html | 6 +- .../pulumi/interfaces/dynamic.DiffResult.html | 10 +- .../pulumi/interfaces/dynamic.ReadResult.html | 6 +- .../interfaces/dynamic.ResourceProvider.html | 16 +-- .../interfaces/dynamic.UpdateResult.html | 4 +- .../interfaces/provider.CheckFailure.html | 6 +- .../interfaces/provider.CheckResult.html | 6 +- .../interfaces/provider.ConstructResult.html | 6 +- .../interfaces/provider.CreateResult.html | 6 +- .../interfaces/provider.DiffResult.html | 10 +- .../interfaces/provider.InvokeResult.html | 6 +- .../provider.ParameterizeResult.html | 6 +- .../pulumi/interfaces/provider.Provider.html | 30 +++--- .../interfaces/provider.ReadResult.html | 8 +- .../interfaces/provider.UpdateResult.html | 4 +- .../interfaces/runtime.CodePathOptions.html | 10 +- .../interfaces/runtime.MockCallArgs.html | 8 +- .../interfaces/runtime.MockResourceArgs.html | 14 +-- .../pulumi/interfaces/runtime.Mocks.html | 6 +- .../pulumi/interfaces/runtime.Options.html | 26 ++--- .../interfaces/runtime.ResourceModule.html | 4 +- .../interfaces/runtime.ResourcePackage.html | 4 +- .../runtime.SerializationOptions.html | 6 +- .../runtime.SerializeFunctionArgs.html | 12 +-- .../runtime.SerializedFunction.html | 8 +- .../interfaces/runtime.SourcePosition.html | 4 +- .../nodejs/pulumi/pulumi/modules/asset.html | 2 +- .../pulumi/pulumi/modules/automation.html | 2 +- .../nodejs/pulumi/pulumi/modules/dynamic.html | 2 +- .../pulumi/pulumi/modules/iterable.html | 2 +- .../pkg/nodejs/pulumi/pulumi/modules/log.html | 2 +- .../pulumi/pulumi/modules/provider.html | 2 +- .../nodejs/pulumi/pulumi/modules/runtime.html | 2 +- .../nodejs/pulumi/pulumi/modules/utils.html | 2 +- .../pkg/nodejs/pulumi/pulumi/types/ID.html | 2 +- .../pkg/nodejs/pulumi/pulumi/types/Input.html | 2 +- .../nodejs/pulumi/pulumi/types/Inputs.html | 2 +- .../pulumi/pulumi/types/InvokeTransform.html | 2 +- .../nodejs/pulumi/pulumi/types/Lifted.html | 2 +- .../pulumi/pulumi/types/LiftedArray.html | 2 +- .../pulumi/pulumi/types/LiftedObject.html | 2 +- .../nodejs/pulumi/pulumi/types/Output.html | 2 +- .../pulumi/types/ResourceTransform.html | 2 +- .../pulumi/types/ResourceTransformation.html | 2 +- .../pkg/nodejs/pulumi/pulumi/types/URN.html | 2 +- .../nodejs/pulumi/pulumi/types/Unwrap.html | 2 +- .../pulumi/pulumi/types/UnwrapSimple.html | 2 +- .../pulumi/pulumi/types/UnwrappedArray.html | 2 +- .../pulumi/pulumi/types/UnwrappedObject.html | 2 +- .../pulumi/pulumi/types/asset.AssetMap.html | 2 +- .../pulumi/types/automation.CancelEvent.html | 2 +- .../pulumi/types/automation.ConfigMap.html | 2 +- .../pulumi/pulumi/types/automation.OpMap.html | 2 +- .../pulumi/types/automation.OpType.html | 2 +- .../pulumi/types/automation.OutputMap.html | 2 +- .../pulumi/types/automation.PluginKind.html | 2 +- .../types/automation.ProjectRuntime.html | 2 +- .../pulumi/types/automation.PulumiFn.html | 2 +- .../pulumi/types/automation.RawJSON.html | 2 +- .../automation.StackSettingsConfigValue.html | 2 +- .../pulumi/types/automation.TagMap.html | 2 +- .../pulumi/types/automation.UpdateKind.html | 2 +- .../pulumi/types/automation.UpdateResult.html | 2 +- .../pulumi/types/runtime.MockCallResult.html | 2 +- .../types/runtime.MockResourceResult.html | 2 +- .../pulumi/types/runtime.OutputResolvers.html | 2 +- .../pulumi/pulumi/variables/Output-1.html | 2 +- .../pulumi/variables/rootStackResource.html | 2 +- .../runtime.excessiveDebugOutput.html | 2 +- .../runtime.rootPulumiStackTypeName.html | 2 +- .../variables/runtime.specialArchiveSig.html | 2 +- .../variables/runtime.specialAssetSig.html | 2 +- .../runtime.specialOutputValueSig.html | 2 +- .../variables/runtime.specialResourceSig.html | 2 +- .../variables/runtime.specialSecretSig.html | 2 +- .../variables/runtime.specialSigKey.html | 2 +- .../variables/runtime.unknownValue.html | 2 +- .../pulumi/pulumi/variables/unknown.html | 2 +- static/latest-version | 2 +- 404 files changed, 1217 insertions(+), 1139 deletions(-) create mode 100644 content/docs/iac/cli/commands/pulumi_state_protect.md diff --git a/content/docs/iac/cli/commands/pulumi.md b/content/docs/iac/cli/commands/pulumi.md index 66fa7753f5f0..4a9395b2aced 100644 --- a/content/docs/iac/cli/commands/pulumi.md +++ b/content/docs/iac/cli/commands/pulumi.md @@ -77,4 +77,4 @@ For more information, please visit the project page: https://www.pulumi.com/docs * [pulumi watch](/docs/iac/cli/commands/pulumi_watch/) - Continuously update the resources in a stack * [pulumi whoami](/docs/iac/cli/commands/pulumi_whoami/) - Display the current logged-in user -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_about.md b/content/docs/iac/cli/commands/pulumi_about.md index 1d21d7b5abed..78e2e9afbe1b 100644 --- a/content/docs/iac/cli/commands/pulumi_about.md +++ b/content/docs/iac/cli/commands/pulumi_about.md @@ -56,4 +56,4 @@ pulumi about [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line * [pulumi about env](/docs/iac/cli/commands/pulumi_about_env/) - An overview of the environmental variables used by pulumi -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_about_env.md b/content/docs/iac/cli/commands/pulumi_about_env.md index afb78ff76965..c6994729d22a 100644 --- a/content/docs/iac/cli/commands/pulumi_about_env.md +++ b/content/docs/iac/cli/commands/pulumi_about_env.md @@ -42,4 +42,4 @@ pulumi about env [flags] * [pulumi about](/docs/iac/cli/commands/pulumi_about/) - Print information about the Pulumi environment. -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_ai.md b/content/docs/iac/cli/commands/pulumi_ai.md index e75341cdf7a9..ce4d162a8749 100644 --- a/content/docs/iac/cli/commands/pulumi_ai.md +++ b/content/docs/iac/cli/commands/pulumi_ai.md @@ -44,4 +44,4 @@ pulumi ai [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line * [pulumi ai web](/docs/iac/cli/commands/pulumi_ai_web/) - Opens Pulumi AI in your local browser -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_ai_web.md b/content/docs/iac/cli/commands/pulumi_ai_web.md index ffd48bd2a926..6a2253f89b21 100644 --- a/content/docs/iac/cli/commands/pulumi_ai_web.md +++ b/content/docs/iac/cli/commands/pulumi_ai_web.md @@ -55,4 +55,4 @@ pulumi ai web [flags] * [pulumi ai](/docs/iac/cli/commands/pulumi_ai/) - Basic Pulumi AI CLI commands. -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_cancel.md b/content/docs/iac/cli/commands/pulumi_cancel.md index 805a6cec06ee..27749abf4407 100644 --- a/content/docs/iac/cli/commands/pulumi_cancel.md +++ b/content/docs/iac/cli/commands/pulumi_cancel.md @@ -52,4 +52,4 @@ pulumi cancel [] [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_config.md b/content/docs/iac/cli/commands/pulumi_config.md index 0f620dce26b1..0801df82fbfe 100644 --- a/content/docs/iac/cli/commands/pulumi_config.md +++ b/content/docs/iac/cli/commands/pulumi_config.md @@ -58,4 +58,4 @@ pulumi config [flags] * [pulumi config set](/docs/iac/cli/commands/pulumi_config_set/) - Set configuration value * [pulumi config set-all](/docs/iac/cli/commands/pulumi_config_set-all/) - Set multiple configuration values -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_config_cp.md b/content/docs/iac/cli/commands/pulumi_config_cp.md index e06521704c3a..7a27fbd27993 100644 --- a/content/docs/iac/cli/commands/pulumi_config_cp.md +++ b/content/docs/iac/cli/commands/pulumi_config_cp.md @@ -48,4 +48,4 @@ pulumi config cp [key] [flags] * [pulumi config](/docs/iac/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_config_env.md b/content/docs/iac/cli/commands/pulumi_config_env.md index aff6571fd3f5..c9058c757f00 100644 --- a/content/docs/iac/cli/commands/pulumi_config_env.md +++ b/content/docs/iac/cli/commands/pulumi_config_env.md @@ -46,4 +46,4 @@ from a stack's configuration, use `pulumi config env init`. * [pulumi config env ls](/docs/iac/cli/commands/pulumi_config_env_ls/) - Lists imported environments. * [pulumi config env rm](/docs/iac/cli/commands/pulumi_config_env_rm/) - Remove environment from a stack -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_config_env_add.md b/content/docs/iac/cli/commands/pulumi_config_env_add.md index d15bf8838651..915acca74ab9 100644 --- a/content/docs/iac/cli/commands/pulumi_config_env_add.md +++ b/content/docs/iac/cli/commands/pulumi_config_env_add.md @@ -49,4 +49,4 @@ pulumi config env add ... [flags] * [pulumi config env](/docs/iac/cli/commands/pulumi_config_env/) - Manage ESC environments for a stack -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_config_env_init.md b/content/docs/iac/cli/commands/pulumi_config_env_init.md index f85f9acd4eac..eee1dc768c30 100644 --- a/content/docs/iac/cli/commands/pulumi_config_env_init.md +++ b/content/docs/iac/cli/commands/pulumi_config_env_init.md @@ -51,4 +51,4 @@ pulumi config env init [flags] * [pulumi config env](/docs/iac/cli/commands/pulumi_config_env/) - Manage ESC environments for a stack -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_config_env_ls.md b/content/docs/iac/cli/commands/pulumi_config_env_ls.md index aefeed33817b..a502885dcf04 100644 --- a/content/docs/iac/cli/commands/pulumi_config_env_ls.md +++ b/content/docs/iac/cli/commands/pulumi_config_env_ls.md @@ -46,4 +46,4 @@ pulumi config env ls [flags] * [pulumi config env](/docs/iac/cli/commands/pulumi_config_env/) - Manage ESC environments for a stack -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_config_env_rm.md b/content/docs/iac/cli/commands/pulumi_config_env_rm.md index b8e5359672bd..5ace1ecf3f0e 100644 --- a/content/docs/iac/cli/commands/pulumi_config_env_rm.md +++ b/content/docs/iac/cli/commands/pulumi_config_env_rm.md @@ -47,4 +47,4 @@ pulumi config env rm [flags] * [pulumi config env](/docs/iac/cli/commands/pulumi_config_env/) - Manage ESC environments for a stack -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_config_get.md b/content/docs/iac/cli/commands/pulumi_config_get.md index d9f2fc296f27..e1b91c9881f0 100644 --- a/content/docs/iac/cli/commands/pulumi_config_get.md +++ b/content/docs/iac/cli/commands/pulumi_config_get.md @@ -53,4 +53,4 @@ pulumi config get [flags] * [pulumi config](/docs/iac/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_config_refresh.md b/content/docs/iac/cli/commands/pulumi_config_refresh.md index d710a3abc8bd..b290faf01381 100644 --- a/content/docs/iac/cli/commands/pulumi_config_refresh.md +++ b/content/docs/iac/cli/commands/pulumi_config_refresh.md @@ -42,4 +42,4 @@ pulumi config refresh [flags] * [pulumi config](/docs/iac/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_config_rm-all.md b/content/docs/iac/cli/commands/pulumi_config_rm-all.md index 026d43200eeb..a203e14d2fae 100644 --- a/content/docs/iac/cli/commands/pulumi_config_rm-all.md +++ b/content/docs/iac/cli/commands/pulumi_config_rm-all.md @@ -52,4 +52,4 @@ pulumi config rm-all ... [flags] * [pulumi config](/docs/iac/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_config_rm.md b/content/docs/iac/cli/commands/pulumi_config_rm.md index b0f48ba1352c..bdbe7f4c44d5 100644 --- a/content/docs/iac/cli/commands/pulumi_config_rm.md +++ b/content/docs/iac/cli/commands/pulumi_config_rm.md @@ -51,4 +51,4 @@ pulumi config rm [flags] * [pulumi config](/docs/iac/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_config_set-all.md b/content/docs/iac/cli/commands/pulumi_config_set-all.md index 9af7296d854f..0c7ec2474713 100644 --- a/content/docs/iac/cli/commands/pulumi_config_set-all.md +++ b/content/docs/iac/cli/commands/pulumi_config_set-all.md @@ -62,4 +62,4 @@ pulumi config set-all --plaintext key1=value1 --plaintext key2=value2 --secret k * [pulumi config](/docs/iac/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_config_set.md b/content/docs/iac/cli/commands/pulumi_config_set.md index b2b2281d106e..a8591664dc5c 100644 --- a/content/docs/iac/cli/commands/pulumi_config_set.md +++ b/content/docs/iac/cli/commands/pulumi_config_set.md @@ -62,4 +62,4 @@ pulumi config set [value] [flags] * [pulumi config](/docs/iac/cli/commands/pulumi_config/) - Manage configuration -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_console.md b/content/docs/iac/cli/commands/pulumi_console.md index d16314086c74..5d1b485520f5 100644 --- a/content/docs/iac/cli/commands/pulumi_console.md +++ b/content/docs/iac/cli/commands/pulumi_console.md @@ -40,4 +40,4 @@ pulumi console [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_convert.md b/content/docs/iac/cli/commands/pulumi_convert.md index 9be1a43064fb..3d903761699f 100644 --- a/content/docs/iac/cli/commands/pulumi_convert.md +++ b/content/docs/iac/cli/commands/pulumi_convert.md @@ -59,4 +59,4 @@ pulumi convert [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_destroy.md b/content/docs/iac/cli/commands/pulumi_destroy.md index ae20c7980a3b..7f2fa32b77f1 100644 --- a/content/docs/iac/cli/commands/pulumi_destroy.md +++ b/content/docs/iac/cli/commands/pulumi_destroy.md @@ -95,4 +95,4 @@ pulumi destroy [url] [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env.md b/content/docs/iac/cli/commands/pulumi_env.md index fbcabef26004..c52191ebc0c9 100644 --- a/content/docs/iac/cli/commands/pulumi_env.md +++ b/content/docs/iac/cli/commands/pulumi_env.md @@ -65,4 +65,4 @@ For more information, please visit the project page: https://www.pulumi.com/docs * [pulumi env tag](/docs/iac/cli/commands/pulumi_env_tag/) - Manage environment tags * [pulumi env version](/docs/iac/cli/commands/pulumi_env_version/) - Manage versions -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_clone.md b/content/docs/iac/cli/commands/pulumi_env_clone.md index 0d0d71e7c0a6..e39e02ca301b 100644 --- a/content/docs/iac/cli/commands/pulumi_env_clone.md +++ b/content/docs/iac/cli/commands/pulumi_env_clone.md @@ -53,4 +53,4 @@ pulumi env clone [/]/ [/][/][@] [[[ * [pulumi env](/docs/iac/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_edit.md b/content/docs/iac/cli/commands/pulumi_env_edit.md index 70c8e151a85e..315d92269ff0 100644 --- a/content/docs/iac/cli/commands/pulumi_env_edit.md +++ b/content/docs/iac/cli/commands/pulumi_env_edit.md @@ -55,4 +55,4 @@ pulumi env edit [/][/] [flags] * [pulumi env](/docs/iac/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_get.md b/content/docs/iac/cli/commands/pulumi_env_get.md index 020c34620c5d..6aef254e1323 100644 --- a/content/docs/iac/cli/commands/pulumi_env_get.md +++ b/content/docs/iac/cli/commands/pulumi_env_get.md @@ -52,4 +52,4 @@ pulumi env get [/][/][@] /][/] [flags] * [pulumi env](/docs/iac/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_ls.md b/content/docs/iac/cli/commands/pulumi_env_ls.md index 5574d072060f..137601b76a5f 100644 --- a/content/docs/iac/cli/commands/pulumi_env_ls.md +++ b/content/docs/iac/cli/commands/pulumi_env_ls.md @@ -49,4 +49,4 @@ pulumi env ls [flags] * [pulumi env](/docs/iac/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_open.md b/content/docs/iac/cli/commands/pulumi_env_open.md index 82c376a3be13..e23e4e68c016 100644 --- a/content/docs/iac/cli/commands/pulumi_env_open.md +++ b/content/docs/iac/cli/commands/pulumi_env_open.md @@ -50,4 +50,4 @@ pulumi env open [/][/][@] [pr * [pulumi env](/docs/iac/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_rm.md b/content/docs/iac/cli/commands/pulumi_env_rm.md index 85f5e3d24073..91a31292bb2c 100644 --- a/content/docs/iac/cli/commands/pulumi_env_rm.md +++ b/content/docs/iac/cli/commands/pulumi_env_rm.md @@ -49,4 +49,4 @@ pulumi env rm [/][/] [path] [flags] * [pulumi env](/docs/iac/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_rotate.md b/content/docs/iac/cli/commands/pulumi_env_rotate.md index 2b56326d63c2..6d9d399b8c3d 100644 --- a/content/docs/iac/cli/commands/pulumi_env_rotate.md +++ b/content/docs/iac/cli/commands/pulumi_env_rotate.md @@ -47,4 +47,4 @@ pulumi env rotate [/][/] [path(s) to r * [pulumi env](/docs/iac/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_run.md b/content/docs/iac/cli/commands/pulumi_env_run.md index f3ed3d6a5530..297b92694860 100644 --- a/content/docs/iac/cli/commands/pulumi_env_run.md +++ b/content/docs/iac/cli/commands/pulumi_env_run.md @@ -65,4 +65,4 @@ pulumi env run [/][/] [flags] -- [comm * [pulumi env](/docs/iac/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_set.md b/content/docs/iac/cli/commands/pulumi_env_set.md index d5d576c47aa7..db280be2f865 100644 --- a/content/docs/iac/cli/commands/pulumi_env_set.md +++ b/content/docs/iac/cli/commands/pulumi_env_set.md @@ -52,4 +52,4 @@ pulumi env set [/][/] [ * [pulumi env](/docs/iac/cli/commands/pulumi_env/) - Manage environments -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_tag.md b/content/docs/iac/cli/commands/pulumi_env_tag.md index 7e91a2f10c5b..6cd075177434 100644 --- a/content/docs/iac/cli/commands/pulumi_env_tag.md +++ b/content/docs/iac/cli/commands/pulumi_env_tag.md @@ -53,4 +53,4 @@ pulumi env tag [/][/] [ * [pulumi env tag mv](/docs/iac/cli/commands/pulumi_env_tag_mv/) - Move an environment tag * [pulumi env tag rm](/docs/iac/cli/commands/pulumi_env_tag_rm/) - Remove an environment tag. -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_tag_get.md b/content/docs/iac/cli/commands/pulumi_env_tag_get.md index 7e5b7cfd7b8f..f982c3854296 100644 --- a/content/docs/iac/cli/commands/pulumi_env_tag_get.md +++ b/content/docs/iac/cli/commands/pulumi_env_tag_get.md @@ -47,4 +47,4 @@ pulumi env tag get [/][/] [flag * [pulumi env tag](/docs/iac/cli/commands/pulumi_env_tag/) - Manage environment tags -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_tag_ls.md b/content/docs/iac/cli/commands/pulumi_env_tag_ls.md index 1a6eb9c10880..8191a4176762 100644 --- a/content/docs/iac/cli/commands/pulumi_env_tag_ls.md +++ b/content/docs/iac/cli/commands/pulumi_env_tag_ls.md @@ -49,4 +49,4 @@ pulumi env tag ls [/][/] [flags] * [pulumi env tag](/docs/iac/cli/commands/pulumi_env_tag/) - Manage environment tags -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_tag_mv.md b/content/docs/iac/cli/commands/pulumi_env_tag_mv.md index d2b1af340854..49708544d40b 100644 --- a/content/docs/iac/cli/commands/pulumi_env_tag_mv.md +++ b/content/docs/iac/cli/commands/pulumi_env_tag_mv.md @@ -48,4 +48,4 @@ pulumi env tag mv [/][/] /][/] [f * [pulumi env tag](/docs/iac/cli/commands/pulumi_env_tag/) - Manage environment tags -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_version.md b/content/docs/iac/cli/commands/pulumi_env_version.md index 6fc443284b2c..84325327c9bc 100644 --- a/content/docs/iac/cli/commands/pulumi_env_version.md +++ b/content/docs/iac/cli/commands/pulumi_env_version.md @@ -53,4 +53,4 @@ pulumi env version [/][/]@ [f * [pulumi env version rollback](/docs/iac/cli/commands/pulumi_env_version_rollback/) - Roll back to a specific version * [pulumi env version tag](/docs/iac/cli/commands/pulumi_env_version_tag/) - Manage tagged versions -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_version_history.md b/content/docs/iac/cli/commands/pulumi_env_version_history.md index e8a405a5b623..98aedd1060be 100644 --- a/content/docs/iac/cli/commands/pulumi_env_version_history.md +++ b/content/docs/iac/cli/commands/pulumi_env_version_history.md @@ -50,4 +50,4 @@ pulumi env version history [/][/][@/][/]@/][/]@/][/]@ [@ * [pulumi env version tag ls](/docs/iac/cli/commands/pulumi_env_version_tag_ls/) - List tagged versions. * [pulumi env version tag rm](/docs/iac/cli/commands/pulumi_env_version_tag_rm/) - Remove a tagged version. -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_version_tag_ls.md b/content/docs/iac/cli/commands/pulumi_env_version_tag_ls.md index db489da23161..dba6a43938de 100644 --- a/content/docs/iac/cli/commands/pulumi_env_version_tag_ls.md +++ b/content/docs/iac/cli/commands/pulumi_env_version_tag_ls.md @@ -49,4 +49,4 @@ pulumi env version tag ls [/][/] [flag * [pulumi env version tag](/docs/iac/cli/commands/pulumi_env_version_tag/) - Manage tagged versions -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_env_version_tag_rm.md b/content/docs/iac/cli/commands/pulumi_env_version_tag_rm.md index d2d641feff4e..ff6e93fa2d86 100644 --- a/content/docs/iac/cli/commands/pulumi_env_version_tag_rm.md +++ b/content/docs/iac/cli/commands/pulumi_env_version_tag_rm.md @@ -46,4 +46,4 @@ pulumi env version tag rm [/][/]@ * [pulumi env version tag](/docs/iac/cli/commands/pulumi_env_version_tag/) - Manage tagged versions -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_gen-completion.md b/content/docs/iac/cli/commands/pulumi_gen-completion.md index 05758a10041f..784e8e30e361 100644 --- a/content/docs/iac/cli/commands/pulumi_gen-completion.md +++ b/content/docs/iac/cli/commands/pulumi_gen-completion.md @@ -39,4 +39,4 @@ pulumi gen-completion [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_import.md b/content/docs/iac/cli/commands/pulumi_import.md index 796ddbdadbe1..00a5f5c5562c 100644 --- a/content/docs/iac/cli/commands/pulumi_import.md +++ b/content/docs/iac/cli/commands/pulumi_import.md @@ -150,4 +150,4 @@ pulumi import [type] [name] [id] [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_install.md b/content/docs/iac/cli/commands/pulumi_install.md index 3fcd8ecb662e..a7e74cf403dd 100644 --- a/content/docs/iac/cli/commands/pulumi_install.md +++ b/content/docs/iac/cli/commands/pulumi_install.md @@ -51,4 +51,4 @@ pulumi install [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_login.md b/content/docs/iac/cli/commands/pulumi_login.md index 7fa08d7f81b7..b51b9b0d097a 100644 --- a/content/docs/iac/cli/commands/pulumi_login.md +++ b/content/docs/iac/cli/commands/pulumi_login.md @@ -92,4 +92,4 @@ pulumi login [] [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_logout.md b/content/docs/iac/cli/commands/pulumi_logout.md index 617b253bfed8..548142fc3e62 100644 --- a/content/docs/iac/cli/commands/pulumi_logout.md +++ b/content/docs/iac/cli/commands/pulumi_logout.md @@ -56,4 +56,4 @@ pulumi logout [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_logs.md b/content/docs/iac/cli/commands/pulumi_logs.md index c303db1589e2..57019782e976 100644 --- a/content/docs/iac/cli/commands/pulumi_logs.md +++ b/content/docs/iac/cli/commands/pulumi_logs.md @@ -54,4 +54,4 @@ pulumi logs [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_new.md b/content/docs/iac/cli/commands/pulumi_new.md index 0a7d20005b8d..996b6f43ea0a 100644 --- a/content/docs/iac/cli/commands/pulumi_new.md +++ b/content/docs/iac/cli/commands/pulumi_new.md @@ -106,4 +106,4 @@ pulumi new [template|url] [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_org.md b/content/docs/iac/cli/commands/pulumi_org.md index c1b76b3247d5..24e3d6ff91b1 100644 --- a/content/docs/iac/cli/commands/pulumi_org.md +++ b/content/docs/iac/cli/commands/pulumi_org.md @@ -48,4 +48,4 @@ pulumi org [flags] * [pulumi org search](/docs/iac/cli/commands/pulumi_org_search/) - Search for resources in Pulumi Cloud * [pulumi org set-default](/docs/iac/cli/commands/pulumi_org_set-default/) - Set the local default organization for the current backend -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_org_get-default.md b/content/docs/iac/cli/commands/pulumi_org_get-default.md index b0ca50ade9fe..210830c3e9c9 100644 --- a/content/docs/iac/cli/commands/pulumi_org_get-default.md +++ b/content/docs/iac/cli/commands/pulumi_org_get-default.md @@ -47,4 +47,4 @@ pulumi org get-default [flags] * [pulumi org](/docs/iac/cli/commands/pulumi_org/) - Manage Organization configuration -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_org_search.md b/content/docs/iac/cli/commands/pulumi_org_search.md index 2c0f139a9c1307cead38fe74639667682b96b447..58adfef1e75c626d2b728f7bac67c36eee055f54 100644 GIT binary patch delta 19 acmdlcvQ1=zHW# [provider-parameter...] [flags] * [pulumi package](/docs/iac/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_package_gen-sdk.md b/content/docs/iac/cli/commands/pulumi_package_gen-sdk.md index 1b6f49125532..3d78a0ea21c2 100644 --- a/content/docs/iac/cli/commands/pulumi_package_gen-sdk.md +++ b/content/docs/iac/cli/commands/pulumi_package_gen-sdk.md @@ -50,4 +50,4 @@ pulumi package gen-sdk [provider parameters] [flags] * [pulumi package](/docs/iac/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_package_get-mapping.md b/content/docs/iac/cli/commands/pulumi_package_get-mapping.md index 4eb89373eb43..d9cb8b18c8f7 100644 --- a/content/docs/iac/cli/commands/pulumi_package_get-mapping.md +++ b/content/docs/iac/cli/commands/pulumi_package_get-mapping.md @@ -50,4 +50,4 @@ pulumi package get-mapping [provider key] [provider parame * [pulumi package](/docs/iac/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_package_get-schema.md b/content/docs/iac/cli/commands/pulumi_package_get-schema.md index 892c222723a7..17340091fc54 100644 --- a/content/docs/iac/cli/commands/pulumi_package_get-schema.md +++ b/content/docs/iac/cli/commands/pulumi_package_get-schema.md @@ -46,4 +46,4 @@ pulumi package get-schema [provider parameters] [flags] * [pulumi package](/docs/iac/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_package_info.md b/content/docs/iac/cli/commands/pulumi_package_info.md index 4901b9c499b1..0195b628b8e7 100644 --- a/content/docs/iac/cli/commands/pulumi_package_info.md +++ b/content/docs/iac/cli/commands/pulumi_package_info.md @@ -50,4 +50,4 @@ pulumi package info [provider-parameter...] [flags] * [pulumi package](/docs/iac/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_package_publish.md b/content/docs/iac/cli/commands/pulumi_package_publish.md index c825b54fc6e7..bec50289077b 100644 --- a/content/docs/iac/cli/commands/pulumi_package_publish.md +++ b/content/docs/iac/cli/commands/pulumi_package_publish.md @@ -62,4 +62,4 @@ pulumi package publish --readme [--] [provider-paramete * [pulumi package](/docs/iac/cli/commands/pulumi_package/) - Work with Pulumi packages -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_plugin.md b/content/docs/iac/cli/commands/pulumi_plugin.md index d79d0d386a01..6fea0a53f8af 100644 --- a/content/docs/iac/cli/commands/pulumi_plugin.md +++ b/content/docs/iac/cli/commands/pulumi_plugin.md @@ -55,4 +55,4 @@ For a list of available resource plugins, please see https://www.pulumi.com/regi * [pulumi plugin ls](/docs/iac/cli/commands/pulumi_plugin_ls/) - List plugins * [pulumi plugin rm](/docs/iac/cli/commands/pulumi_plugin_rm/) - Remove one or more plugins from the download cache -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_plugin_install.md b/content/docs/iac/cli/commands/pulumi_plugin_install.md index 6981cb377230..c654ba28c33a 100644 --- a/content/docs/iac/cli/commands/pulumi_plugin_install.md +++ b/content/docs/iac/cli/commands/pulumi_plugin_install.md @@ -58,4 +58,4 @@ pulumi plugin install [KIND NAME [VERSION]] [flags] * [pulumi plugin](/docs/iac/cli/commands/pulumi_plugin/) - Manage language and resource provider plugins -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_plugin_ls.md b/content/docs/iac/cli/commands/pulumi_plugin_ls.md index 16c82b504414..ff2db0599e81 100644 --- a/content/docs/iac/cli/commands/pulumi_plugin_ls.md +++ b/content/docs/iac/cli/commands/pulumi_plugin_ls.md @@ -41,4 +41,4 @@ pulumi plugin ls [flags] * [pulumi plugin](/docs/iac/cli/commands/pulumi_plugin/) - Manage language and resource provider plugins -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_plugin_rm.md b/content/docs/iac/cli/commands/pulumi_plugin_rm.md index 5038545db096..88d9ccab1226 100644 --- a/content/docs/iac/cli/commands/pulumi_plugin_rm.md +++ b/content/docs/iac/cli/commands/pulumi_plugin_rm.md @@ -54,4 +54,4 @@ pulumi plugin rm [KIND [NAME [VERSION]]] [flags] * [pulumi plugin](/docs/iac/cli/commands/pulumi_plugin/) - Manage language and resource provider plugins -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_policy.md b/content/docs/iac/cli/commands/pulumi_policy.md index cae9a114f7e7..f5f8b322bbdd 100644 --- a/content/docs/iac/cli/commands/pulumi_policy.md +++ b/content/docs/iac/cli/commands/pulumi_policy.md @@ -43,4 +43,4 @@ Manage resource policies * [pulumi policy rm](/docs/iac/cli/commands/pulumi_policy_rm/) - Removes a Policy Pack from a Pulumi organization * [pulumi policy validate-config](/docs/iac/cli/commands/pulumi_policy_validate-config/) - Validate a Policy Pack configuration -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_policy_disable.md b/content/docs/iac/cli/commands/pulumi_policy_disable.md index 8315fdaf7ced..f037d4d49acb 100644 --- a/content/docs/iac/cli/commands/pulumi_policy_disable.md +++ b/content/docs/iac/cli/commands/pulumi_policy_disable.md @@ -45,4 +45,4 @@ pulumi policy disable / [flags] * [pulumi policy](/docs/iac/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_policy_enable.md b/content/docs/iac/cli/commands/pulumi_policy_enable.md index c5a7f7027cc7..0f15d4283509 100644 --- a/content/docs/iac/cli/commands/pulumi_policy_enable.md +++ b/content/docs/iac/cli/commands/pulumi_policy_enable.md @@ -45,4 +45,4 @@ pulumi policy enable / [flags] * [pulumi policy](/docs/iac/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_policy_group.md b/content/docs/iac/cli/commands/pulumi_policy_group.md index c0b6eee15220..e79f428a54c3 100644 --- a/content/docs/iac/cli/commands/pulumi_policy_group.md +++ b/content/docs/iac/cli/commands/pulumi_policy_group.md @@ -36,4 +36,4 @@ Manage policy groups * [pulumi policy](/docs/iac/cli/commands/pulumi_policy/) - Manage resource policies * [pulumi policy group ls](/docs/iac/cli/commands/pulumi_policy_group_ls/) - List all Policy Groups for a Pulumi organization -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_policy_group_ls.md b/content/docs/iac/cli/commands/pulumi_policy_group_ls.md index fbce9ecd83ec..173605f03897 100644 --- a/content/docs/iac/cli/commands/pulumi_policy_group_ls.md +++ b/content/docs/iac/cli/commands/pulumi_policy_group_ls.md @@ -44,4 +44,4 @@ pulumi policy group ls [org-name] [flags] * [pulumi policy group](/docs/iac/cli/commands/pulumi_policy_group/) - Manage policy groups -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_policy_ls.md b/content/docs/iac/cli/commands/pulumi_policy_ls.md index 2dedf4b44fb1..a2d94a91ed15 100644 --- a/content/docs/iac/cli/commands/pulumi_policy_ls.md +++ b/content/docs/iac/cli/commands/pulumi_policy_ls.md @@ -44,4 +44,4 @@ pulumi policy ls [org-name] [flags] * [pulumi policy](/docs/iac/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_policy_new.md b/content/docs/iac/cli/commands/pulumi_policy_new.md index f2e309749111..b977e8f40efe 100644 --- a/content/docs/iac/cli/commands/pulumi_policy_new.md +++ b/content/docs/iac/cli/commands/pulumi_policy_new.md @@ -54,4 +54,4 @@ pulumi policy new [template|url] [flags] * [pulumi policy](/docs/iac/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_policy_publish.md b/content/docs/iac/cli/commands/pulumi_policy_publish.md index d2bb8bd89f3c..5e6eed62e529 100644 --- a/content/docs/iac/cli/commands/pulumi_policy_publish.md +++ b/content/docs/iac/cli/commands/pulumi_policy_publish.md @@ -45,4 +45,4 @@ pulumi policy publish [org-name] [flags] * [pulumi policy](/docs/iac/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_policy_rm.md b/content/docs/iac/cli/commands/pulumi_policy_rm.md index 01ee8dba2d89..e473d9da5b60 100644 --- a/content/docs/iac/cli/commands/pulumi_policy_rm.md +++ b/content/docs/iac/cli/commands/pulumi_policy_rm.md @@ -44,4 +44,4 @@ pulumi policy rm / [flags] * [pulumi policy](/docs/iac/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_policy_validate-config.md b/content/docs/iac/cli/commands/pulumi_policy_validate-config.md index 09763fc71a0c..ebbe49b10e48 100644 --- a/content/docs/iac/cli/commands/pulumi_policy_validate-config.md +++ b/content/docs/iac/cli/commands/pulumi_policy_validate-config.md @@ -44,4 +44,4 @@ pulumi policy validate-config / [flags] * [pulumi policy](/docs/iac/cli/commands/pulumi_policy/) - Manage resource policies -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_preview.md b/content/docs/iac/cli/commands/pulumi_preview.md index f9d2828208e6..2549c8b5d591 100644 --- a/content/docs/iac/cli/commands/pulumi_preview.md +++ b/content/docs/iac/cli/commands/pulumi_preview.md @@ -103,4 +103,4 @@ pulumi preview [url] [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_project.md b/content/docs/iac/cli/commands/pulumi_project.md index 3844aff7c0eb..376d2d6a4379 100644 --- a/content/docs/iac/cli/commands/pulumi_project.md +++ b/content/docs/iac/cli/commands/pulumi_project.md @@ -42,4 +42,4 @@ This command can be used to manage Pulumi projects. Projects are the unit of org * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line * [pulumi project ls](/docs/iac/cli/commands/pulumi_project_ls/) - List your Pulumi projects -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_project_ls.md b/content/docs/iac/cli/commands/pulumi_project_ls.md index 180e3ac4f681..e57ac1b0eda7 100644 --- a/content/docs/iac/cli/commands/pulumi_project_ls.md +++ b/content/docs/iac/cli/commands/pulumi_project_ls.md @@ -47,4 +47,4 @@ pulumi project ls [flags] * [pulumi project](/docs/iac/cli/commands/pulumi_project/) - Manage Pulumi projects -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_refresh.md b/content/docs/iac/cli/commands/pulumi_refresh.md index f0c0b51189eb..ae715389b10e 100644 --- a/content/docs/iac/cli/commands/pulumi_refresh.md +++ b/content/docs/iac/cli/commands/pulumi_refresh.md @@ -94,4 +94,4 @@ pulumi refresh [url] [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_schema.md b/content/docs/iac/cli/commands/pulumi_schema.md index 8c0b534982b1..a7ff9c7c03f2 100644 --- a/content/docs/iac/cli/commands/pulumi_schema.md +++ b/content/docs/iac/cli/commands/pulumi_schema.md @@ -43,4 +43,4 @@ package schemas for errors. * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line * [pulumi schema check](/docs/iac/cli/commands/pulumi_schema_check/) - Check a Pulumi package schema for errors -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_schema_check.md b/content/docs/iac/cli/commands/pulumi_schema_check.md index 543e52c12686..1f7b07bdc443 100644 --- a/content/docs/iac/cli/commands/pulumi_schema_check.md +++ b/content/docs/iac/cli/commands/pulumi_schema_check.md @@ -23,7 +23,8 @@ pulumi schema check [flags] ## Options ``` - -h, --help help for check + --allow-dangling-references Whether references to nonexistent types should be considered errors + -h, --help help for check ``` ## Options inherited from parent commands @@ -47,4 +48,4 @@ pulumi schema check [flags] * [pulumi schema](/docs/iac/cli/commands/pulumi_schema/) - Analyze package schemas -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack.md b/content/docs/iac/cli/commands/pulumi_stack.md index 07246388ad9a..d03a29149bbc 100644 --- a/content/docs/iac/cli/commands/pulumi_stack.md +++ b/content/docs/iac/cli/commands/pulumi_stack.md @@ -66,4 +66,4 @@ pulumi stack [flags] * [pulumi stack tag](/docs/iac/cli/commands/pulumi_stack_tag/) - Manage stack tags * [pulumi stack unselect](/docs/iac/cli/commands/pulumi_stack_unselect/) - Resets stack selection from the current workspace -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_change-secrets-provider.md b/content/docs/iac/cli/commands/pulumi_stack_change-secrets-provider.md index db1632a55808..4fd15ccadc43 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_change-secrets-provider.md +++ b/content/docs/iac/cli/commands/pulumi_stack_change-secrets-provider.md @@ -56,4 +56,4 @@ pulumi stack change-secrets-provider [flags] * [pulumi stack](/docs/iac/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_export.md b/content/docs/iac/cli/commands/pulumi_stack_export.md index c8e9efcfe5f2..a6bd6cfdffd4 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_export.md +++ b/content/docs/iac/cli/commands/pulumi_stack_export.md @@ -52,4 +52,4 @@ pulumi stack export [flags] * [pulumi stack](/docs/iac/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_graph.md b/content/docs/iac/cli/commands/pulumi_stack_graph.md index da67820800cc..85dbf36f0cd5 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_graph.md +++ b/content/docs/iac/cli/commands/pulumi_stack_graph.md @@ -54,4 +54,4 @@ pulumi stack graph [filename] [flags] * [pulumi stack](/docs/iac/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_history.md b/content/docs/iac/cli/commands/pulumi_stack_history.md index 031c2b5882c9..646aa1c7a67e 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_history.md +++ b/content/docs/iac/cli/commands/pulumi_stack_history.md @@ -51,4 +51,4 @@ pulumi stack history [flags] * [pulumi stack](/docs/iac/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_import.md b/content/docs/iac/cli/commands/pulumi_stack_import.md index 12fe3f24a872..28702f810d05 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_import.md +++ b/content/docs/iac/cli/commands/pulumi_stack_import.md @@ -51,4 +51,4 @@ pulumi stack import [flags] * [pulumi stack](/docs/iac/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_init.md b/content/docs/iac/cli/commands/pulumi_stack_init.md index 63bd493a92e2..598173c02253 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_init.md +++ b/content/docs/iac/cli/commands/pulumi_stack_init.md @@ -77,4 +77,4 @@ pulumi stack init [/] [flags] * [pulumi stack](/docs/iac/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_ls.md b/content/docs/iac/cli/commands/pulumi_stack_ls.md index 12abea635332..a92ab0a85219 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_ls.md +++ b/content/docs/iac/cli/commands/pulumi_stack_ls.md @@ -57,4 +57,4 @@ pulumi stack ls [flags] * [pulumi stack](/docs/iac/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_output.md b/content/docs/iac/cli/commands/pulumi_stack_output.md index 02b9eda9ac4d..c25a9d0938ad 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_output.md +++ b/content/docs/iac/cli/commands/pulumi_stack_output.md @@ -50,4 +50,4 @@ pulumi stack output [property-name] [flags] * [pulumi stack](/docs/iac/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_rename.md b/content/docs/iac/cli/commands/pulumi_stack_rename.md index 975c60cf71fd..378af918dbc8 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_rename.md +++ b/content/docs/iac/cli/commands/pulumi_stack_rename.md @@ -52,4 +52,4 @@ pulumi stack rename [flags] * [pulumi stack](/docs/iac/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_rm.md b/content/docs/iac/cli/commands/pulumi_stack_rm.md index caeaa78d6ea2..cb34e0e74fa2 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_rm.md +++ b/content/docs/iac/cli/commands/pulumi_stack_rm.md @@ -13,7 +13,7 @@ Remove a stack and its configuration Remove a stack and its configuration This command removes a stack and its configuration state. Please refer to the -`destroy` command for removing resources, as this is a distinct operation. +`destroy` command for removing a resources, as this is a distinct operation. After this command completes, the stack will no longer be available for updates. @@ -52,4 +52,4 @@ pulumi stack rm [] [flags] * [pulumi stack](/docs/iac/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_select.md b/content/docs/iac/cli/commands/pulumi_stack_select.md index d1d145877dea..aeefc3e047d2 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_select.md +++ b/content/docs/iac/cli/commands/pulumi_stack_select.md @@ -53,4 +53,4 @@ pulumi stack select [] [flags] * [pulumi stack](/docs/iac/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_tag.md b/content/docs/iac/cli/commands/pulumi_stack_tag.md index 88a5c37440fa..2537b0c5c2e3 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_tag.md +++ b/content/docs/iac/cli/commands/pulumi_stack_tag.md @@ -50,4 +50,4 @@ is updated. * [pulumi stack tag rm](/docs/iac/cli/commands/pulumi_stack_tag_rm/) - Remove a stack tag * [pulumi stack tag set](/docs/iac/cli/commands/pulumi_stack_tag_set/) - Set a stack tag -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_tag_get.md b/content/docs/iac/cli/commands/pulumi_stack_tag_get.md index 9a1f8022c802..44f4296ad033 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_tag_get.md +++ b/content/docs/iac/cli/commands/pulumi_stack_tag_get.md @@ -40,4 +40,4 @@ pulumi stack tag get [flags] * [pulumi stack tag](/docs/iac/cli/commands/pulumi_stack_tag/) - Manage stack tags -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_tag_ls.md b/content/docs/iac/cli/commands/pulumi_stack_tag_ls.md index c3b7b6703f73..0f7dd3bc16c7 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_tag_ls.md +++ b/content/docs/iac/cli/commands/pulumi_stack_tag_ls.md @@ -41,4 +41,4 @@ pulumi stack tag ls [flags] * [pulumi stack tag](/docs/iac/cli/commands/pulumi_stack_tag/) - Manage stack tags -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_tag_rm.md b/content/docs/iac/cli/commands/pulumi_stack_tag_rm.md index 47ccafaa6e38..2dfe001e3858 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_tag_rm.md +++ b/content/docs/iac/cli/commands/pulumi_stack_tag_rm.md @@ -40,4 +40,4 @@ pulumi stack tag rm [flags] * [pulumi stack tag](/docs/iac/cli/commands/pulumi_stack_tag/) - Manage stack tags -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_tag_set.md b/content/docs/iac/cli/commands/pulumi_stack_tag_set.md index a5a16184a22a..b010eb0a1b55 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_tag_set.md +++ b/content/docs/iac/cli/commands/pulumi_stack_tag_set.md @@ -40,4 +40,4 @@ pulumi stack tag set [flags] * [pulumi stack tag](/docs/iac/cli/commands/pulumi_stack_tag/) - Manage stack tags -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_stack_unselect.md b/content/docs/iac/cli/commands/pulumi_stack_unselect.md index 6864a6eeeac0..fbfac0eef3db 100644 --- a/content/docs/iac/cli/commands/pulumi_stack_unselect.md +++ b/content/docs/iac/cli/commands/pulumi_stack_unselect.md @@ -48,4 +48,4 @@ pulumi stack unselect [flags] * [pulumi stack](/docs/iac/cli/commands/pulumi_stack/) - Manage stacks and view stack state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_state.md b/content/docs/iac/cli/commands/pulumi_state.md index 5aac6da446eb..80dda17f187b 100644 --- a/content/docs/iac/cli/commands/pulumi_state.md +++ b/content/docs/iac/cli/commands/pulumi_state.md @@ -44,9 +44,10 @@ troubleshooting a stack or when performing specific edits that otherwise would r * [pulumi state delete](/docs/iac/cli/commands/pulumi_state_delete/) - Deletes a resource from a stack's state * [pulumi state edit](/docs/iac/cli/commands/pulumi_state_edit/) - Edit the current stack's state in your EDITOR * [pulumi state move](/docs/iac/cli/commands/pulumi_state_move/) - Move resources from one stack to another +* [pulumi state protect](/docs/iac/cli/commands/pulumi_state_protect/) - protect resource in a stack's state * [pulumi state rename](/docs/iac/cli/commands/pulumi_state_rename/) - Renames a resource from a stack's state * [pulumi state repair](/docs/iac/cli/commands/pulumi_state_repair/) - Repair an invalid state * [pulumi state unprotect](/docs/iac/cli/commands/pulumi_state_unprotect/) - Unprotect resources in a stack's state * [pulumi state upgrade](/docs/iac/cli/commands/pulumi_state_upgrade/) - Migrates the current backend to the latest supported version -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_state_delete.md b/content/docs/iac/cli/commands/pulumi_state_delete.md index 9c41c105641a..dc22c6d14e74 100644 --- a/content/docs/iac/cli/commands/pulumi_state_delete.md +++ b/content/docs/iac/cli/commands/pulumi_state_delete.md @@ -65,4 +65,4 @@ pulumi state delete 'urn:pulumi:stage::demo::eks:index:Cluster$pulumi:providers: * [pulumi state](/docs/iac/cli/commands/pulumi_state/) - Edit the current stack's state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_state_edit.md b/content/docs/iac/cli/commands/pulumi_state_edit.md index 8cd950488f60..b00baf42169a 100644 --- a/content/docs/iac/cli/commands/pulumi_state_edit.md +++ b/content/docs/iac/cli/commands/pulumi_state_edit.md @@ -48,4 +48,4 @@ pulumi state edit [flags] * [pulumi state](/docs/iac/cli/commands/pulumi_state/) - Edit the current stack's state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_state_move.md b/content/docs/iac/cli/commands/pulumi_state_move.md index 3bd13c637ce8..bb3e98c5fa76 100644 --- a/content/docs/iac/cli/commands/pulumi_state_move.md +++ b/content/docs/iac/cli/commands/pulumi_state_move.md @@ -51,4 +51,4 @@ pulumi state move [flags] ... * [pulumi state](/docs/iac/cli/commands/pulumi_state/) - Edit the current stack's state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_state_protect.md b/content/docs/iac/cli/commands/pulumi_state_protect.md new file mode 100644 index 000000000000..68120ce03ab7 --- /dev/null +++ b/content/docs/iac/cli/commands/pulumi_state_protect.md @@ -0,0 +1,63 @@ +--- +title: "pulumi state protect" +aliases: + - /docs/reference/cli/pulumi_state_protect/ +--- + + + +protect resource in a stack's state + +## Synopsis + +Protect resource in a stack's state + +This command sets the 'protect' bit on one or more resources, preventing those resources from being deleted. + +Caution: this command is a low-level operation that directly modifies your stack's state. +Setting the 'protect' bit on a resource in your stack's state is not sufficient to protect it in +all cases. If your program does not also set the 'protect' resource option, Pulumi will +unprotect the resource the next time your program runs (e.g. as part of a `pulumi up`). + +See https://www.pulumi.com/docs/iac/concepts/options/protect/ for more information on +the 'protect' resource option and how it can be used to protect resources in your program. + +To unprotect a resource, use `pulumi unprotect`on the resource URN. + +To see the list of URNs in a stack, use `pulumi stack --show-urns`. + +``` +pulumi state protect [resource URN] [flags] +``` + +## Options + +``` + --all Protect all resources in the checkpoint + -h, --help help for protect + -s, --stack string The name of the stack to operate on. Defaults to the current stack + -y, --yes Skip confirmation prompts +``` + +## Options inherited from parent commands + +``` + --color string Colorize output. Choices are: always, never, raw, auto (default "auto") + -C, --cwd string Run pulumi as if it had been started in another directory + --disable-integrity-checking Disable integrity checking of checkpoint files + -e, --emoji Enable emojis in the output + -Q, --fully-qualify-stack-names Show fully-qualified stack names + --logflow Flow log settings to child processes (like plugins) + --logtostderr Log to stderr instead of to files + --memprofilerate int Enable more precise (and expensive) memory allocation profiles by setting runtime.MemProfileRate + --non-interactive Disable interactive mode for all commands + --profiling string Emit CPU and memory profiles and an execution trace to '[filename].[pid].{cpu,mem,trace}', respectively + --tracing file: Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file + -v, --verbose int Enable verbose logging (e.g., v=3); anything >3 is very verbose +``` + +## SEE ALSO + +* [pulumi state](/docs/iac/cli/commands/pulumi_state/) - Edit the current stack's state + +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_state_rename.md b/content/docs/iac/cli/commands/pulumi_state_rename.md index 11678427b806..6a431921166f 100644 --- a/content/docs/iac/cli/commands/pulumi_state_rename.md +++ b/content/docs/iac/cli/commands/pulumi_state_rename.md @@ -59,4 +59,4 @@ pulumi state rename 'urn:pulumi:stage::demo::eks:index:Cluster$pulumi:providers: * [pulumi state](/docs/iac/cli/commands/pulumi_state/) - Edit the current stack's state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_state_repair.md b/content/docs/iac/cli/commands/pulumi_state_repair.md index 32bed21d7d5b..18b7e1bb9f2f 100644 --- a/content/docs/iac/cli/commands/pulumi_state_repair.md +++ b/content/docs/iac/cli/commands/pulumi_state_repair.md @@ -53,4 +53,4 @@ pulumi state repair [flags] * [pulumi state](/docs/iac/cli/commands/pulumi_state/) - Edit the current stack's state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_state_unprotect.md b/content/docs/iac/cli/commands/pulumi_state_unprotect.md index e3bc460c030c..d63d3c621a08 100644 --- a/content/docs/iac/cli/commands/pulumi_state_unprotect.md +++ b/content/docs/iac/cli/commands/pulumi_state_unprotect.md @@ -10,7 +10,7 @@ Unprotect resources in a stack's state ## Synopsis -Unprotect resource in a stack's state +Unprotect resources in a stack's state This command clears the 'protect' bit on one or more resources, allowing those resources to be deleted. @@ -50,4 +50,4 @@ pulumi state unprotect [resource URN] [flags] * [pulumi state](/docs/iac/cli/commands/pulumi_state/) - Edit the current stack's state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_state_upgrade.md b/content/docs/iac/cli/commands/pulumi_state_upgrade.md index 9e936e8dbce0..0ea69115e595 100644 --- a/content/docs/iac/cli/commands/pulumi_state_upgrade.md +++ b/content/docs/iac/cli/commands/pulumi_state_upgrade.md @@ -47,4 +47,4 @@ pulumi state upgrade [flags] * [pulumi state](/docs/iac/cli/commands/pulumi_state/) - Edit the current stack's state -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_up.md b/content/docs/iac/cli/commands/pulumi_up.md index 2fd91a266f25..46254132e6e6 100644 --- a/content/docs/iac/cli/commands/pulumi_up.md +++ b/content/docs/iac/cli/commands/pulumi_up.md @@ -107,4 +107,4 @@ pulumi up [template|url] [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_version.md b/content/docs/iac/cli/commands/pulumi_version.md index 62d94648d0fc..fbb1f2e9c152 100644 --- a/content/docs/iac/cli/commands/pulumi_version.md +++ b/content/docs/iac/cli/commands/pulumi_version.md @@ -39,4 +39,4 @@ pulumi version [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_watch.md b/content/docs/iac/cli/commands/pulumi_watch.md index e28f27397d6d..73f60edd6959 100644 --- a/content/docs/iac/cli/commands/pulumi_watch.md +++ b/content/docs/iac/cli/commands/pulumi_watch.md @@ -65,4 +65,4 @@ pulumi watch [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/cli/commands/pulumi_whoami.md b/content/docs/iac/cli/commands/pulumi_whoami.md index 37a8aa539bc4..fa02720f6fdd 100644 --- a/content/docs/iac/cli/commands/pulumi_whoami.md +++ b/content/docs/iac/cli/commands/pulumi_whoami.md @@ -46,4 +46,4 @@ pulumi whoami [flags] * [pulumi](/docs/iac/cli/commands/pulumi/) - Pulumi command line -###### Auto generated by spf13/cobra on 2-May-2025 +###### Auto generated by spf13/cobra on 7-May-2025 diff --git a/content/docs/iac/download-install/versions.md b/content/docs/iac/download-install/versions.md index c5e6d38f8788..be58d421f66a 100644 --- a/content/docs/iac/download-install/versions.md +++ b/content/docs/iac/download-install/versions.md @@ -23,6 +23,7 @@ The current stable version of Pulumi is **{{< latest-version >}}**. + {{< changelog-table-row version="3.168.0" date="2025-05-07" showChecksum="true" >}} {{< changelog-table-row version="3.167.0" date="2025-05-02" showChecksum="true" >}} {{< changelog-table-row version="3.166.0" date="2025-05-02" showChecksum="true" >}} {{< changelog-table-row version="3.165.0" date="2025-04-25" showChecksum="true" >}} diff --git a/data/versions.json b/data/versions.json index 8cadc681b234..37c980bfad6f 100644 --- a/data/versions.json +++ b/data/versions.json @@ -1,4 +1,17 @@ [ + { + "version": "v3.168.0", + "date": "2025-05-07T13:55:20Z", + "downloads": { + "linux-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.168.0-linux-x64.tar.gz", + "linux-arm64": "https://get.pulumi.com/releases/sdk/pulumi-v3.168.0-linux-arm64.tar.gz", + "darwin-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.168.0-darwin-x64.tar.gz", + "darwin-arm64": "https://get.pulumi.com/releases/sdk/pulumi-v3.168.0-darwin-arm64.tar.gz", + "windows-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.168.0-windows-x64.zip" + }, + "checksums": "https://get.pulumi.com/releases/sdk/pulumi-3.168.0-checksums.txt", + "latest": true + }, { "version": "v3.167.0", "date": "2025-05-01T12:41:16Z", @@ -9,8 +22,7 @@ "darwin-arm64": "https://get.pulumi.com/releases/sdk/pulumi-v3.167.0-darwin-arm64.tar.gz", "windows-x64": "https://get.pulumi.com/releases/sdk/pulumi-v3.167.0-windows-x64.zip" }, - "checksums": "https://get.pulumi.com/releases/sdk/pulumi-3.167.0-checksums.txt", - "latest": true + "checksums": "https://get.pulumi.com/releases/sdk/pulumi-3.167.0-checksums.txt" }, { "version": "v3.166.0", diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ComponentResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ComponentResource.html index 62ffbc35dd60..fdde93c92c3e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ComponentResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ComponentResource.html @@ -2,7 +2,7 @@ child resources into a higher level abstraction. The component resource itself is a resource, but does not require custom CRUD operations for provisioning.

-

Type Parameters

  • TData = any

Hierarchy (view full)

Constructors

constructor +

Type Parameters

  • TData = any

Hierarchy (view full)

Constructors

constructor

Properties

urn

Methods

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

    Information passed to [initialize] method.

  • opts: ComponentResourceOptions = {}

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

  • remote: boolean = false

    True if this is a remote component resource.

    -
  • Optional packageRef: Promise<undefined | string>

    • Returns ComponentResource<TData>

    Properties

    Readonly urn

    urn: Output<string>

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

  • Optional packageRef: Promise<undefined | string>

    • Returns ComponentResource<TData>

    Properties

    Readonly urn

    urn: Output<string>

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

    -

    Methods

    Protected getData

    Methods

    Protected getData

    getProvider

    Protected initialize

    getProvider

    Protected initialize

    • initialize(args): Promise<TData>

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

      -

      Parameters

      Returns Promise<TData>

    Protected registerOutputs

    Protected registerOutputs

    • registerOutputs(outputs?): void

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

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

      -

      Parameters

      Returns void

    Static isInstance

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorurngetDatagetProviderinitializeregisterOutputsisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is ComponentResource<any>

    Settings

    Member Visibility

    Theme

    On This Page

    constructorurngetDatagetProviderinitializeregisterOutputsisInstance

    Generated using TypeDoc

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

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    name

    Methods

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

    Constructors

    constructor

    Properties

    Readonly name

    name: string

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

    Constructors

    constructor

    Properties

    Readonly name

    name: string

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

    -

    Methods

    get

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

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

      +

    Methods

    get

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

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

      Type Parameters

      • K extends string = string

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: StringConfigOptions<K>

        An options bag to constrain legal values.

        -

      Returns undefined | K

    getBoolean

    • getBoolean(key): undefined | boolean

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

    Returns undefined | K

    getBoolean

    • getBoolean(key): undefined | boolean

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

      Parameters

      • key: string

        The key to lookup.

        -

      Returns undefined | boolean

    getNumber

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

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

    Returns undefined | boolean

    getNumber

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

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

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: NumberConfigOptions

        An options bag to constrain legal values.

        -

      Returns undefined | number

    getObject

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

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

    Returns undefined | number

    getObject

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

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

      Type Parameters

      • T

      Parameters

      • key: string

        The key to lookup.

        -

      Returns undefined | T

    getSecret

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

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

    Returns undefined | T

    getSecret

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

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

      Type Parameters

      • K extends string = string

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: StringConfigOptions<K>

        An options bag to constrain legal values.

        -

      Returns undefined | Output<K>

    getSecretBoolean

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

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

    Returns undefined | Output<K>

    getSecretBoolean

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

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

      Parameters

      • key: string

        The key to lookup.

        -

      Returns undefined | OutputInstance<boolean>

    getSecretNumber

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

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

    Returns undefined | OutputInstance<boolean>

    getSecretNumber

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

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

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: NumberConfigOptions

        An options bag to constrain legal values.

        -

      Returns undefined | OutputInstance<number>

    getSecretObject

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

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

    Returns undefined | OutputInstance<number>

    getSecretObject

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

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

      Type Parameters

      • T

      Parameters

      • key: string

        The key to lookup.

        -

      Returns undefined | Output<T>

    require

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

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

      +

    Returns undefined | Output<T>

    require

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

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

      Type Parameters

      • K extends string = string

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: StringConfigOptions<K>

        An options bag to constrain legal values.

        -

      Returns K

    requireBoolean

    • requireBoolean(key): boolean

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

    Returns K

    requireBoolean

    • requireBoolean(key): boolean

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

      Parameters

      • key: string

        The key to lookup.

        -

      Returns boolean

    requireNumber

    • requireNumber(key, opts?): number

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

    Returns boolean

    requireNumber

    • requireNumber(key, opts?): number

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

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: NumberConfigOptions

        An options bag to constrain legal values.

        -

      Returns number

    requireObject

    • requireObject<T>(key): T

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

    Returns number

    requireObject

    • requireObject<T>(key): T

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

      Type Parameters

      • T

      Parameters

      • key: string

        The key to lookup.

        -

      Returns T

    requireSecret

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

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

    Returns T

    requireSecret

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

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

      Type Parameters

      • K extends string = string

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: StringConfigOptions<K>

        An options bag to constrain legal values.

        -

      Returns Output<K>

    requireSecretBoolean

    • requireSecretBoolean(key): OutputInstance<boolean>

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

    Returns Output<K>

    requireSecretBoolean

    • requireSecretBoolean(key): OutputInstance<boolean>

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

      Parameters

      • key: string

        The key to lookup.

        -

      Returns OutputInstance<boolean>

    requireSecretNumber

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

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

    Returns OutputInstance<boolean>

    requireSecretNumber

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

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

      Parameters

      • key: string

        The key to lookup.

      • Optional opts: NumberConfigOptions

        An options bag to constrain legal values.

        -

      Returns OutputInstance<number>

    requireSecretObject

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

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

    Returns OutputInstance<number>

    requireSecretObject

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

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

      Type Parameters

      • T

      Parameters

      • key: string

        The key to lookup.

        -

      Returns Output<T>

    Settings

    Member Visibility

    Theme

    On This Page

    constructornamegetgetBooleangetNumbergetObjectgetSecretgetSecretBooleangetSecretNumbergetSecretObjectrequirerequireBooleanrequireNumberrequireObjectrequireSecretrequireSecretBooleanrequireSecretNumberrequireSecretObject

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Output<T>

    Settings

    Member Visibility

    Theme

    On This Page

    constructornamegetgetBooleangetNumbergetObjectgetSecretgetSecretBooleangetSecretNumbergetSecretObjectrequirerequireBooleanrequireNumberrequireObjectrequireSecretrequireSecretBooleanrequireSecretNumberrequireSecretObject

    Generated using TypeDoc

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    id urn

    Methods

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

    The arguments to use to populate the new resource.

  • opts: CustomResourceOptions = {}

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

  • dependency: boolean = false

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

    -
  • Optional packageRef: Promise<undefined | string>

    • Returns CustomResource

    Properties

    Readonly id

    id: Output<string>

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

  • Optional packageRef: Promise<undefined | string>

    • Returns CustomResource

    Properties

    Readonly id

    id: Output<string>

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

    -

    Readonly urn

    urn: Output<string>

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

    Readonly urn

    urn: Output<string>

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

    -

    Methods

    getProvider

    Static isInstance

    Methods

    getProvider

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is CustomResource

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstance

    Generated using TypeDoc

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

    Class DependencyProviderResource

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    id urn

    Methods

    getProvider isInstance register -

    Constructors

    constructor

    Properties

    Readonly id

    id: Output<string>

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

    Constructors

    constructor

    Properties

    Readonly id

    id: Output<string>

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

    -

    Readonly urn

    urn: Output<string>

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

    Readonly urn

    urn: Output<string>

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

    -

    Methods

    getProvider

    Static isInstance

    Methods

    getProvider

    Static isInstance

    Static register

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstanceregister

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is CustomResource

    Static register

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstanceregister

    Generated using TypeDoc

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

    Class DependencyResource

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    id urn

    Methods

    getProvider isInstance -

    Constructors

    constructor

    Properties

    Readonly id

    id: Output<string>

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

    Constructors

    constructor

    Properties

    Readonly id

    id: Output<string>

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

    -

    Readonly urn

    urn: Output<string>

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

    Readonly urn

    urn: Output<string>

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

    -

    Methods

    getProvider

    Static isInstance

    Methods

    getProvider

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is CustomResource

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/InputPropertiesError.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/InputPropertiesError.html index 7c9a75cb3a64..39f5bf9a55ac 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/InputPropertiesError.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/InputPropertiesError.html @@ -1,8 +1,8 @@ InputPropertiesError | @pulumi/pulumi

    Class InputPropertiesError

    InputPropertiesError is an error type that is used to indicate that multiple input properties have failed validation.

    The engine will pretty print this error for the user.

    -

    Hierarchy

    • Error
      • InputPropertiesError

    Constructors

    constructor +

    Hierarchy

    • Error
      • InputPropertiesError

    Constructors

    constructor

    Properties

    errors message

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    errors

    errors: InputPropertyErrorDetails[]

    message

    message: string

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorerrorsmessageisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    errors

    errors: InputPropertyErrorDetails[]

    message

    message: string

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorerrorsmessageisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/InputPropertyError.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/InputPropertyError.html index c04966034bd2..914978943755 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/InputPropertyError.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/InputPropertyError.html @@ -1,8 +1,8 @@ InputPropertyError | @pulumi/pulumi

    Class InputPropertyError

    InputPropertyError is an error type that is used to indicate that a an input property has failed validation.

    The engine will pretty print this error for the user.

    -

    Hierarchy

    • Error
      • InputPropertyError

    Constructors

    constructor +

    Hierarchy

    • Error
      • InputPropertyError

    Constructors

    constructor

    Properties

    propertyPath reason

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    propertyPath

    propertyPath: string

    reason

    reason: string

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpropertyPathreasonisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    propertyPath

    propertyPath: string

    reason

    reason: string

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpropertyPathreasonisInstance

    Generated using TypeDoc

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

    Class ProviderResourceAbstract

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    id urn

    Methods

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

    The configuration to use for this provider.

  • opts: ResourceOptions = {}

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

  • dependency: boolean = false

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

    -
  • Optional packageRef: Promise<undefined | string>

    • Returns ProviderResource

    Properties

    Readonly id

    id: Output<string>

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

  • Optional packageRef: Promise<undefined | string>

    • Returns ProviderResource

    Properties

    Readonly id

    id: Output<string>

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

    -

    Readonly urn

    urn: Output<string>

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

    Readonly urn

    urn: Output<string>

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

    -

    Methods

    getProvider

    Static isInstance

    Methods

    getProvider

    Static isInstance

    Static register

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstanceregister

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is CustomResource

    Static register

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstanceregister

    Generated using TypeDoc

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

    Class ResourceAbstract

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    urn

    Methods

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

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

  • remote: boolean = false

    True if this is a remote component resource.

  • dependency: boolean = false

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

    -
  • Optional packageRef: Promise<undefined | string>

    • Returns Resource

    Properties

    Readonly urn

    urn: Output<string>

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

  • Optional packageRef: Promise<undefined | string>

    • Returns Resource

    Properties

    Readonly urn

    urn: Output<string>

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

    -

    Methods

    getProvider

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    getProvider

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ResourceError.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ResourceError.html index 677b5bab587f..444645f544a7 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ResourceError.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/ResourceError.html @@ -3,11 +3,11 @@ the nature of the problem, clients can choose whether or not the call stack should be hidden as well. This should be very rare, and would only indicate that presenting the stack to the user would not be useful/be detrimental.

    -

    Hierarchy

    • Error
      • ResourceError

    Constructors

    constructor +

    Hierarchy

    • Error
      • ResourceError

    Constructors

    constructor

    Properties

    hideStack? resource

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Optional hideStack

    hideStack?: boolean

    resource

    resource: undefined | Resource

    Methods

    Static isInstance

    Constructors

    constructor

    Properties

    Optional hideStack

    hideStack?: boolean

    resource

    resource: undefined | Resource

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorhideStackresourceisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is ResourceError

    Settings

    Member Visibility

    Theme

    On This Page

    constructorhideStackresourceisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/RunError.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/RunError.html index 84b094b5b5ac..d5562bc9bba4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/RunError.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/RunError.html @@ -3,9 +3,9 @@ which emits the source program text and complete stack trace. This type should be rarely used. Ideally ResourceError should always be used so that as many errors as possible can be associated with a resource.

    -

    Hierarchy

    • Error
      • RunError

    Constructors

    constructor +

    Hierarchy

    • Error
      • RunError

    Constructors

    constructor

    Methods

    isInstance

    Constructors

    constructor

    • new RunError(message?): RunError

    • Parameters

      • Optional message: string

      Returns RunError

    Methods

    Static isInstance

    • isInstance(obj): obj is RunError

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

      -

      Parameters

      • obj: any

      Returns obj is RunError

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is RunError

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisInstance

    Generated using TypeDoc

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

    Class StackReference

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

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

    Parameters

    • name: string

      The unique name of the stack reference.

    • Optional args: StackReferenceArgs

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

    • Optional opts: CustomResourceOptions

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

      -

    Returns StackReference

    Properties

    Readonly id

    id: Output<string>

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

    Returns StackReference

    Properties

    Readonly id

    id: Output<string>

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

    -

    Readonly name

    name: Output<string>

    The name of the referenced stack.

    -

    Readonly outputs

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

    The outputs of the referenced stack.

    -

    Type declaration

    • [name: string]: any

    Readonly secretOutputNames

    secretOutputNames: Output<string[]>

    The names of any stack outputs which contain secrets.

    -

    Readonly urn

    urn: Output<string>

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

    Readonly name

    name: Output<string>

    The name of the referenced stack.

    +

    Readonly outputs

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

    The outputs of the referenced stack.

    +

    Type declaration

    • [name: string]: any

    Readonly secretOutputNames

    secretOutputNames: Output<string[]>

    The names of any stack outputs which contain secrets.

    +

    Readonly urn

    urn: Output<string>

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

    -

    Methods

    getOutput

    Methods

    getOutput

    getOutputDetails

    Returns Output<any>

    getOutputDetails

    getOutputValue

    • getOutputValue(name): Promise<any>

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

    Returns Promise<StackReferenceOutputDetails>

    getOutputValue

    • getOutputValue(name): Promise<any>

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

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

      Parameters

      • name: string

        The name of the stack output to fetch.

        -

      Returns Promise<any>

    getProvider

    requireOutput

    • requireOutput(name): Output<any>

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

    Returns Promise<any>

    getProvider

    requireOutput

    requireOutputValue

    • requireOutputValue(name): Promise<any>

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

    Returns Output<any>

    requireOutputValue

    • requireOutputValue(name): Promise<any>

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

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

      Parameters

      • name: string

        The name of the stack output to fetch.

        -

      Returns Promise<any>

    Static isInstance

    Returns Promise<any>

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridnameoutputssecretOutputNamesurngetOutputgetOutputDetailsgetOutputValuegetProviderrequireOutputrequireOutputValueisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is CustomResource

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridnameoutputssecretOutputNamesurngetOutputgetOutputDetailsgetOutputValuegetProviderrequireOutputrequireOutputValueisInstance

    Generated using TypeDoc

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

    Class ArchiveAbstract

    An Archive represents a collection of named assets.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Methods

    isInstance

    Constructors

    constructor

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Archive

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisInstance

    Generated using TypeDoc

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

    Class AssetAbstract

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Methods

    isInstance

    Constructors

    constructor

    Methods

    Static isInstance

    • isInstance(obj): obj is Asset

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

      -

      Parameters

      • obj: any

      Returns obj is Asset

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Asset

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisInstance

    Generated using TypeDoc

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

    Class AssetArchive

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    assets

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Readonly assets

    assets: Promise<AssetMap>

    A map of names to assets.

    -

    Methods

    Static isInstance

    • isInstance(obj): obj is Archive

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

    Constructors

    constructor

    Properties

    Readonly assets

    assets: Promise<AssetMap>

    A map of names to assets.

    +

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorassetsisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Archive

    Settings

    Member Visibility

    Theme

    On This Page

    constructorassetsisInstance

    Generated using TypeDoc

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

    Class FileArchive

    A FileArchive is a file-based archive, or a collection of file-based assets. This can be a raw directory or a single archive file in one of the supported formats (.tar, .tar.gz, or .zip).

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    path

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Readonly path

    path: Promise<string>

    The path to the asset file.

    -

    Methods

    Static isInstance

    • isInstance(obj): obj is Archive

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

    Constructors

    constructor

    Properties

    Readonly path

    path: Promise<string>

    The path to the asset file.

    +

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpathisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Archive

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpathisInstance

    Generated using TypeDoc

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

    Class FileAsset

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    path

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Readonly path

    path: Promise<string>

    The path to the asset file.

    -

    Methods

    Static isInstance

    • isInstance(obj): obj is Asset

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

    Constructors

    constructor

    Properties

    Readonly path

    path: Promise<string>

    The path to the asset file.

    +

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpathisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Asset

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpathisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteArchive.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteArchive.html index 5366092b5108..9cce7f54718e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteArchive.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteArchive.html @@ -3,11 +3,11 @@ contents: file:// is a local file (just like a FileArchive), http:// and https:// specify HTTP and HTTPS, respectively, and specific providers may recognize custom schemes.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    uri

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Readonly uri

    uri: Promise<string>

    The URI where the archive lives.

    -

    Methods

    Static isInstance

    • isInstance(obj): obj is Archive

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

    Constructors

    constructor

    Properties

    Readonly uri

    uri: Promise<string>

    The URI where the archive lives.

    +

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoruriisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Archive

    Settings

    Member Visibility

    Theme

    On This Page

    constructoruriisInstance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteAsset.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteAsset.html index fcc52c8ece17..788f264380d1 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteAsset.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/classes/asset.RemoteAsset.html @@ -3,11 +3,11 @@ a local file, http:// and https:// specify HTTP and HTTPS, respectively. Note that specific providers may recognize alternative schemes; this is merely the smallest set that all providers support.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    uri

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Readonly uri

    uri: Promise<string>

    The URI where the asset lives.

    -

    Methods

    Static isInstance

    • isInstance(obj): obj is Asset

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

    Constructors

    constructor

    Properties

    Readonly uri

    uri: Promise<string>

    The URI where the asset lives.

    +

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoruriisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Asset

    Settings

    Member Visibility

    Theme

    On This Page

    constructoruriisInstance

    Generated using TypeDoc

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

    Class StringAsset

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    text

    Methods

    isInstance -

    Constructors

    constructor

    Properties

    Readonly text

    text: Promise<string>

    The string contents.

    -

    Methods

    Static isInstance

    • isInstance(obj): obj is Asset

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

    Constructors

    constructor

    Properties

    Readonly text

    text: Promise<string>

    The string contents.

    +

    Methods

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructortextisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is Asset

    Settings

    Member Visibility

    Theme

    On This Page

    constructortextisInstance

    Generated using TypeDoc

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

    Class CommandErrorAlpha

    An error resulting from the invocation of a Pulumi command.

    -

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Class ConcurrentUpdateError

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

    -

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    -

    Implements

    Properties

    envVars +

    Implements

    Properties

    envVars program? pulumiHome? remoteExecutorImage? @@ -57,155 +57,155 @@ createStack selectStack

    Properties

    envVars

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

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

    -

    Type declaration

    • [key: string]: string

    Optional program

    program?: PulumiFn

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

    Type declaration

    • [key: string]: string

    Optional program

    program?: PulumiFn

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

    -

    Optional Readonly pulumiHome

    pulumiHome?: string

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

    Optional Readonly pulumiHome

    pulumiHome?: string

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

    -

    Optional remoteExecutorImage

    remoteExecutorImage?: ExecutorImage

    The image to use for the remote Pulumi operation.

    -

    Optional Readonly secretsProvider

    secretsProvider?: string

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

    Optional remoteExecutorImage

    remoteExecutorImage?: ExecutorImage

    The image to use for the remote Pulumi operation.

    +

    Optional Readonly secretsProvider

    secretsProvider?: string

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

    -

    Readonly workDir

    workDir: string

    The working directory to run Pulumi CLI commands in.

    -

    Accessors

    pulumiCommand

    pulumiVersion

    Readonly workDir

    workDir: string

    The working directory to run Pulumi CLI commands in.

    +

    Accessors

    pulumiCommand

    pulumiVersion

    Methods

    addEnvironments

    Methods

    addEnvironments

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

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

      Parameters

      • stackName: string

        The stack to operate on

      • Rest ...environments: string[]

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

        -

      Returns Promise<void>

    createStack

    • createStack(stackName): Promise<void>

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

    Returns Promise<void>

    createStack

    exportStack

    • exportStack(stackName): Promise<Deployment>

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

    Returns Promise<void>

    exportStack

    getAllConfig

    • getAllConfig(stackName): Promise<ConfigMap>

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

    Returns Promise<Deployment>

    getAllConfig

    getConfig

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

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

    Returns Promise<ConfigMap>

    getConfig

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

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

      Parameters

      • stackName: string

        The stack to read config from

      • key: string

        The key to use for the config lookup

      • Optional path: boolean

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

        -

      Returns Promise<ConfigValue>

    getTag

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

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

    Returns Promise<ConfigValue>

    getTag

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

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

      Parameters

      • stackName: string

        The stack to read tag metadata from.

      • key: string

        The key to use for the tag lookup.

        -

      Returns Promise<string>

    importStack

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

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

    Returns Promise<string>

    importStack

    install

    • install(opts?): Promise<void>

    • Install plugin and language dependencies needed for the project.

      +

    Returns Promise<void>

    install

    installPlugin

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

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

    Returns Promise<void>

    installPlugin

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

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

      Parameters

      • name: string

        The name of the plugin.

      • version: string

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

      • kind: string = "resource"

        The kind of plugin, defaults to "resource"

        -

      Returns Promise<void>

    installPluginFromServer

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

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

      +

    Returns Promise<void>

    installPluginFromServer

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

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

      Parameters

      • name: string

        The name of the plugin.

      • version: string

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

      • server: string

        The server to install the plugin from

        -

      Returns Promise<void>

    listEnvironments

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

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

      +

    Returns Promise<void>

    listEnvironments

    listPlugins

    listStacks

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

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

    Returns Promise<string[]>

    listPlugins

    listStacks

    listTags

    • listTags(stackName): Promise<TagMap>

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

    Returns Promise<StackSummary[]>

    listTags

    postCommandCallback

    • postCommandCallback(_): Promise<void>

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

    Returns Promise<TagMap>

    postCommandCallback

    projectSettings

    projectSettings

    refreshConfig

    refreshConfig

    removeAllConfig

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

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

    Returns Promise<ConfigMap>

    removeAllConfig

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

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

      Parameters

      • stackName: string

        The stack to operate on

      • keys: string[]

        The list of keys to remove from the underlying config

      • Optional path: boolean

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

        -

      Returns Promise<void>

    removeConfig

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

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

    Returns Promise<void>

    removeConfig

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

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

      Parameters

      • stackName: string

        The stack to operate on

      • key: string

        The config key to remove

      • Optional path: boolean

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

        -

      Returns Promise<void>

    removeEnvironment

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

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

      +

    Returns Promise<void>

    removeEnvironment

    removePlugin

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

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

      +

    Returns Promise<void>

    removePlugin

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

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

      Parameters

      • Optional name: string

        The optional name of the plugin.

      • Optional versionRange: string

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

      • kind: string = "resource"

        The kind of plugin, defaults to "resource".

        -

      Returns Promise<void>

    removeStack

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

    • Deletes the stack and all associated configuration and history.

      +

    Returns Promise<void>

    removeStack

    removeTag

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

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

      +
    • Optional opts: RemoveOptions

    Returns Promise<void>

    removeTag

    saveProjectSettings

    • saveProjectSettings(settings): Promise<void>

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

    Returns Promise<void>

    saveProjectSettings

    saveStackSettings

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

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

    Returns Promise<void>

    saveStackSettings

    selectStack

    • selectStack(stackName): Promise<void>

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

    Returns Promise<void>

    selectStack

    serializeArgsForOp

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

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

    Returns Promise<void>

    serializeArgsForOp

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

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

      -

      Parameters

      • _: string

      Returns Promise<string[]>

    setAllConfig

    setAllConfig

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

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

      Parameters

      • stackName: string

        The stack to operate on

      • config: ConfigMap

        The ConfigMap to upsert against the existing config

      • Optional path: boolean

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

        -

      Returns Promise<void>

    setConfig

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

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

    Returns Promise<void>

    setConfig

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

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

      Parameters

      • stackName: string

        The stack to operate on

      • key: string

        The config key to set

      • value: ConfigValue

        The value to set

      • Optional path: boolean

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

        -

      Returns Promise<void>

    setTag

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

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

      +

    Returns Promise<void>

    setTag

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

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

      Parameters

      • stackName: string

        The stack to operate on.

      • key: string

        The tag key to set.

      • value: string

        The tag value to set.

        -

      Returns Promise<void>

    stack

    stackOutputs

    • stackOutputs(stackName): Promise<OutputMap>

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

      +

    Returns Promise<void>

    stack

    stackOutputs

    stackSettings

    • stackSettings(stackName): Promise<StackSettings>

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

    Returns Promise<OutputMap>

    stackSettings

    whoAmI

    Static create

    • create(opts): Promise<LocalWorkspace>

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

    Returns Promise<StackSettings>

    whoAmI

    Static create

    Static createOrSelectStack

    Returns Promise<LocalWorkspace>

    Static createOrSelectStack

    Returns Promise<automation.Stack>

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

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

    Parameters

    • args: InlineProgramArgs

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

    • Optional opts: LocalWorkspaceOptions

      Additional customizations to be applied to the Workspace.

      -

    Returns Promise<automation.Stack>

    • Static createStack

    Returns Promise<automation.Stack>

    Static createStack

    Returns Promise<automation.Stack>

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

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

    Parameters

    Returns Promise<automation.Stack>

    • Static selectStack

    Returns Promise<automation.Stack>

    Static selectStack

    Returns Promise<automation.Stack>

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

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

    Parameters

    • args: InlineProgramArgs

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

    • Optional opts: LocalWorkspaceOptions

      Additional customizations to be applied to the Workspace.

      -

    Returns Promise<automation.Stack>

    • Settings

    Member Visibility

    Theme

    On This Page

    envVarsprogrampulumiHomeremoteExecutorImagesecretsProviderworkDirpulumiCommandpulumiVersionaddEnvironmentscreateStackexportStackgetAllConfiggetConfiggetTagimportStackinstallinstallPlugininstallPluginFromServerlistEnvironmentslistPluginslistStackslistTagspostCommandCallbackprojectSettingsrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremovePluginremoveStackremoveTagsaveProjectSettingssaveStackSettingsselectStackserializeArgsForOpsetAllConfigsetConfigsetTagstackstackOutputsstackSettingswhoAmIcreatecreateOrSelectStackcreateStackselectStack

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<automation.Stack>

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsprogrampulumiHomeremoteExecutorImagesecretsProviderworkDirpulumiCommandpulumiVersionaddEnvironmentscreateStackexportStackgetAllConfiggetConfiggetTagimportStackinstallinstallPlugininstallPluginFromServerlistEnvironmentslistPluginslistStackslistTagspostCommandCallbackprojectSettingsrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremovePluginremoveStackremoveTagsaveProjectSettingssaveStackSettingsselectStackserializeArgsForOpsetAllConfigsetConfigsetTagstackstackOutputsstackSettingswhoAmIcreatecreateOrSelectStackcreateStackselectStack

    Generated using TypeDoc

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

    Class PulumiCommand

    Properties

    command +PulumiCommand | @pulumi/pulumi

    Class PulumiCommand

    Properties

    command version

    Methods

    get install -

    Properties

    Readonly command

    command: string

    Readonly version

    version: null | SemVer

    Methods

    Static get

    • get(opts?): Promise<PulumiCommand>

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

    Properties

    Readonly command

    command: string

    Readonly version

    version: null | SemVer

    Methods

    Static get

    • get(opts?): Promise<PulumiCommand>

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

      -

      Parameters

      Returns Promise<PulumiCommand>

    Static install

    Settings

    Member Visibility

    Theme

    On This Page

    commandversiongetinstall

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<PulumiCommand>

    Static install

    Settings

    Member Visibility

    Theme

    On This Page

    commandversiongetinstall

    Generated using TypeDoc

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

    Class RemoteStack

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

    -

    Accessors

    name +

    Accessors

    name

    Methods

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

    Accessors

    name

    Methods

    cancel

    Methods

    cancel

    • cancel(): Promise<void>

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

      -

      Returns Promise<void>

    destroy

    destroy

    exportStack

    • exportStack(): Promise<Deployment>

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

    Returns Promise<DestroyResult>

    exportStack

    history

    history

    importStack

    importStack

    outputs

    preview

    • preview(opts?): Promise<PreviewResult>

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

    Returns Promise<void>

    outputs

    preview

    refresh

    refresh

    up

    • up(opts?): Promise<UpResult>

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

    Returns Promise<RefreshResult>

    up

    Settings

    Member Visibility

    Theme

    On This Page

    namecanceldestroyexportStackhistoryimportStackoutputspreviewrefreshup

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    namecanceldestroyexportStackhistoryimportStackoutputspreviewrefreshup

    Generated using TypeDoc

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

    Class RemoteWorkspace

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

    -

    Methods

    createOrSelectStack +

    Methods

    createOrSelectStack createStack selectStack

    Methods

    Static createOrSelectStack

    Static createStack

    Returns Promise<RemoteStack>

    Static createStack

    Static selectStack

    Returns Promise<RemoteStack>

    Static selectStack

    Settings

    Member Visibility

    Theme

    On This Page

    createOrSelectStackcreateStackselectStack

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<RemoteStack>

    Settings

    Member Visibility

    Theme

    On This Page

    createOrSelectStackcreateStackselectStack

    Generated using TypeDoc

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

    -

    Properties

    name +

    Properties

    name workspace

    Methods

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

    Properties

    Readonly name

    name: string

    The name identifying the stack.

    -

    Readonly workspace

    workspace: Workspace

    The Workspace the stack was created from.

    -

    Methods

    addEnvironments

    Readonly workspace

    workspace: Workspace

    The Workspace the stack was created from.

    +

    Methods

    addEnvironments

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

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

      Parameters

      • Rest ...environments: string[]

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

        -

      Returns Promise<void>

    cancel

    • cancel(): Promise<void>

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

    Returns Promise<void>

    cancel

    • cancel(): Promise<void>

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

      -

      Returns Promise<void>

    destroy

    destroy

    exportStack

    • exportStack(): Promise<Deployment>

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

    Returns Promise<DestroyResult>

    exportStack

    getAllConfig

    getConfig

    getAllConfig

    getConfig

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

    • Returns the config value associated with the specified key.

      Parameters

      • key: string

        The key to use for the config lookup

      • Optional path: boolean

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

        -

      Returns Promise<ConfigValue>

    getTag

    • getTag(key): Promise<string>

    • Returns the tag value associated with specified key.

      +

    Returns Promise<ConfigValue>

    getTag

    • getTag(key): Promise<string>

    • Returns the tag value associated with specified key.

      Parameters

      • key: string

        The key to use for the tag lookup.

        -

      Returns Promise<string>

    history

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

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

    Returns Promise<string>

    history

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

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

      -

      Parameters

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

      Returns Promise<UpdateSummary[]>

    import

    import

    importStack

    • importStack(state): Promise<void>

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

    Returns Promise<ImportResult>

    importStack

    info

    listEnvironments

    listTags

    outputs

    preview

    • preview(opts?): Promise<PreviewResult>

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

      +

    Returns Promise<void>

    info

    listEnvironments

    listTags

    outputs

    preview

    refresh

    refresh

    refreshConfig

    removeAllConfig

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

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

      +

    Returns Promise<RefreshResult>

    refreshConfig

    removeAllConfig

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

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

      Parameters

      • keys: string[]

        The config keys to remove.

      • Optional path: boolean

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

        -

      Returns Promise<void>

    removeConfig

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

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

      +

    Returns Promise<void>

    removeConfig

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

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

      Parameters

      • key: string

        The config key to remove.

      • Optional path: boolean

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

        -

      Returns Promise<void>

    removeEnvironment

    • removeEnvironment(environment): Promise<void>

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

      +

    Returns Promise<void>

    removeEnvironment

    • removeEnvironment(environment): Promise<void>

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

      Parameters

      • environment: string

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

        -

      Returns Promise<void>

    removeTag

    • removeTag(key): Promise<void>

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

    Returns Promise<void>

    removeTag

    • removeTag(key): Promise<void>

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

      Parameters

      • key: string

        The tag key to remove.

        -

      Returns Promise<void>

    rename

    setAllConfig

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

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

    Returns Promise<void>

    rename

    setAllConfig

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

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

      Parameters

      • config: ConfigMap

        The map of config key-value pairs to set.

      • Optional path: boolean

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

        -

      Returns Promise<void>

    setConfig

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

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

      +

    Returns Promise<void>

    setConfig

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

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

      Parameters

      • key: string

        The key to set.

      • value: ConfigValue

        The config value to set.

      • Optional path: boolean

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

        -

      Returns Promise<void>

    setTag

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

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

      +

    Returns Promise<void>

    setTag

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

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

      Parameters

      • key: string

        The tag key to set.

      • value: string

        The tag value to set.

        -

      Returns Promise<void>

    up

    • up(opts?): Promise<UpResult>

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

    Returns Promise<void>

    up

    Static create

    Static create

    Static createOrSelect

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

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

    Returns Promise<automation.Stack>

    Static createOrSelect

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

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

      Parameters

      • name: string

        The name identifying the Stack.

      • workspace: Workspace

        The Workspace the stack will be created from.

        -

      Returns Promise<automation.Stack>

    Static select

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

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

    Returns Promise<automation.Stack>

    Static select

    Settings

    Member Visibility

    Theme

    On This Page

    nameworkspaceaddEnvironmentscanceldestroyexportStackgetAllConfiggetConfiggetTaghistoryimportimportStackinfolistEnvironmentslistTagsoutputspreviewrefreshrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremoveTagrenamesetAllConfigsetConfigsetTagupcreatecreateOrSelectselect

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<automation.Stack>

    Settings

    Member Visibility

    Theme

    On This Page

    nameworkspaceaddEnvironmentscanceldestroyexportStackgetAllConfiggetConfiggetTaghistoryimportimportStackinfolistEnvironmentslistTagsoutputspreviewrefreshrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremoveTagrenamesetAllConfigsetConfigsetTagupcreatecreateOrSelectselect

    Generated using TypeDoc

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

    Class StackAlreadyExistsError

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

    -

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Class StackNotFoundError

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

    -

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Class ResourceAbstract

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    id urn

    Methods

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

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

  • Optional module: string

    The module of the resource.

  • type: string = "Resource"

    The type of the resource.

    -

    • Returns dynamic.Resource

    Properties

    Readonly id

    id: Output<string>

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

    Returns dynamic.Resource

    Properties

    Readonly id

    id: Output<string>

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

    -

    Readonly urn

    urn: Output<string>

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

    Readonly urn

    urn: Output<string>

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

    -

    Methods

    getProvider

    Static isInstance

    Methods

    getProvider

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is CustomResource

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridurngetProviderisInstance

    Generated using TypeDoc

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

    Class Stack

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    outputs urn

    Methods

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

    Constructors

    constructor

    Properties

    Readonly outputs

    outputs: Output<Inputs>

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

    -

    Readonly urn

    urn: Output<string>

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

    Constructors

    constructor

    Properties

    Readonly outputs

    outputs: Output<Inputs>

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

    +

    Readonly urn

    urn: Output<string>

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

    -

    Methods

    Protected getData

    Methods

    Protected getData

    getProvider

    initialize

    getProvider

    initialize

    Protected registerOutputs

    • registerOutputs(outputs?): void

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

    Returns Promise<Inputs>

    Protected registerOutputs

    • registerOutputs(outputs?): void

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

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

      -

      Parameters

      Returns void

    Static isInstance

    Static isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    constructoroutputsurngetDatagetProviderinitializeregisterOutputsisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns obj is ComponentResource<any>

    Settings

    Member Visibility

    Theme

    On This Page

    constructoroutputsurngetDatagetProviderinitializeregisterOutputsisInstance

    Generated using TypeDoc

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

    Enumeration DiffKind

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

    -

    Enumeration Members

    add +

    Enumeration Members

    add addReplace delete deleteReplace update updateReplace

    Enumeration Members

    add

    add: "add"

    Indicates that the property was added.

    -

    addReplace

    addReplace: "add-replace"

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

    -

    delete

    delete: "delete"

    Indicates that the property was deleted.

    -

    deleteReplace

    deleteReplace: "delete-replace"

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

    -

    update

    update: "update"

    Indicates that the property was updated.

    -

    updateReplace

    updateReplace: "update-replace"

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    addaddReplacedeletedeleteReplaceupdateupdateReplace

    Generated using TypeDoc

    \ No newline at end of file +

    addReplace

    addReplace: "add-replace"

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

    +

    delete

    delete: "delete"

    Indicates that the property was deleted.

    +

    deleteReplace

    deleteReplace: "delete-replace"

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

    +

    update

    update: "update"

    Indicates that the property was updated.

    +

    updateReplace

    updateReplace: "update-replace"

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    addaddReplacedeletedeleteReplaceupdateupdateReplace

    Generated using TypeDoc

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

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

    -

    Type Parameters

    • T

    Parameters

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

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

  • Type Parameters

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

    Parameters

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

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

  • Type Parameters

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

    Parameters

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

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

  • Type Parameters

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

    Parameters

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

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

  • Type Parameters

    • T1
    • T2
    • T3
    • T4
    • T5

    Parameters

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

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

  • Type Parameters

    • T1
    • T2
    • T3
    • T4

    Parameters

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

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

  • Type Parameters

    • T1
    • T2
    • T3

    Parameters

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

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

  • Type Parameters

    • T1
    • T2

    Parameters

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

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

  • Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T>[]>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

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

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

  • Type Parameters

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

    Parameters

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

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

  • Type Parameters

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

    Parameters

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

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

  • Type Parameters

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

    Parameters

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

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

  • Type Parameters

    • T1
    • T2
    • T3
    • T4
    • T5

    Parameters

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

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

  • Type Parameters

    • T1
    • T2
    • T3
    • T4

    Parameters

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

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

  • Type Parameters

    • T1
    • T2
    • T3

    Parameters

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

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

  • Type Parameters

    • T1
    • T2

    Parameters

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

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

  • Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T>[]>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    -

    Parameters

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

    Returns Output<URN>[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Returns Output<URN>[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Parameters

    • org: string

      The org (or user) that contains the Stack.

    • project: string

      The project that parents the Stack.

    • stack: string

      The name of the Stack.

      -

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Parameters

    • Rest ...params: any[]

    Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • Rest ...params: any[]

    Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function containsUnknowns

    • containsUnknowns(value): boolean

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

      -

      Parameters

      • value: any

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • value: any

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function createUrn

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

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

      -

      Parameters

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

      Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function deferredOutput

    • deferredOutput<T>(): [Output<T>, ((source) => void)]

    • Creates an Output whose value can be later resolved from another Output instance.

      -

      Type Parameters

      • T

      Returns [Output<T>, ((source) => void)]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Returns [Output<T>, ((source) => void)]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getAllResources

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getAllResources

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getOrganization

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getProject

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getStack

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    -

    Parameters

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

    Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isGrpcError

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isGrpcError

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isSecret

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isUnknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • val: any

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

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

    Type Parameters

    • T
    • V

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T
    • V

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

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

    Type Parameters

    • T
    • V

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T
    • V

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function jsonParse

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

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

      -

      Parameters

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

          • Parameters

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

            Returns any

      Returns Output<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

        • Parameters

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

          Returns any

    Returns Output<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function jsonStringify

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

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

      -

      Parameters

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

          • Parameters

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

            Returns any

      • Optional space: string | number

      Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

        • Parameters

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

          Returns any

    • Optional space: string | number

    Returns Output<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function debug

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

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

      -

      Parameters

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

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function error

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

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

      -

      Parameters

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

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function hasErrors

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function info

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

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

      -

      Parameters

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

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function warn

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

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

      -

      Parameters

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

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    -

    Parameters

    Returns CustomResourceOptions

  • mergeOptions(opts1, opts2): ComponentResourceOptions

  • Parameters

    Returns ComponentResourceOptions

  • mergeOptions(opts1, opts2): ResourceOptions

  • Parameters

    Returns ResourceOptions

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns CustomResourceOptions

  • mergeOptions(opts1, opts2): ComponentResourceOptions

  • Parameters

    Returns ComponentResourceOptions

  • mergeOptions(opts1, opts2): ResourceOptions

  • Parameters

    Returns ResourceOptions

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    The expected way to use this function is like so:

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

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

    Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T>>

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

  • Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T | undefined>>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T>>

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

  • Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T | undefined>>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/provider.main.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/provider.main.html index 7f3f194ba0e2..4ad44c6c81bd 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/provider.main.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/provider.main.html @@ -1 +1 @@ -main | @pulumi/pulumi

    Function main

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function main

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/resourceName.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/resourceName.html index d41cc78a1ef9..0b0e49827883 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/resourceName.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/resourceName.html @@ -1,2 +1,2 @@ resourceName | @pulumi/pulumi

    Function resourceName

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/resourceType.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/resourceType.html index 4633631b8a76..92baa89999be 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/resourceType.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/resourceType.html @@ -1,2 +1,2 @@ resourceType | @pulumi/pulumi

    Function resourceType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function allConfig

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

    • Returns a copy of the full configuration map.

      -

      Returns {
          [key: string]: string;
      }

      • [key: string]: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns {
        [key: string]: string;
    }

    • [key: string]: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function awaitStackRegistrations

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function cacheDynamicProviders

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function call

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

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

    Returns Output<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    -

    Parameters

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

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

  • Parameters

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

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

    Deprecated

    Use the computeCodePaths overload that takes a +

    Parameters

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

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

  • Parameters

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

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

    Deprecated

    Use the computeCodePaths overload that takes a CodePathOptions instead.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function deserializeProperties

    • deserializeProperties(outputsStruct, keepUnknowns?): Inputs

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

      -

      Parameters

      • outputsStruct: Struct
      • Optional keepUnknowns: boolean

      Returns Inputs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • outputsStruct: Struct
    • Optional keepUnknowns: boolean

    Returns Inputs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function deserializeProperty

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • prop: any
    • Optional keepUnknowns: boolean

    Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function disconnect

    • disconnect(): Promise<void>

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

      -

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function disconnectSync

    • disconnectSync(): void

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

      -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getCallbacks

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns ICallbackServer | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getConfig

    • getConfig(k): string | undefined

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

      -

      Parameters

      • k: string

      Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • k: string

    Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getEngine

    • getEngine(): engrpc.IEngineClient | undefined

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

      -

      Returns engrpc.IEngineClient | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns engrpc.IEngineClient | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getMaximumListeners

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getMonitor

    • getMonitor(): resrpc.IResourceMonitorClient | undefined

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

      -

      Returns resrpc.IResourceMonitorClient | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns resrpc.IResourceMonitorClient | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getOrganization

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getProject

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getResource

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getResourceModule

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getResourceModule

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getResourcePackage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getResourcePackage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getRootDirectory

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getStack

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getStackResource

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getStackResource

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function hasEngine

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function hasMonitor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    -

    Parameters

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

    Returns Promise<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Returns Promise<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function invokeOutput

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    Returns Output<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function invokeSingle

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function invokeSingle

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function invokeSingleOutput

    • invokeSingleOutput<T>(tok, props, opts?, packageRef?): Output<T>

    • Similar to the plain invokeSingle but returns the response as an output, maintaining secrets of the response, if any.

      -

      Type Parameters

      • T

      Parameters

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

      Returns Output<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

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

    Returns Output<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isDryRun

    • isDryRun(): boolean

    • Returns true if we are currently doing a preview.

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

      -

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isLegacyApplyEnabled

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRpcSecret

    • isRpcSecret(obj): boolean

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

      -

      Parameters

      • obj: any

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.mapAliasesForRequest.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.mapAliasesForRequest.html index 7defefee3a0a..08728b198034 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.mapAliasesForRequest.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/functions/runtime.mapAliasesForRequest.html @@ -1 +1 @@ -mapAliasesForRequest | @pulumi/pulumi

    Function mapAliasesForRequest

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

    • Parameters

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

      Returns Promise<aliasproto.Alias[]>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function mapAliasesForRequest

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

    • Parameters

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

      Returns Promise<aliasproto.Alias[]>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function readResource

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

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

      -

      Parameters

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function registerInvokeTransform

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    -

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function registerResourceModule

    • registerResourceModule(pkg, mod, module): void

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

      -

      Parameters

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function registerResourceOutputs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function registerResourcePackage

    • registerResourcePackage(pkg, resourcePackage): void

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

      -

      Parameters

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function registerResourceTransform

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function registerStackTransform

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function registerStackTransformation

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function resetOptions

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

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

      -

      Parameters

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

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    -

    Parameters

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

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function rpcKeepAlive

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

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

      -

      Returns (() => void)

        • (): void

        • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns (() => void)

      • (): void

      • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function runInPulumiStack

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

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

      -

      Parameters

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

          • Returns Promise<any>

      Returns Promise<Inputs | undefined>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

        • Returns Promise<any>

    Returns Promise<Inputs | undefined>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function serialize

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Parameters

    • func: Function

      The JavaScript function to serialize.

    • args: SerializeFunctionArgs = {}

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

      -

    Returns Promise<SerializedFunction>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<SerializedFunction>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function serializeFunctionAsync

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function serializeProperties

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Record<string, any>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function serializeProperty

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

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

      -

      Parameters

      Returns Promise<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function serializeResourceProperties

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function setAllConfig

    • setAllConfig(c, secretKeys?): void

    • Overwrites the configuration map.

      -

      Parameters

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

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function setConfig

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • k: string
    • v: string

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function setMockOptions

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

    • Parameters

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

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function setMockOptions

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

    • Parameters

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

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

  • Optional preview: boolean

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

  • Optional organization: string

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

    -

    • Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function setRootResource

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function supportsParameterization

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function suppressUnhandledGrpcRejections

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

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

      -

      Type Parameters

      • T

      Parameters

      • p: Promise<T>

      Returns Promise<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    • p: Promise<T>

    Returns Promise<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function terminateRpcs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function terminateRpcs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    -

    Parameters

    Returns OutputResolvers

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns OutputResolvers

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function unwrapRpcSecret

    • unwrapRpcSecret(obj): any

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

      -

      Parameters

      • obj: any

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • obj: any

    Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function secret

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T>>

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

  • Type Parameters

    • T

    Parameters

    Returns Output<Unwrap<T | undefined>>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function unsecret

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    Returns Output<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    aliases: [{ parent: pulumi.rootStackResource }]

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

    aliases: [{ parent: undefined }]

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

    Properties

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

    Properties

    name? parent? project? stack? type?

    Properties

    Optional name

    name?: Input<string>

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

    -

    Optional parent

    parent?: Resource | Input<string>

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

    Optional parent

    parent?: Resource | Input<string>

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

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

    -

    Optional project

    project?: Input<string>

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

    Optional project

    project?: Input<string>

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

    -

    Optional stack

    stack?: Input<string>

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

    Optional stack

    stack?: Input<string>

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

    -

    Optional type

    type?: Input<string>

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

    Optional type

    type?: Input<string>

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    nameparentprojectstacktype

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    nameparentprojectstacktype

    Generated using TypeDoc

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

    Interface ComponentResourceOptions

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

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

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

    Properties

    Optional aliases

    aliases?: Input<string | Alias>[]

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

    -

    Optional customTimeouts

    customTimeouts?: CustomTimeouts

    An optional customTimeouts configuration block.

    -

    Optional deletedWith

    deletedWith?: Resource

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

    Optional customTimeouts

    customTimeouts?: CustomTimeouts

    An optional customTimeouts configuration block.

    +

    Optional deletedWith

    deletedWith?: Resource

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

    -

    Optional dependsOn

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

    An optional additional explicit dependencies on other resources.

    -

    Optional id

    id?: Input<string>

    An optional existing ID to load, rather than create.

    -

    Optional ignoreChanges

    ignoreChanges?: string[]

    Ignore changes to any of the specified properties.

    -

    Optional parent

    parent?: Resource

    An optional parent resource to which this resource belongs.

    -

    Optional pluginDownloadURL

    pluginDownloadURL?: string

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

    Optional dependsOn

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

    An optional additional explicit dependencies on other resources.

    +

    Optional id

    id?: Input<string>

    An optional existing ID to load, rather than create.

    +

    Optional ignoreChanges

    ignoreChanges?: string[]

    Ignore changes to any of the specified properties.

    +

    Optional parent

    parent?: Resource

    An optional parent resource to which this resource belongs.

    +

    Optional pluginDownloadURL

    pluginDownloadURL?: string

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

    -

    Optional protect

    protect?: boolean

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

    -

    Optional provider

    provider?: ProviderResource

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

    Optional protect

    protect?: boolean

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

    +

    Optional provider

    provider?: ProviderResource

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

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

    -

    Optional providers

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

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

    Optional providers

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

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

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

    -

    Optional replaceOnChanges

    replaceOnChanges?: string[]

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

    Optional replaceOnChanges

    replaceOnChanges?: string[]

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

    -

    Optional retainOnDelete

    retainOnDelete?: boolean

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

    -

    Optional transformations

    transformations?: ResourceTransformation[]

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

    Optional retainOnDelete

    retainOnDelete?: boolean

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

    +

    Optional transformations

    transformations?: ResourceTransformation[]

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

    -

    Optional transforms

    transforms?: ResourceTransform[]

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

    Optional transforms

    transforms?: ResourceTransform[]

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

    This property is experimental.

    -

    Optional urn

    urn?: string

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

    -

    Optional version

    version?: string

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

    Optional urn

    urn?: string

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

    +

    Optional version

    version?: string

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    aliasescustomTimeoutsdeletedWithdependsOnidignoreChangesparentpluginDownloadURLprotectproviderprovidersreplaceOnChangesretainOnDeletetransformationstransformsurnversion

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    aliasescustomTimeoutsdeletedWithdependsOnidignoreChangesparentpluginDownloadURLprotectproviderprovidersreplaceOnChangesretainOnDeletetransformationstransformsurnversion

    Generated using TypeDoc

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

    Interface CustomResourceOptions

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

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

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

    -

    Optional aliases

    aliases?: Input<string | Alias>[]

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

    -

    Optional customTimeouts

    customTimeouts?: CustomTimeouts

    An optional customTimeouts configuration block.

    -

    Optional deleteBeforeReplace

    deleteBeforeReplace?: boolean

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

    Optional aliases

    aliases?: Input<string | Alias>[]

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

    +

    Optional customTimeouts

    customTimeouts?: CustomTimeouts

    An optional customTimeouts configuration block.

    +

    Optional deleteBeforeReplace

    deleteBeforeReplace?: boolean

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

    -

    Optional deletedWith

    deletedWith?: Resource

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

    Optional deletedWith

    deletedWith?: Resource

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

    -

    Optional dependsOn

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

    An optional additional explicit dependencies on other resources.

    -

    Optional id

    id?: Input<string>

    An optional existing ID to load, rather than create.

    -

    Optional ignoreChanges

    ignoreChanges?: string[]

    Ignore changes to any of the specified properties.

    -

    Optional import

    import?: string

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

    Optional dependsOn

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

    An optional additional explicit dependencies on other resources.

    +

    Optional id

    id?: Input<string>

    An optional existing ID to load, rather than create.

    +

    Optional ignoreChanges

    ignoreChanges?: string[]

    Ignore changes to any of the specified properties.

    +

    Optional import

    import?: string

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

    -

    Optional parent

    parent?: Resource

    An optional parent resource to which this resource belongs.

    -

    Optional pluginDownloadURL

    pluginDownloadURL?: string

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

    Optional parent

    parent?: Resource

    An optional parent resource to which this resource belongs.

    +

    Optional pluginDownloadURL

    pluginDownloadURL?: string

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

    -

    Optional protect

    protect?: boolean

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

    -

    Optional provider

    provider?: ProviderResource

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

    Optional protect

    protect?: boolean

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

    +

    Optional provider

    provider?: ProviderResource

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

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

    -

    Optional replaceOnChanges

    replaceOnChanges?: string[]

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

    Optional replaceOnChanges

    replaceOnChanges?: string[]

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

    -

    Optional retainOnDelete

    retainOnDelete?: boolean

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

    -

    Optional transformations

    transformations?: ResourceTransformation[]

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

    Optional retainOnDelete

    retainOnDelete?: boolean

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

    +

    Optional transformations

    transformations?: ResourceTransformation[]

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

    -

    Optional transforms

    transforms?: ResourceTransform[]

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

    Optional transforms

    transforms?: ResourceTransform[]

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

    This property is experimental.

    -

    Optional urn

    urn?: string

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

    -

    Optional version

    version?: string

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

    Optional urn

    urn?: string

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

    +

    Optional version

    version?: string

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    additionalSecretOutputsaliasescustomTimeoutsdeleteBeforeReplacedeletedWithdependsOnidignoreChangesimportparentpluginDownloadURLprotectproviderreplaceOnChangesretainOnDeletetransformationstransformsurnversion

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    additionalSecretOutputsaliasescustomTimeoutsdeleteBeforeReplacedeletedWithdependsOnidignoreChangesimportparentpluginDownloadURLprotectproviderreplaceOnChangesretainOnDeletetransformationstransformsurnversion

    Generated using TypeDoc

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

    Interface CustomTimeouts

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

    Properties

    create? +CustomTimeouts | @pulumi/pulumi

    Interface CustomTimeouts

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

    Properties

    create? delete? update?

    Properties

    Optional create

    create?: string

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

    -

    Optional delete

    delete?: string

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

    -

    Optional update

    update?: string

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    createdeleteupdate

    Generated using TypeDoc

    \ No newline at end of file +

    Optional delete

    delete?: string

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

    +

    Optional update

    update?: string

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    createdeleteupdate

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InputPropertyErrorDetails.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InputPropertyErrorDetails.html index cf967eba9d8e..a67aa4ad3de9 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InputPropertyErrorDetails.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InputPropertyErrorDetails.html @@ -1,3 +1,3 @@ -InputPropertyErrorDetails | @pulumi/pulumi

    Interface InputPropertyErrorDetails

    interface InputPropertyErrorDetails {
        propertyPath: string;
        reason: string;
    }

    Properties

    propertyPath +InputPropertyErrorDetails | @pulumi/pulumi

    Interface InputPropertyErrorDetails

    interface InputPropertyErrorDetails {
        propertyPath: string;
        reason: string;
    }

    Properties

    propertyPath reason -

    Properties

    propertyPath

    propertyPath: string

    reason

    reason: string

    Settings

    Member Visibility

    Theme

    On This Page

    propertyPathreason

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    propertyPath

    propertyPath: string

    reason

    reason: string

    Settings

    Member Visibility

    Theme

    On This Page

    propertyPathreason

    Generated using TypeDoc

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

    Interface InvokeOptions

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

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

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

    -

    Optional parent

    parent?: Resource

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

    -

    Optional pluginDownloadURL

    pluginDownloadURL?: string

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

    Optional parent

    parent?: Resource

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

    +

    Optional pluginDownloadURL

    pluginDownloadURL?: string

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

    -

    Optional provider

    provider?: ProviderResource

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

    Optional provider

    provider?: ProviderResource

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

    -

    Optional version

    version?: string

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

    Optional version

    version?: string

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    asyncparentpluginDownloadURLproviderversion

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    asyncparentpluginDownloadURLproviderversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeOutputOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeOutputOptions.html index b73acb3cad82..34e7bd30e981 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeOutputOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/InvokeOutputOptions.html @@ -1,6 +1,6 @@ InvokeOutputOptions | @pulumi/pulumi

    Interface InvokeOutputOptions

    InvokeOutputOptions is a bag of options that control the behavior of a call to runtime.invokeOutput.

    -
    interface InvokeOutputOptions {
        async?: boolean;
        dependsOn?: Input<Resource> | Input<Input<Resource>[]>;
        parent?: Resource;
        pluginDownloadURL?: string;
        provider?: ProviderResource;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    async? +
    interface InvokeOutputOptions {
        async?: boolean;
        dependsOn?: Input<Resource> | Input<Input<Resource>[]>;
        parent?: Resource;
        pluginDownloadURL?: string;
        provider?: ProviderResource;
        version?: string;
    }

    Hierarchy (view full)

    Properties

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

    -

    Optional dependsOn

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

    An optional set of additional explicit dependencies on other resources.

    -

    Optional parent

    parent?: Resource

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

    -

    Optional pluginDownloadURL

    pluginDownloadURL?: string

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

    Optional dependsOn

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

    An optional set of additional explicit dependencies on other resources.

    +

    Optional parent

    parent?: Resource

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

    +

    Optional pluginDownloadURL

    pluginDownloadURL?: string

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

    -

    Optional provider

    provider?: ProviderResource

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

    Optional provider

    provider?: ProviderResource

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

    -

    Optional version

    version?: string

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

    Optional version

    version?: string

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    asyncdependsOnparentpluginDownloadURLproviderversion

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    asyncdependsOnparentpluginDownloadURLproviderversion

    Generated using TypeDoc

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

    Interface InvokeTransformArgs

    InvokeTransformArgs is the argument bag passed to a invoke transform.

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

    Properties

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

    Properties

    args opts token

    Properties

    args

    args: Inputs

    The original args passed to the Invoke constructor.

    -

    opts

    opts: InvokeOptions

    The original invoke options passed to the Invoke constructor.

    -

    token

    token: string

    The token of the Invoke.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    argsoptstoken

    Generated using TypeDoc

    \ No newline at end of file +

    opts

    opts: InvokeOptions

    The original invoke options passed to the Invoke constructor.

    +

    token

    token: string

    The token of the Invoke.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    argsoptstoken

    Generated using TypeDoc

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

    Interface InvokeTransformResult

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

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

    Properties

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

    Properties

    args opts

    Properties

    args

    args: Inputs

    The new properties to use in place of the original args

    -

    opts

    opts: InvokeOptions

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    argsopts

    Generated using TypeDoc

    \ No newline at end of file +

    opts

    opts: InvokeOptions

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    argsopts

    Generated using TypeDoc

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

    Interface NumberConfigOptions

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

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

    Properties

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

    Properties

    max? min?

    Properties

    Optional max

    max?: number

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

    -

    Optional min

    min?: number

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    maxmin

    Generated using TypeDoc

    \ No newline at end of file +

    Optional min

    min?: number

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    maxmin

    Generated using TypeDoc

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

    Interface OutputConstructor

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

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

    Methods

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

    Methods

    create isInstance -

    Methods

    create

    isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    createisInstance

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    create

    isInstance

    Settings

    Member Visibility

    Theme

    On This Page

    createisInstance

    Generated using TypeDoc

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

    Interface OutputInstance<T>

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

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

    Type Parameters

    • T

    Methods

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

    Type Parameters

    • T

    Methods

    apply get

    Methods

    apply

    get

    get

    • get(): T

    • Retrieves the underlying value of this dependency.

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

      -

      Returns T

    Settings

    Member Visibility

    Theme

    On This Page

    applyget

    Generated using TypeDoc

    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility

    Theme

    On This Page

    applyget

    Generated using TypeDoc

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

    Interface ResourceOptions

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

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

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

    Properties

    Optional aliases

    aliases?: Input<string | Alias>[]

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

    -

    Optional customTimeouts

    customTimeouts?: CustomTimeouts

    An optional customTimeouts configuration block.

    -

    Optional deletedWith

    deletedWith?: Resource

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

    Optional customTimeouts

    customTimeouts?: CustomTimeouts

    An optional customTimeouts configuration block.

    +

    Optional deletedWith

    deletedWith?: Resource

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

    -

    Optional dependsOn

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

    An optional additional explicit dependencies on other resources.

    -

    Optional id

    id?: Input<string>

    An optional existing ID to load, rather than create.

    -

    Optional ignoreChanges

    ignoreChanges?: string[]

    Ignore changes to any of the specified properties.

    -

    Optional parent

    parent?: Resource

    An optional parent resource to which this resource belongs.

    -

    Optional pluginDownloadURL

    pluginDownloadURL?: string

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

    Optional dependsOn

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

    An optional additional explicit dependencies on other resources.

    +

    Optional id

    id?: Input<string>

    An optional existing ID to load, rather than create.

    +

    Optional ignoreChanges

    ignoreChanges?: string[]

    Ignore changes to any of the specified properties.

    +

    Optional parent

    parent?: Resource

    An optional parent resource to which this resource belongs.

    +

    Optional pluginDownloadURL

    pluginDownloadURL?: string

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

    -

    Optional protect

    protect?: boolean

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

    -

    Optional provider

    provider?: ProviderResource

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

    Optional protect

    protect?: boolean

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

    +

    Optional provider

    provider?: ProviderResource

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

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

    -

    Optional replaceOnChanges

    replaceOnChanges?: string[]

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

    Optional replaceOnChanges

    replaceOnChanges?: string[]

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

    -

    Optional retainOnDelete

    retainOnDelete?: boolean

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

    -

    Optional transformations

    transformations?: ResourceTransformation[]

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

    Optional retainOnDelete

    retainOnDelete?: boolean

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

    +

    Optional transformations

    transformations?: ResourceTransformation[]

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

    -

    Optional transforms

    transforms?: ResourceTransform[]

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

    Optional transforms

    transforms?: ResourceTransform[]

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

    This property is experimental.

    -

    Optional urn

    urn?: string

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

    -

    Optional version

    version?: string

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

    Optional urn

    urn?: string

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

    +

    Optional version

    version?: string

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    aliasescustomTimeoutsdeletedWithdependsOnidignoreChangesparentpluginDownloadURLprotectproviderreplaceOnChangesretainOnDeletetransformationstransformsurnversion

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    aliasescustomTimeoutsdeletedWithdependsOnidignoreChangesparentpluginDownloadURLprotectproviderreplaceOnChangesretainOnDeletetransformationstransformsurnversion

    Generated using TypeDoc

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

    Interface ResourceTransformArgs

    ResourceTransformArgs is the argument bag passed to a resource transform.

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

    Properties

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

    Properties

    custom name opts props type

    Properties

    custom

    custom: boolean

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

    -

    name

    name: string

    The name of the resource.

    -

    opts

    opts: ResourceOptions

    The original resource options passed to the resource constructor.

    -

    props

    props: Inputs

    The original properties passed to the resource constructor.

    -

    type

    type: string

    The type of the resource.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    customnameoptspropstype

    Generated using TypeDoc

    \ No newline at end of file +

    name

    name: string

    The name of the resource.

    +

    opts

    opts: ResourceOptions

    The original resource options passed to the resource constructor.

    +

    props

    props: Inputs

    The original properties passed to the resource constructor.

    +

    type

    type: string

    The type of the resource.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    customnameoptspropstype

    Generated using TypeDoc

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

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

    Properties

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

    Properties

    opts props

    Properties

    opts

    opts: ResourceOptions

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

    -

    props

    props: Inputs

    The new properties to use in place of the original props

    -

    Settings

    Member Visibility

    Theme

    On This Page

    optsprops

    Generated using TypeDoc

    \ No newline at end of file +

    props

    props: Inputs

    The new properties to use in place of the original props

    +

    Settings

    Member Visibility

    Theme

    On This Page

    optsprops

    Generated using TypeDoc

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

    Interface ResourceTransformationArgs

    ResourceTransformationArgs is the argument bag passed to a resource transformation.

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

    Properties

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

    Properties

    name opts props resource type

    Properties

    name

    name: string

    The name of the resource.

    -

    opts

    opts: ResourceOptions

    The original resource options passed to the resource constructor.

    -

    props

    props: Inputs

    The original properties passed to the resource constructor.

    -

    resource

    resource: Resource

    The Resource instance that is being transformed.

    -

    type

    type: string

    The type of the resource.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    nameoptspropsresourcetype

    Generated using TypeDoc

    \ No newline at end of file +

    opts

    opts: ResourceOptions

    The original resource options passed to the resource constructor.

    +

    props

    props: Inputs

    The original properties passed to the resource constructor.

    +

    resource

    resource: Resource

    The Resource instance that is being transformed.

    +

    type

    type: string

    The type of the resource.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    nameoptspropsresourcetype

    Generated using TypeDoc

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

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

    Properties

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

    Properties

    opts props

    Properties

    opts

    opts: ResourceOptions

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

    -

    props

    props: Inputs

    The new properties to use in place of the original props

    -

    Settings

    Member Visibility

    Theme

    On This Page

    optsprops

    Generated using TypeDoc

    \ No newline at end of file +

    props

    props: Inputs

    The new properties to use in place of the original props

    +

    Settings

    Member Visibility

    Theme

    On This Page

    optsprops

    Generated using TypeDoc

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

    Interface StackReferenceArgs

    The set of arguments for constructing a StackReference resource.

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

    Properties

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

    Properties

    name?

    Properties

    Optional Readonly name

    name?: Input<string>

    The name of the stack to reference.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    name

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    name

    Generated using TypeDoc

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

    Interface StackReferenceOutputDetails

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

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

    Properties

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

    Properties

    secretValue? value?

    Properties

    Optional Readonly secretValue

    secretValue?: any

    A secret value returned by the StackReference.

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

    -

    Optional Readonly value

    value?: any

    An output value returned by the StackReference.

    +

    Optional Readonly value

    value?: any

    An output value returned by the StackReference.

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    secretValuevalue

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    secretValuevalue

    Generated using TypeDoc

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

    Interface StringConfigOptions<K>

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

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

    Type Parameters

    • K extends string = string

    Properties

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

    Type Parameters

    • K extends string = string

    Properties

    allowedValues? maxLength? minLength? pattern?

    Properties

    Optional allowedValues

    allowedValues?: K[]

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

    -

    Optional maxLength

    maxLength?: number

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

    -

    Optional minLength

    minLength?: number

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

    -

    Optional pattern

    pattern?: string | RegExp

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    allowedValuesmaxLengthminLengthpattern

    Generated using TypeDoc

    \ No newline at end of file +

    Optional maxLength

    maxLength?: number

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

    +

    Optional minLength

    minLength?: number

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

    +

    Optional pattern

    pattern?: string | RegExp

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    allowedValuesmaxLengthminLengthpattern

    Generated using TypeDoc

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

    Interface ConfigValue

    An input to/output from a pulumi config command.

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

    Properties

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

    Properties

    secret? value

    Properties

    Optional secret

    secret?: boolean

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

    -

    value

    value: string

    The underlying configuration value.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    secretvalue

    Generated using TypeDoc

    \ No newline at end of file +

    value

    value: string

    The underlying configuration value.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    secretvalue

    Generated using TypeDoc

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

    Interface Deployment

    Deployment encapsulates the state of a stack deployment.

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

    Properties

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

    Properties

    deployment version

    Properties

    deployment

    deployment: any

    The pulumi deployment.

    -

    version

    version: number

    Version indicates the schema of the encoded deployment.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    deploymentversion

    Generated using TypeDoc

    \ No newline at end of file +

    version

    version: number

    Version indicates the schema of the encoded deployment.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    deploymentversion

    Generated using TypeDoc

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

    Interface DestroyOptions

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

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    color? continueOnError? debug? exclude? @@ -27,30 +27,30 @@ tracing? userAgent?

    Properties

    Optional color

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

    Colorize output.

    -

    Optional continueOnError

    continueOnError?: boolean

    Continue the operation to completion even if errors occur.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    -

    Optional exclude

    exclude?: string[]

    Specify a set of resource URNs to exclude from operations.

    -

    Optional excludeDependents

    excludeDependents?: boolean

    Exclude dependents of targets specified with exclude.

    -

    Optional excludeProtected

    excludeProtected?: boolean

    Do not destroy protected resources.

    -

    Optional importFile

    importFile?: string

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

    -

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    -

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    -

    Optional logVerbosity

    logVerbosity?: number

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

    -

    Optional message

    message?: string

    Optional message to associate with the operation.

    -

    Optional onError

    onError?: ((err) => void)

    A callback to be executed when the operation produces stderr output.

    -

    Type declaration

      • (err): void

      • Parameters

        • err: string

        Returns void

    Optional onEvent

    onEvent?: ((event) => void)

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

    -

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces stdout output.

    -

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

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

    -

    Optional previewOnly

    previewOnly?: boolean

    Only show a preview of the destroy, but don't perform the destroy itself.

    -

    Optional refresh

    refresh?: boolean

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

    -

    Optional remove

    remove?: boolean

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

    -

    Optional runProgram

    runProgram?: boolean

    Run the program in the workspace to perform the destroy.

    -

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the operation summary.

    -

    Optional signal

    signal?: AbortSignal

    A signal to abort an ongoing operation.

    -

    Optional suppressOutputs

    suppressOutputs?: boolean

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

    -

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    -

    Optional target

    target?: string[]

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

    -

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    -

    Optional tracing

    tracing?: string

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

    -

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    colorcontinueOnErrordebugexcludeexcludeDependentsexcludeProtectedimportFilelogFlowlogToStdErrlogVerbositymessageonErroronEventonOutputparallelpreviewOnlyrefreshremoverunProgramshowSecretssignalsuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file +

    Optional continueOnError

    continueOnError?: boolean

    Continue the operation to completion even if errors occur.

    +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    +

    Optional exclude

    exclude?: string[]

    Specify a set of resource URNs to exclude from operations.

    +

    Optional excludeDependents

    excludeDependents?: boolean

    Exclude dependents of targets specified with exclude.

    +

    Optional excludeProtected

    excludeProtected?: boolean

    Do not destroy protected resources.

    +

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    +

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    +

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    +

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    +

    Optional message

    message?: string

    Optional message to associate with the operation.

    +

    Optional onError

    onError?: ((err) => void)

    A callback to be executed when the operation produces stderr output.

    +

    Type declaration

      • (err): void

      • Parameters

        • err: string

        Returns void

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    +

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces stdout output.

    +

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    +

    Optional previewOnly

    previewOnly?: boolean

    Only show a preview of the destroy, but don't perform the destroy itself.

    +

    Optional refresh

    refresh?: boolean

    Refresh the state of the stack's resources against the cloud provider before running destroy.

    +

    Optional remove

    remove?: boolean

    Remove the stack and its configuration after all resources in the stack have been deleted.

    +

    Optional runProgram

    runProgram?: boolean

    Run the program in the workspace to perform the destroy.

    +

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the operation summary.

    +

    Optional signal

    signal?: AbortSignal

    A signal to abort an ongoing operation.

    +

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    +

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    +

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    +

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    +

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    +

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    colorcontinueOnErrordebugexcludeexcludeDependentsexcludeProtectedimportFilelogFlowlogToStdErrlogVerbositymessageonErroronEventonOutputparallelpreviewOnlyrefreshremoverunProgramshowSecretssignalsuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DestroyResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DestroyResult.html index 95f3795833b0..e3653809c250 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DestroyResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DestroyResult.html @@ -1,8 +1,8 @@ DestroyResult | @pulumi/pulumi

    Interface DestroyResult

    Output from destroying all resources in a Stack.

    -
    interface DestroyResult {
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    stderr +
    interface DestroyResult {
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    stderr stdout summary

    Properties

    stderr

    stderr: string

    The standard error output from the destroy.

    -

    stdout

    stdout: string

    The standard output from the destroy.

    -

    summary

    summary: UpdateSummary

    A summary of the destroy.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    stderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file +

    stdout

    stdout: string

    The standard output from the destroy.

    +

    summary

    summary: UpdateSummary

    A summary of the destroy.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    stderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DiagnosticEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DiagnosticEvent.html index 1a2df4a4d458..e35aea9438d4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DiagnosticEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DiagnosticEvent.html @@ -1,10 +1,10 @@ DiagnosticEvent | @pulumi/pulumi

    Interface DiagnosticEvent

    An event emitted whenever a diagnostic message is provided, for example errors from a cloud resource provider while trying to create or update a resource.

    -
    interface DiagnosticEvent {
        color: string;
        ephemeral?: boolean;
        message: string;
        prefix?: string;
        severity: "info" | "info#err" | "warning" | "error";
        streamID?: number;
        urn?: string;
    }

    Properties

    color +
    interface DiagnosticEvent {
        color: string;
        ephemeral?: boolean;
        message: string;
        prefix?: string;
        severity: "info" | "info#err" | "warning" | "error";
        streamID?: number;
        urn?: string;
    }

    Properties

    color ephemeral? message prefix? severity streamID? urn? -

    Properties

    color

    color: string

    Optional ephemeral

    ephemeral?: boolean

    message

    message: string

    Optional prefix

    prefix?: string

    severity

    severity: "info" | "info#err" | "warning" | "error"

    Optional streamID

    streamID?: number

    Optional urn

    urn?: string

    Settings

    Member Visibility

    Theme

    On This Page

    colorephemeralmessageprefixseveritystreamIDurn

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    color

    color: string

    Optional ephemeral

    ephemeral?: boolean

    message

    message: string

    Optional prefix

    prefix?: string

    severity

    severity: "info" | "info#err" | "warning" | "error"

    Optional streamID

    streamID?: number

    Optional urn

    urn?: string

    Settings

    Member Visibility

    Theme

    On This Page

    colorephemeralmessageprefixseveritystreamIDurn

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DockerImageCredentials.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DockerImageCredentials.html index 755558da7782..1195542f859a 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DockerImageCredentials.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.DockerImageCredentials.html @@ -1,4 +1,4 @@ DockerImageCredentials | @pulumi/pulumi

    Interface DockerImageCredentials

    Credentials for the remote execution Docker image.

    -
    interface DockerImageCredentials {
        password: string;
        username: string;
    }

    Properties

    password +
    interface DockerImageCredentials {
        password: string;
        username: string;
    }

    Properties

    password username -

    Properties

    password

    password: string

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    passwordusername

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    password

    password: string

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    passwordusername

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.EngineEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.EngineEvent.html index c8c69dedebb3..32cf746da278 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.EngineEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.EngineEvent.html @@ -1,7 +1,7 @@ EngineEvent | @pulumi/pulumi

    Interface EngineEvent

    A Pulumi engine event, such as a change to a resource or diagnostic message. This is intended to capture a discriminated union -- exactly one event field will be non-nil.

    -
    interface EngineEvent {
        cancelEvent?: CancelEvent;
        diagnosticEvent?: DiagnosticEvent;
        policyEvent?: PolicyEvent;
        preludeEvent?: PreludeEvent;
        resOpFailedEvent?: ResOpFailedEvent;
        resOutputsEvent?: ResOutputsEvent;
        resourcePreEvent?: ResourcePreEvent;
        sequence: number;
        startDebuggingEvent?: StartDebuggingEvent;
        stdoutEvent?: StdoutEngineEvent;
        summaryEvent?: SummaryEvent;
        timestamp: number;
    }

    Properties

    cancelEvent? +
    interface EngineEvent {
        cancelEvent?: CancelEvent;
        diagnosticEvent?: DiagnosticEvent;
        policyEvent?: PolicyEvent;
        preludeEvent?: PreludeEvent;
        resOpFailedEvent?: ResOpFailedEvent;
        resOutputsEvent?: ResOutputsEvent;
        resourcePreEvent?: ResourcePreEvent;
        sequence: number;
        startDebuggingEvent?: StartDebuggingEvent;
        stdoutEvent?: StdoutEngineEvent;
        summaryEvent?: SummaryEvent;
        timestamp: number;
    }

    Properties

    cancelEvent? diagnosticEvent? policyEvent? preludeEvent? @@ -14,17 +14,17 @@ summaryEvent? timestamp

    Properties

    Optional cancelEvent

    cancelEvent?: CancelEvent

    A cancellation event, if this engine event represents a cancellation.

    -

    Optional diagnosticEvent

    diagnosticEvent?: DiagnosticEvent

    A diagnostic event, if this engine event represents a diagnostic message.

    -

    Optional policyEvent

    policyEvent?: PolicyEvent

    A policy event, if this engine event represents a policy violation.

    -

    Optional preludeEvent

    preludeEvent?: PreludeEvent

    A prelude event, if this engine event represents the start of an +

    Optional diagnosticEvent

    diagnosticEvent?: DiagnosticEvent

    A diagnostic event, if this engine event represents a diagnostic message.

    +

    Optional policyEvent

    policyEvent?: PolicyEvent

    A policy event, if this engine event represents a policy violation.

    +

    Optional preludeEvent

    preludeEvent?: PreludeEvent

    A prelude event, if this engine event represents the start of an operation.

    -

    Optional resOpFailedEvent

    resOpFailedEvent?: ResOpFailedEvent

    A resource operation failed event, if this engine event represents a resource +

    Optional resOpFailedEvent

    resOpFailedEvent?: ResOpFailedEvent

    A resource operation failed event, if this engine event represents a resource operation that failed.

    -

    Optional resOutputsEvent

    resOutputsEvent?: ResOutputsEvent

    A resource outputs event, if this engine event represents a resource +

    Optional resOutputsEvent

    resOutputsEvent?: ResOutputsEvent

    A resource outputs event, if this engine event represents a resource that has been modified.

    -

    Optional resourcePreEvent

    resourcePreEvent?: ResourcePreEvent

    A resource pre-event, if this engine event represents a resource +

    Optional resourcePreEvent

    resourcePreEvent?: ResourcePreEvent

    A resource pre-event, if this engine event represents a resource about to be modified.

    -

    sequence

    sequence: number

    A unique, and monotonically increasing number for each engine event sent +

    sequence

    sequence: number

    A unique, and monotonically increasing number for each engine event sent to the Pulumi Service. Since events may be sent concurrently, and/or delayed via network routing, the sequence number is to ensure events can be placed into a total ordering.

    @@ -33,8 +33,8 @@
  • Events with a lower sequence number must have been emitted before those with a higher sequence number.
    • -

    Optional startDebuggingEvent

    startDebuggingEvent?: StartDebuggingEvent

    A debugging event, if the engine event represents a debugging message.

    -

    Optional stdoutEvent

    stdoutEvent?: StdoutEngineEvent

    A stdout event, if this engine event represents a message written to stdout.

    -

    Optional summaryEvent

    summaryEvent?: SummaryEvent

    A summary event, if this engine event represents the end of an operation.

    -

    timestamp

    timestamp: number

    Timestamp is a Unix timestamp (seconds) of when the event was emitted.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    cancelEventdiagnosticEventpolicyEventpreludeEventresOpFailedEventresOutputsEventresourcePreEventsequencestartDebuggingEventstdoutEventsummaryEventtimestamp

    Generated using TypeDoc

    \ No newline at end of file +

    Optional startDebuggingEvent

    startDebuggingEvent?: StartDebuggingEvent

    A debugging event, if the engine event represents a debugging message.

    +

    Optional stdoutEvent

    stdoutEvent?: StdoutEngineEvent

    A stdout event, if this engine event represents a message written to stdout.

    +

    Optional summaryEvent

    summaryEvent?: SummaryEvent

    A summary event, if this engine event represents the end of an operation.

    +

    timestamp

    timestamp: number

    Timestamp is a Unix timestamp (seconds) of when the event was emitted.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    cancelEventdiagnosticEventpolicyEventpreludeEventresOpFailedEventresOutputsEventresourcePreEventsequencestartDebuggingEventstdoutEventsummaryEventtimestamp

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ExecutorImage.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ExecutorImage.html index e075bc604c5a..d46cf0721441 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ExecutorImage.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ExecutorImage.html @@ -1,4 +1,4 @@ ExecutorImage | @pulumi/pulumi

    Interface ExecutorImage

    Information about the remote execution image.

    -
    interface ExecutorImage {
        credentials?: DockerImageCredentials;
        image: string;
    }

    Properties

    credentials? +
    interface ExecutorImage {
        credentials?: DockerImageCredentials;
        image: string;
    }

    Properties

    credentials? image -

    Properties

    Optional credentials

    credentials?: DockerImageCredentials

    image

    image: string

    Settings

    Member Visibility

    Theme

    On This Page

    credentialsimage

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional credentials

    credentials?: DockerImageCredentials

    image

    image: string

    Settings

    Member Visibility

    Theme

    On This Page

    credentialsimage

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.GlobalOpts.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.GlobalOpts.html index dd58d5ebdcd1..a3e95f95b593 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.GlobalOpts.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.GlobalOpts.html @@ -1,4 +1,4 @@ -GlobalOpts | @pulumi/pulumi

    Interface GlobalOpts

    interface GlobalOpts {
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        tracing?: string;
    }

    Hierarchy (view full)

    Properties

    color? +GlobalOpts | @pulumi/pulumi

    Interface GlobalOpts

    interface GlobalOpts {
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        tracing?: string;
    }

    Hierarchy (view full)

    Properties

    color? debug? importFile? logFlow? @@ -8,12 +8,12 @@ suppressProgress? tracing?

    Properties

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    -

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    -

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    -

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    -

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    -

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    -

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    -

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    colordebugimportFilelogFlowlogToStdErrlogVerbositysuppressOutputssuppressProgresstracing

    Generated using TypeDoc

    \ No newline at end of file +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    +

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    +

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    +

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    +

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    +

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    +

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    +

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    colordebugimportFilelogFlowlogToStdErrlogVerbositysuppressOutputssuppressProgresstracing

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportOptions.html index 39458ebb4f3c..4270db3b84cd 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportOptions.html @@ -1,5 +1,5 @@ ImportOptions | @pulumi/pulumi

    Interface ImportOptions

    Options controlling the behavior of a Stack.import() operation.

    -
    interface ImportOptions {
        color?: "always" | "never" | "raw" | "auto";
        converter?: string;
        converterArgs?: string[];
        debug?: boolean;
        generateCode?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        nameTable?: {
            [key: string]: string;
        };
        onOutput?: ((out) => void);
        protect?: boolean;
        resources?: ImportResource[];
        showSecrets?: boolean;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        tracing?: string;
    }

    Hierarchy (view full)

    Properties

    color? +
    interface ImportOptions {
        color?: "always" | "never" | "raw" | "auto";
        converter?: string;
        converterArgs?: string[];
        debug?: boolean;
        generateCode?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        nameTable?: {
            [key: string]: string;
        };
        onOutput?: ((out) => void);
        protect?: boolean;
        resources?: ImportResource[];
        showSecrets?: boolean;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        tracing?: string;
    }

    Hierarchy (view full)

    Properties

    color? converter? converterArgs? debug? @@ -18,23 +18,23 @@ suppressProgress? tracing?

    Properties

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    -

    Optional converter

    converter?: string

    Specify the name of a converter to import resources from.

    -

    Optional converterArgs

    converterArgs?: string[]

    Additional arguments to pass to the converter, if the user specified one.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    -

    Optional generateCode

    generateCode?: boolean

    Generate resource declaration code for the imported resources. Set to true by default.

    -

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    -

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    -

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    -

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    -

    Optional message

    message?: string

    Optional message to associate with the import operation

    -

    Optional nameTable

    nameTable?: {
        [key: string]: string;
    }

    The name table maps language names to parent and provider URNs. These names are +

    Optional converter

    converter?: string

    Specify the name of a converter to import resources from.

    +

    Optional converterArgs

    converterArgs?: string[]

    Additional arguments to pass to the converter, if the user specified one.

    +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    +

    Optional generateCode

    generateCode?: boolean

    Generate resource declaration code for the imported resources. Set to true by default.

    +

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    +

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    +

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    +

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    +

    Optional message

    message?: string

    Optional message to associate with the import operation

    +

    Optional nameTable

    nameTable?: {
        [key: string]: string;
    }

    The name table maps language names to parent and provider URNs. These names are used in the generated definitions, and should match the corresponding declarations in the source program. This table is required if any parents or providers are specified by the resources to import.

    -

    Type declaration

    • [key: string]: string

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional protect

    protect?: boolean

    Allow resources to be imported with protection from deletion enabled. Set to true by default.

    -

    Optional resources

    resources?: ImportResource[]

    The resource definitions to import into the stack

    -

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the import result summary

    -

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    -

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    -

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    colorconverterconverterArgsdebuggenerateCodeimportFilelogFlowlogToStdErrlogVerbositymessagenameTableonOutputprotectresourcesshowSecretssuppressOutputssuppressProgresstracing

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • [key: string]: string

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional protect

    protect?: boolean

    Allow resources to be imported with protection from deletion enabled. Set to true by default.

    +

    Optional resources

    resources?: ImportResource[]

    The resource definitions to import into the stack

    +

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the import result summary

    +

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    +

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    +

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    colorconverterconverterArgsdebuggenerateCodeimportFilelogFlowlogToStdErrlogVerbositymessagenameTableonOutputprotectresourcesshowSecretssuppressOutputssuppressProgresstracing

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResource.html index 86f68daf6eb6..00746406072d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResource.html @@ -1,4 +1,4 @@ -ImportResource | @pulumi/pulumi

    Interface ImportResource

    interface ImportResource {
        component?: boolean;
        id?: string;
        logicalName?: string;
        name: string;
        parent?: string;
        pluginDownloadUrl?: string;
        properties?: string[];
        provider?: string;
        remote?: boolean;
        type: string;
        version?: string;
    }

    Properties

    component? +ImportResource | @pulumi/pulumi

    Interface ImportResource

    interface ImportResource {
        component?: boolean;
        id?: string;
        logicalName?: string;
        name: string;
        parent?: string;
        pluginDownloadUrl?: string;
        properties?: string[];
        provider?: string;
        remote?: boolean;
        type: string;
        version?: string;
    }

    Properties

    component? id? logicalName? name @@ -9,7 +9,7 @@ remote? type version? -

    Properties

    Optional component

    component?: boolean

    Optional id

    id?: string

    The ID of the resource to import. The format of the ID is specific to the resource type.

    -

    Optional logicalName

    logicalName?: string

    name

    name: string

    The name of the resource to import

    -

    Optional parent

    parent?: string

    Optional pluginDownloadUrl

    pluginDownloadUrl?: string

    Optional properties

    properties?: string[]

    Optional provider

    provider?: string

    Optional remote

    remote?: boolean

    type

    type: string

    The type of the resource to import

    -

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    componentidlogicalNamenameparentpluginDownloadUrlpropertiesproviderremotetypeversion

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional component

    component?: boolean

    Optional id

    id?: string

    The ID of the resource to import. The format of the ID is specific to the resource type.

    +

    Optional logicalName

    logicalName?: string

    name

    name: string

    The name of the resource to import

    +

    Optional parent

    parent?: string

    Optional pluginDownloadUrl

    pluginDownloadUrl?: string

    Optional properties

    properties?: string[]

    Optional provider

    provider?: string

    Optional remote

    remote?: boolean

    type

    type: string

    The type of the resource to import

    +

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    componentidlogicalNamenameparentpluginDownloadUrlpropertiesproviderremotetypeversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResult.html index 73f88841f7a6..048ace3b5a55 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ImportResult.html @@ -1,6 +1,6 @@ ImportResult | @pulumi/pulumi

    Interface ImportResult

    The output from performing an import operation.

    -
    interface ImportResult {
        generatedCode: string;
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    generatedCode +
    interface ImportResult {
        generatedCode: string;
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    generatedCode stderr stdout summary -

    Properties

    generatedCode

    generatedCode: string

    stderr

    stderr: string

    stdout

    stdout: string

    summary

    summary: UpdateSummary

    Settings

    Member Visibility

    Theme

    On This Page

    generatedCodestderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    generatedCode

    generatedCode: string

    stderr

    stderr: string

    stdout

    stdout: string

    summary

    summary: UpdateSummary

    Settings

    Member Visibility

    Theme

    On This Page

    generatedCodestderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.InlineProgramArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.InlineProgramArgs.html index 6b3b15c077e0..a4120cb5deb2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.InlineProgramArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.InlineProgramArgs.html @@ -1,8 +1,8 @@ InlineProgramArgs | @pulumi/pulumi

    Interface InlineProgramArgs

    Description of a stack backed by an inline (in process) Pulumi program.

    -
    interface InlineProgramArgs {
        program: PulumiFn;
        projectName: string;
        stackName: string;
    }

    Properties

    program +
    interface InlineProgramArgs {
        program: PulumiFn;
        projectName: string;
        stackName: string;
    }

    Properties

    program projectName stackName

    Properties

    program

    program: PulumiFn

    The inline (in-process) Pulumi program to use with update and preview operations.

    -

    projectName

    projectName: string

    The associated project name.

    -

    stackName

    stackName: string

    The associated stack name.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    programprojectNamestackName

    Generated using TypeDoc

    \ No newline at end of file +

    projectName

    projectName: string

    The associated project name.

    +

    stackName

    stackName: string

    The associated stack name.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    programprojectNamestackName

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.InstallOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.InstallOptions.html index 7da85206d609..f48ef193fbc1 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.InstallOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.InstallOptions.html @@ -1,12 +1,12 @@ -InstallOptions | @pulumi/pulumi

    Interface InstallOptions

    interface InstallOptions {
        noDependencies?: boolean;
        noPlugins?: boolean;
        reinstall?: boolean;
        useLanguageVersionTools?: boolean;
    }

    Properties

    noDependencies? +InstallOptions | @pulumi/pulumi

    Interface InstallOptions

    interface InstallOptions {
        noDependencies?: boolean;
        noPlugins?: boolean;
        reinstall?: boolean;
        useLanguageVersionTools?: boolean;
    }

    Properties

    noDependencies? noPlugins? reinstall? useLanguageVersionTools?

    Properties

    Optional noDependencies

    noDependencies?: boolean

    Skip installing dependencies

    -

    Optional noPlugins

    noPlugins?: boolean

    Skip installing plugins

    -

    Optional reinstall

    reinstall?: boolean

    Reinstall plugins even if they already exist

    -

    Optional useLanguageVersionTools

    useLanguageVersionTools?: boolean

    Use language version tools to setup the language runtime before installing the dependencies. +

    Optional noPlugins

    noPlugins?: boolean

    Skip installing plugins

    +

    Optional reinstall

    reinstall?: boolean

    Reinstall plugins even if they already exist

    +

    Optional useLanguageVersionTools

    useLanguageVersionTools?: boolean

    Use language version tools to setup the language runtime before installing the dependencies. For Python this will use pyenv to install the Python version specified in a .python-version file. For Nodejs this will use fnm to install the Node.js version specified in a .nvmrc or `.node-version file.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    noDependenciesnoPluginsreinstalluseLanguageVersionTools

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    noDependenciesnoPluginsreinstalluseLanguageVersionTools

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ListOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ListOptions.html index 9a52f1321902..6e880e7bc887 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ListOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ListOptions.html @@ -1,3 +1,3 @@ -ListOptions | @pulumi/pulumi

    Interface ListOptions

    interface ListOptions {
        all?: boolean;
    }

    Properties

    all? +ListOptions | @pulumi/pulumi

    Interface ListOptions

    interface ListOptions {
        all?: boolean;
    }

    Properties

    all?

    Properties

    Optional all

    all?: boolean

    List all stacks instead of just stacks for the current project

    -

    Settings

    Member Visibility

    Theme

    On This Page

    all

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    all

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalProgramArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalProgramArgs.html index a782f44376cb..a1baf1a8cc75 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalProgramArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalProgramArgs.html @@ -1,6 +1,6 @@ LocalProgramArgs | @pulumi/pulumi

    Interface LocalProgramArgs

    Description of a stack backed by pre-existing local Pulumi CLI program.

    -
    interface LocalProgramArgs {
        stackName: string;
        workDir: string;
    }

    Properties

    stackName +
    interface LocalProgramArgs {
        stackName: string;
        workDir: string;
    }

    Properties

    stackName workDir

    Properties

    stackName

    stackName: string

    The associated stack name.

    -

    workDir

    workDir: string

    The working directory of the program.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    stackNameworkDir

    Generated using TypeDoc

    \ No newline at end of file +

    workDir

    workDir: string

    The working directory of the program.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    stackNameworkDir

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalWorkspaceOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalWorkspaceOptions.html index e11c703eb0b2..1eb1763b614d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalWorkspaceOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.LocalWorkspaceOptions.html @@ -1,6 +1,6 @@ LocalWorkspaceOptions | @pulumi/pulumi

    Interface LocalWorkspaceOptions

    Extensibility options to configure a ; e.g: settings to seed and environment variables to pass through to every command.

    -
    interface LocalWorkspaceOptions {
        envVars?: {
            [key: string]: string;
        };
        program?: PulumiFn;
        projectSettings?: ProjectSettings;
        pulumiCommand?: PulumiCommand;
        pulumiHome?: string;
        remoteExecutorImage?: ExecutorImage;
        secretsProvider?: string;
        stackSettings?: {
            [key: string]: StackSettings;
        };
        workDir?: string;
    }

    Properties

    envVars? +
    interface LocalWorkspaceOptions {
        envVars?: {
            [key: string]: string;
        };
        program?: PulumiFn;
        projectSettings?: ProjectSettings;
        pulumiCommand?: PulumiCommand;
        pulumiHome?: string;
        remoteExecutorImage?: ExecutorImage;
        secretsProvider?: string;
        stackSettings?: {
            [key: string]: StackSettings;
        };
        workDir?: string;
    }

    Properties

    envVars? program? projectSettings? pulumiCommand? @@ -10,16 +10,16 @@ stackSettings? workDir?

    Properties

    Optional envVars

    envVars?: {
        [key: string]: string;
    }

    Environment values scoped to the current workspace. These will be supplied to every Pulumi command.

    -

    Type declaration

    • [key: string]: string

    Optional program

    program?: PulumiFn

    The inline program PulumiFn to be used for preview/update +

    Type declaration

    • [key: string]: string

    Optional program

    program?: PulumiFn

    The inline program PulumiFn to be used for preview/update operations, if any. If none is specified, the stack will refer to ProjectSettings for this information.

    -

    Optional projectSettings

    projectSettings?: ProjectSettings

    The settings object for the current project.

    -

    Optional pulumiCommand

    pulumiCommand?: PulumiCommand

    The underlying Pulumi CLI.

    -

    Optional pulumiHome

    pulumiHome?: string

    The directory to override for CLI metadata

    -

    Optional remoteExecutorImage

    remoteExecutorImage?: ExecutorImage

    The image to use for the remote Pulumi operation.

    -

    Optional secretsProvider

    secretsProvider?: string

    The secrets provider to use for encryption and decryption of stack secrets. +

    Optional projectSettings

    projectSettings?: ProjectSettings

    The settings object for the current project.

    +

    Optional pulumiCommand

    pulumiCommand?: PulumiCommand

    The underlying Pulumi CLI.

    +

    Optional pulumiHome

    pulumiHome?: string

    The directory to override for CLI metadata

    +

    Optional remoteExecutorImage

    remoteExecutorImage?: ExecutorImage

    The image to use for the remote Pulumi operation.

    +

    Optional secretsProvider

    secretsProvider?: string

    The secrets provider to use for encryption and decryption of stack secrets. See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providers

    -

    Optional stackSettings

    stackSettings?: {
        [key: string]: StackSettings;
    }

    A map of stack names and corresponding settings objects.

    -

    Type declaration

    Optional workDir

    workDir?: string

    The directory to run Pulumi commands and read settings (Pulumi.yaml and +

    Optional stackSettings

    stackSettings?: {
        [key: string]: StackSettings;
    }

    A map of stack names and corresponding settings objects.

    +

    Type declaration

    Optional workDir

    workDir?: string

    The directory to run Pulumi commands and read settings (Pulumi.yaml and Pulumi.<stack>.yaml).

    -

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsprogramprojectSettingspulumiCommandpulumiHomeremoteExecutorImagesecretsProviderstackSettingsworkDir

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsprogramprojectSettingspulumiCommandpulumiHomeremoteExecutorImagesecretsProviderstackSettingsworkDir

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.OutputValue.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.OutputValue.html index 3ea1be223656..823c9ac6dd4d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.OutputValue.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.OutputValue.html @@ -1,6 +1,6 @@ OutputValue | @pulumi/pulumi

    Interface OutputValue

    An output produced by a Pulumi program as part of a stack operation.

    -
    interface OutputValue {
        secret: boolean;
        value: any;
    }

    Properties

    secret +
    interface OutputValue {
        secret: boolean;
        value: any;
    }

    Properties

    secret value

    Properties

    secret

    secret: boolean

    True if and only if the value represents a secret.

    -

    value

    value: any

    The underlying output value.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    secretvalue

    Generated using TypeDoc

    \ No newline at end of file +

    value

    value: any

    The underlying output value.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    secretvalue

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PluginInfo.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PluginInfo.html index 74e331c795c5..50437a8f5850 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PluginInfo.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PluginInfo.html @@ -1,4 +1,4 @@ -PluginInfo | @pulumi/pulumi

    Interface PluginInfo

    interface PluginInfo {
        installTime: Date;
        kind: PluginKind;
        lastUsedTime: Date;
        name: string;
        path: string;
        serverURL: string;
        size: number;
        version?: string;
    }

    Properties

    installTime +PluginInfo | @pulumi/pulumi

    Interface PluginInfo

    interface PluginInfo {
        installTime: Date;
        kind: PluginKind;
        lastUsedTime: Date;
        name: string;
        path: string;
        serverURL: string;
        size: number;
        version?: string;
    }

    Properties

    installTime kind lastUsedTime name @@ -6,4 +6,4 @@ serverURL size version? -

    Properties

    installTime

    installTime: Date

    kind

    kind: PluginKind

    lastUsedTime

    lastUsedTime: Date

    name

    name: string

    path

    path: string

    serverURL

    serverURL: string

    size

    size: number

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    installTimekindlastUsedTimenamepathserverURLsizeversion

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    installTime

    installTime: Date

    kind

    kind: PluginKind

    lastUsedTime

    lastUsedTime: Date

    name

    name: string

    path

    path: string

    serverURL

    serverURL: string

    size

    size: number

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    installTimekindlastUsedTimenamepathserverURLsizeversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PolicyEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PolicyEvent.html index 8bc41aa642fd..a3b96d9ebf96 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PolicyEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PolicyEvent.html @@ -1,5 +1,5 @@ PolicyEvent | @pulumi/pulumi

    Interface PolicyEvent

    An event emitted whenever there is a policy violation.

    -
    interface PolicyEvent {
        color: string;
        enforcementLevel: "warning" | "mandatory";
        message: string;
        policyName: string;
        policyPackName: string;
        policyPackVersion: string;
        policyPackVersionTag: string;
        resourceUrn?: string;
    }

    Properties

    color +
    interface PolicyEvent {
        color: string;
        enforcementLevel: "warning" | "mandatory";
        message: string;
        policyName: string;
        policyPackName: string;
        policyPackVersion: string;
        policyPackVersionTag: string;
        resourceUrn?: string;
    }

    Properties

    color enforcementLevel message policyName @@ -7,4 +7,4 @@ policyPackVersion policyPackVersionTag resourceUrn? -

    Properties

    color

    color: string

    enforcementLevel

    enforcementLevel: "warning" | "mandatory"

    message

    message: string

    policyName

    policyName: string

    policyPackName

    policyPackName: string

    policyPackVersion

    policyPackVersion: string

    policyPackVersionTag

    policyPackVersionTag: string

    Optional resourceUrn

    resourceUrn?: string

    Settings

    Member Visibility

    Theme

    On This Page

    colorenforcementLevelmessagepolicyNamepolicyPackNamepolicyPackVersionpolicyPackVersionTagresourceUrn

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    color

    color: string

    enforcementLevel

    enforcementLevel: "warning" | "mandatory"

    message

    message: string

    policyName

    policyName: string

    policyPackName

    policyPackName: string

    policyPackVersion

    policyPackVersion: string

    policyPackVersionTag

    policyPackVersionTag: string

    Optional resourceUrn

    resourceUrn?: string

    Settings

    Member Visibility

    Theme

    On This Page

    colorenforcementLevelmessagepolicyNamepolicyPackNamepolicyPackVersionpolicyPackVersionTagresourceUrn

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreludeEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreludeEvent.html index 215330aa36ea..d8c23e962d3a 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreludeEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreludeEvent.html @@ -1,4 +1,4 @@ PreludeEvent | @pulumi/pulumi

    Interface PreludeEvent

    An event emitted at the start of an update.

    -
    interface PreludeEvent {
        config: Record<string, string>;
    }

    Properties

    config +
    interface PreludeEvent {
        config: Record<string, string>;
    }

    Properties

    config

    Properties

    config

    config: Record<string, string>

    Configuration values that will be used during the update.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    config

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    config

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewOptions.html index 5f0ee947e9c1..55b90fc8e2c6 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewOptions.html @@ -1,5 +1,5 @@ PreviewOptions | @pulumi/pulumi

    Interface PreviewOptions

    Options controlling the behavior of a Stack.preview() operation.

    -
    interface PreviewOptions {
        attachDebugger?: boolean;
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        diff?: boolean;
        exclude?: string[];
        excludeDependents?: boolean;
        expectNoChanges?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onError?: ((err) => void);
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        plan?: string;
        policyPackConfigs?: string[];
        policyPacks?: string[];
        program?: PulumiFn;
        refresh?: boolean;
        replace?: string[];
        signal?: AbortSignal;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        targetDependents?: boolean;
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    attachDebugger? +
    interface PreviewOptions {
        attachDebugger?: boolean;
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        diff?: boolean;
        exclude?: string[];
        excludeDependents?: boolean;
        expectNoChanges?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onError?: ((err) => void);
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        plan?: string;
        policyPackConfigs?: string[];
        policyPacks?: string[];
        program?: PulumiFn;
        refresh?: boolean;
        replace?: string[];
        signal?: AbortSignal;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        targetDependents?: boolean;
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    attachDebugger? color? debug? diff? @@ -29,32 +29,32 @@ tracing? userAgent?

    Properties

    Optional attachDebugger

    attachDebugger?: boolean

    Run the process under a debugger, and pause until a debugger is attached.

    -

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    -

    Optional diff

    diff?: boolean

    Display the operation as a rich diff showing the overall change.

    -

    Optional exclude

    exclude?: string[]

    Specify a set of resource URNs to exclude from operations.

    -

    Optional excludeDependents

    excludeDependents?: boolean

    Exclude dependents of targets specified with exclude.

    -

    Optional expectNoChanges

    expectNoChanges?: boolean

    Return an error if any changes occur during this operation.

    -

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    -

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    -

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    -

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    -

    Optional message

    message?: string

    Optional message to associate with the operation.

    -

    Optional onError

    onError?: ((err) => void)

    A callback to be executed when the operation produces stdout output.

    -

    Type declaration

      • (err): void

      • Parameters

        • err: string

        Returns void

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    -

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces stderr output.

    -

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    -

    Optional plan

    plan?: string

    Plan specifies the path where the update plan should be saved.

    -

    Optional policyPackConfigs

    policyPackConfigs?: string[]

    A set of paths to JSON files containing configuration for the supplied policyPacks.

    -

    Optional policyPacks

    policyPacks?: string[]

    Run one or more policy packs as part of this operation.

    -

    Optional program

    program?: PulumiFn

    An inline (in-process) Pulumi program to execute the operation against.

    -

    Optional refresh

    refresh?: boolean

    Refresh the state of the stack's resources against the cloud provider before running preview.

    -

    Optional replace

    replace?: string[]

    Specify a set of resource URNs to replace.

    -

    Optional signal

    signal?: AbortSignal

    A signal to abort an ongoing operation.

    -

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    -

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    -

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    -

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    -

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    -

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    attachDebuggercolordebugdiffexcludeexcludeDependentsexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonErroronEventonOutputparallelplanpolicyPackConfigspolicyPacksprogramrefreshreplacesignalsuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file +

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    +

    Optional diff

    diff?: boolean

    Display the operation as a rich diff showing the overall change.

    +

    Optional exclude

    exclude?: string[]

    Specify a set of resource URNs to exclude from operations.

    +

    Optional excludeDependents

    excludeDependents?: boolean

    Exclude dependents of targets specified with exclude.

    +

    Optional expectNoChanges

    expectNoChanges?: boolean

    Return an error if any changes occur during this operation.

    +

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    +

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    +

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    +

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    +

    Optional message

    message?: string

    Optional message to associate with the operation.

    +

    Optional onError

    onError?: ((err) => void)

    A callback to be executed when the operation produces stdout output.

    +

    Type declaration

      • (err): void

      • Parameters

        • err: string

        Returns void

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    +

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces stderr output.

    +

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    +

    Optional plan

    plan?: string

    Plan specifies the path where the update plan should be saved.

    +

    Optional policyPackConfigs

    policyPackConfigs?: string[]

    A set of paths to JSON files containing configuration for the supplied policyPacks.

    +

    Optional policyPacks

    policyPacks?: string[]

    Run one or more policy packs as part of this operation.

    +

    Optional program

    program?: PulumiFn

    An inline (in-process) Pulumi program to execute the operation against.

    +

    Optional refresh

    refresh?: boolean

    Refresh the state of the stack's resources against the cloud provider before running preview.

    +

    Optional replace

    replace?: string[]

    Specify a set of resource URNs to replace.

    +

    Optional signal

    signal?: AbortSignal

    A signal to abort an ongoing operation.

    +

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    +

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    +

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    +

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    +

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    +

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    attachDebuggercolordebugdiffexcludeexcludeDependentsexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonErroronEventonOutputparallelplanpolicyPackConfigspolicyPacksprogramrefreshreplacesignalsuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewResult.html index b8b6fa4a556b..d4e91ae9b880 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PreviewResult.html @@ -1,9 +1,9 @@ PreviewResult | @pulumi/pulumi

    Interface PreviewResult

    Output from running a Pulumi program preview.

    -
    interface PreviewResult {
        changeSummary: OpMap;
        stderr: string;
        stdout: string;
    }

    Properties

    changeSummary +
    interface PreviewResult {
        changeSummary: OpMap;
        stderr: string;
        stdout: string;
    }

    Properties

    changeSummary stderr stdout

    Properties

    changeSummary

    changeSummary: OpMap

    A summary of the changes yielded by the operation (e.g. 4 unchanged, 3 created, etc.).

    -

    stderr

    stderr: string

    The standard error output from the preview.

    -

    stdout

    stdout: string

    The standard output from the preview.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    changeSummarystderrstdout

    Generated using TypeDoc

    \ No newline at end of file +

    stderr

    stderr: string

    The standard error output from the preview.

    +

    stdout

    stdout: string

    The standard output from the preview.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    changeSummarystderrstdout

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectBackend.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectBackend.html index 6216bc117a1e..6f4b46c4041b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectBackend.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectBackend.html @@ -1,3 +1,3 @@ ProjectBackend | @pulumi/pulumi

    Interface ProjectBackend

    Configuration for the project's Pulumi state storage backend.

    -
    interface ProjectBackend {
        url?: string;
    }

    Properties

    url? -

    Properties

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    url

    Generated using TypeDoc

    \ No newline at end of file +
    interface ProjectBackend {
        url?: string;
    }

    Properties

    url? +

    Properties

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    url

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectRuntimeInfo.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectRuntimeInfo.html index 16126bc07497..65427ec9223e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectRuntimeInfo.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectRuntimeInfo.html @@ -1,4 +1,4 @@ ProjectRuntimeInfo | @pulumi/pulumi

    Interface ProjectRuntimeInfo

    A description of the project's program runtime and associated metadata.

    -
    interface ProjectRuntimeInfo {
        name: string;
        options?: {
            [key: string]: any;
        };
    }

    Properties

    name +
    interface ProjectRuntimeInfo {
        name: string;
        options?: {
            [key: string]: any;
        };
    }

    Properties

    name options? -

    Properties

    name

    name: string

    Optional options

    options?: {
        [key: string]: any;
    }

    Type declaration

    • [key: string]: any

    Settings

    Member Visibility

    Theme

    On This Page

    nameoptions

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    name

    name: string

    Optional options

    options?: {
        [key: string]: any;
    }

    Type declaration

    • [key: string]: any

    Settings

    Member Visibility

    Theme

    On This Page

    nameoptions

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectSettings.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectSettings.html index ea54fead80c2..33c50855a1cc 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectSettings.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectSettings.html @@ -1,6 +1,6 @@ ProjectSettings | @pulumi/pulumi

    Interface ProjectSettings

    A Pulumi project manifest. It describes metadata applying to all sub-stacks created from the project.

    -
    interface ProjectSettings {
        author?: string;
        backend?: ProjectBackend;
        config?: string;
        description?: string;
        license?: string;
        main?: string;
        name: string;
        runtime: ProjectRuntimeInfo | ProjectRuntime;
        template?: ProjectTemplate;
        website?: string;
    }

    Properties

    author? +
    interface ProjectSettings {
        author?: string;
        backend?: ProjectBackend;
        config?: string;
        description?: string;
        license?: string;
        main?: string;
        name: string;
        runtime: ProjectRuntimeInfo | ProjectRuntime;
        template?: ProjectTemplate;
        website?: string;
    }

    Properties

    author? backend? config? description? @@ -10,4 +10,4 @@ runtime template? website? -

    Properties

    Optional author

    author?: string

    Optional backend

    backend?: ProjectBackend

    Optional config

    config?: string

    Optional description

    description?: string

    Optional license

    license?: string

    Optional main

    main?: string

    name

    name: string

    runtime

    runtime: ProjectRuntimeInfo | ProjectRuntime

    Optional template

    template?: ProjectTemplate

    Optional website

    website?: string

    Settings

    Member Visibility

    Theme

    On This Page

    authorbackendconfigdescriptionlicensemainnameruntimetemplatewebsite

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional author

    author?: string

    Optional backend

    backend?: ProjectBackend

    Optional config

    config?: string

    Optional description

    description?: string

    Optional license

    license?: string

    Optional main

    main?: string

    name

    name: string

    runtime

    runtime: ProjectRuntimeInfo | ProjectRuntime

    Optional template

    template?: ProjectTemplate

    Optional website

    website?: string

    Settings

    Member Visibility

    Theme

    On This Page

    authorbackendconfigdescriptionlicensemainnameruntimetemplatewebsite

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplate.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplate.html index 12383ddf9ab3..f4cd7e3407d2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplate.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplate.html @@ -1,6 +1,6 @@ ProjectTemplate | @pulumi/pulumi

    Interface ProjectTemplate

    A template used to seed new stacks created from this project.

    -
    interface ProjectTemplate {
        config?: {
            [key: string]: ProjectTemplateConfigValue;
        };
        description?: string;
        important?: boolean;
        quickstart?: string;
    }

    Properties

    config? +
    interface ProjectTemplate {
        config?: {
            [key: string]: ProjectTemplateConfigValue;
        };
        description?: string;
        important?: boolean;
        quickstart?: string;
    }

    Properties

    config? description? important? quickstart? -

    Properties

    Optional config

    config?: {
        [key: string]: ProjectTemplateConfigValue;
    }

    Type declaration

    Optional description

    description?: string

    Optional important

    important?: boolean

    Optional quickstart

    quickstart?: string

    Settings

    Member Visibility

    Theme

    On This Page

    configdescriptionimportantquickstart

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional config

    config?: {
        [key: string]: ProjectTemplateConfigValue;
    }

    Type declaration

    Optional description

    description?: string

    Optional important

    important?: boolean

    Optional quickstart

    quickstart?: string

    Settings

    Member Visibility

    Theme

    On This Page

    configdescriptionimportantquickstart

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplateConfigValue.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplateConfigValue.html index b4afd179b36c..1603934fb618 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplateConfigValue.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ProjectTemplateConfigValue.html @@ -1,5 +1,5 @@ ProjectTemplateConfigValue | @pulumi/pulumi

    Interface ProjectTemplateConfigValue

    A placeholder config value for a project template.

    -
    interface ProjectTemplateConfigValue {
        default?: string;
        description?: string;
        secret?: boolean;
    }

    Properties

    default? +
    interface ProjectTemplateConfigValue {
        default?: string;
        description?: string;
        secret?: boolean;
    }

    Properties

    default? description? secret? -

    Properties

    Optional default

    default?: string

    Optional description

    description?: string

    Optional secret

    secret?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    defaultdescriptionsecret

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional default

    default?: string

    Optional description

    description?: string

    Optional secret

    secret?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    defaultdescriptionsecret

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PropertyDiff.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PropertyDiff.html index 2fc1d28bfcf3..c4628585252b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PropertyDiff.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PropertyDiff.html @@ -1,7 +1,7 @@ PropertyDiff | @pulumi/pulumi

    Interface PropertyDiff

    A PropertyDiff describes the difference between a single property's old and new values.

    -
    interface PropertyDiff {
        diffKind: DiffKind;
        inputDiff: boolean;
    }

    Properties

    diffKind +
    interface PropertyDiff {
        diffKind: DiffKind;
        inputDiff: boolean;
    }

    Properties

    diffKind inputDiff

    Properties

    diffKind

    diffKind: DiffKind

    diffKind is the kind of difference.

    -

    inputDiff

    inputDiff: boolean

    inputDiff is true if this is a difference between old and new inputs +

    inputDiff

    inputDiff: boolean

    inputDiff is true if this is a difference between old and new inputs rather than old state and new inputs.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    diffKindinputDiff

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    diffKindinputDiff

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PulumiCommandOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PulumiCommandOptions.html index 297e3159e9aa..560aacbbc7a1 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PulumiCommandOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.PulumiCommandOptions.html @@ -1,8 +1,8 @@ -PulumiCommandOptions | @pulumi/pulumi

    Interface PulumiCommandOptions

    interface PulumiCommandOptions {
        root?: string;
        skipVersionCheck?: boolean;
        version?: SemVer;
    }

    Properties

    root? +PulumiCommandOptions | @pulumi/pulumi

    Interface PulumiCommandOptions

    interface PulumiCommandOptions {
        root?: string;
        skipVersionCheck?: boolean;
        version?: SemVer;
    }

    Properties

    root? skipVersionCheck? version?

    Properties

    Optional root

    root?: string

    The directory to install the CLI in or where to look for an existing installation. Defaults to $HOME/.pulumi/versions/$VERSION.

    -

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Skips the minimum CLI version check, see PULUMI_AUTOMATION_API_SKIP_VERSION_CHECK.

    -

    Optional version

    version?: SemVer

    The version of the CLI to use. Defaults to the CLI version matching the SDK version.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    rootskipVersionCheckversion

    Generated using TypeDoc

    \ No newline at end of file +

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Skips the minimum CLI version check, see PULUMI_AUTOMATION_API_SKIP_VERSION_CHECK.

    +

    Optional version

    version?: SemVer

    The version of the CLI to use. Defaults to the CLI version matching the SDK version.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    rootskipVersionCheckversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshOptions.html index 591a6036f5fa..6902419c4866 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshOptions.html @@ -1,5 +1,5 @@ RefreshOptions | @pulumi/pulumi

    Interface RefreshOptions

    Options controlling the behavior of a Stack.refresh() operation.

    -
    interface RefreshOptions {
        clearPendingCreates?: boolean;
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        exclude?: string[];
        excludeDependents?: boolean;
        expectNoChanges?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onError?: ((err) => void);
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        previewOnly?: boolean;
        runProgram?: boolean;
        showSecrets?: boolean;
        signal?: AbortSignal;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        targetDependents?: boolean;
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    clearPendingCreates? +
    interface RefreshOptions {
        clearPendingCreates?: boolean;
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        exclude?: string[];
        excludeDependents?: boolean;
        expectNoChanges?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onError?: ((err) => void);
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        previewOnly?: boolean;
        runProgram?: boolean;
        showSecrets?: boolean;
        signal?: AbortSignal;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        targetDependents?: boolean;
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    clearPendingCreates? color? debug? exclude? @@ -25,28 +25,28 @@ tracing? userAgent?

    Properties

    Optional clearPendingCreates

    clearPendingCreates?: boolean

    Clear all pending creates, dropping them from the state

    -

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    -

    Optional exclude

    exclude?: string[]

    Specify a set of resource URNs to exclude from operations.

    -

    Optional excludeDependents

    excludeDependents?: boolean

    Exclude dependents of targets specified with exclude.

    -

    Optional expectNoChanges

    expectNoChanges?: boolean

    Return an error if any changes occur during this operation.

    -

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    -

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    -

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    -

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    -

    Optional message

    message?: string

    Optional message to associate with the operation.

    -

    Optional onError

    onError?: ((err) => void)

    A callback to be executed when the operation produces stderr output.

    -

    Type declaration

      • (err): void

      • Parameters

        • err: string

        Returns void

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    -

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces stdout output.

    -

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    -

    Optional previewOnly

    previewOnly?: boolean

    Only show a preview of the refresh, but don't perform the refresh itself.

    -

    Optional runProgram

    runProgram?: boolean

    Run the program in the workspace to perform the refresh.

    -

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the operation summary.

    -

    Optional signal

    signal?: AbortSignal

    A signal to abort an ongoing operation.

    -

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    -

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    -

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    -

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    -

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    -

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    clearPendingCreatescolordebugexcludeexcludeDependentsexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonErroronEventonOutputparallelpreviewOnlyrunProgramshowSecretssignalsuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file +

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    +

    Optional exclude

    exclude?: string[]

    Specify a set of resource URNs to exclude from operations.

    +

    Optional excludeDependents

    excludeDependents?: boolean

    Exclude dependents of targets specified with exclude.

    +

    Optional expectNoChanges

    expectNoChanges?: boolean

    Return an error if any changes occur during this operation.

    +

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    +

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    +

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    +

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    +

    Optional message

    message?: string

    Optional message to associate with the operation.

    +

    Optional onError

    onError?: ((err) => void)

    A callback to be executed when the operation produces stderr output.

    +

    Type declaration

      • (err): void

      • Parameters

        • err: string

        Returns void

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    +

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces stdout output.

    +

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    +

    Optional previewOnly

    previewOnly?: boolean

    Only show a preview of the refresh, but don't perform the refresh itself.

    +

    Optional runProgram

    runProgram?: boolean

    Run the program in the workspace to perform the refresh.

    +

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the operation summary.

    +

    Optional signal

    signal?: AbortSignal

    A signal to abort an ongoing operation.

    +

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    +

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    +

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    +

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    +

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    +

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    clearPendingCreatescolordebugexcludeexcludeDependentsexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonErroronEventonOutputparallelpreviewOnlyrunProgramshowSecretssignalsuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshResult.html index 147d5340bbf8..189537a37533 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RefreshResult.html @@ -1,8 +1,8 @@ RefreshResult | @pulumi/pulumi

    Interface RefreshResult

    Output from refreshing the resources in a given Stack.

    -
    interface RefreshResult {
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    stderr +
    interface RefreshResult {
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    stderr stdout summary

    Properties

    stderr

    stderr: string

    The standard error output from the refresh.

    -

    stdout

    stdout: string

    The standard output from the refresh.

    -

    summary

    summary: UpdateSummary

    A summary of the refresh.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    stderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file +

    stdout

    stdout: string

    The standard output from the refresh.

    +

    summary

    summary: UpdateSummary

    A summary of the refresh.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    stderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteDestroyOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteDestroyOptions.html index 55ab24fc32cc..677bc5fc8b45 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteDestroyOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteDestroyOptions.html @@ -1,4 +1,4 @@ RemoteDestroyOptions | @pulumi/pulumi

    Interface RemoteDestroyOptions

    Options controlling the behavior of a RemoteStack.destroy operation.

    -
    interface RemoteDestroyOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? +
    interface RemoteDestroyOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? onOutput? -

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitAuthArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitAuthArgs.html index afab7875114b..8c07fe2d4c9f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitAuthArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitAuthArgs.html @@ -6,17 +6,17 @@
  • Username and password (basic authentication)

    • Only one authentication path is valid.

    -
    interface RemoteGitAuthArgs {
        password?: string;
        personalAccessToken?: string;
        sshPrivateKey?: string;
        sshPrivateKeyPath?: string;
        username?: string;
    }

    Properties

    password? +
    interface RemoteGitAuthArgs {
        password?: string;
        personalAccessToken?: string;
        sshPrivateKey?: string;
        sshPrivateKeyPath?: string;
        username?: string;
    }

    Properties

    password? personalAccessToken? sshPrivateKey? sshPrivateKeyPath? username?

    Properties

    Optional password

    password?: string

    The password that pairs with a username as part of basic authentication, or the passphrase to be used with an SSH private key.

    -

    Optional personalAccessToken

    personalAccessToken?: string

    A Git personal access token, to be used in replacement of a password.

    -

    Optional sshPrivateKey

    sshPrivateKey?: string

    A string containing the contents of a private key to be used for access +

    Optional personalAccessToken

    personalAccessToken?: string

    A Git personal access token, to be used in replacement of a password.

    +

    Optional sshPrivateKey

    sshPrivateKey?: string

    A string containing the contents of a private key to be used for access to the Git repository.

    -

    Optional sshPrivateKeyPath

    sshPrivateKeyPath?: string

    The absolute path to a private key to be used for access to the Git repository.

    -

    Optional username

    username?: string

    The username to use when authenticating to a Git repository with basic +

    Optional sshPrivateKeyPath

    sshPrivateKeyPath?: string

    The absolute path to a private key to be used for access to the Git repository.

    +

    Optional username

    username?: string

    The username to use when authenticating to a Git repository with basic authentication.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    passwordpersonalAccessTokensshPrivateKeysshPrivateKeyPathusername

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    passwordpersonalAccessTokensshPrivateKeysshPrivateKeyPathusername

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitProgramArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitProgramArgs.html index 35b4b75fcac9..c9edc6e37699 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitProgramArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteGitProgramArgs.html @@ -1,14 +1,14 @@ RemoteGitProgramArgs | @pulumi/pulumi

    Interface RemoteGitProgramArgs

    Description of a stack backed by a remote Pulumi program in a Git repository.

    -
    interface RemoteGitProgramArgs {
        auth?: RemoteGitAuthArgs;
        branch?: string;
        commitHash?: string;
        projectPath?: string;
        stackName: string;
        url?: string;
    }

    Properties

    auth? +
    interface RemoteGitProgramArgs {
        auth?: RemoteGitAuthArgs;
        branch?: string;
        commitHash?: string;
        projectPath?: string;
        stackName: string;
        url?: string;
    }

    Properties

    auth? branch? commitHash? projectPath? stackName url?

    Properties

    Optional auth

    auth?: RemoteGitAuthArgs

    Authentication options for the repository.

    -

    Optional branch

    branch?: string

    An optional branch to checkout.

    -

    Optional commitHash

    commitHash?: string

    Optional commit to checkout.

    -

    Optional projectPath

    projectPath?: string

    An optional path relative to the repo root specifying location of the Pulumi program.

    -

    stackName

    stackName: string

    The associated stack name.

    -

    Optional url

    url?: string

    The URL of the repository.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    authbranchcommitHashprojectPathstackNameurl

    Generated using TypeDoc

    \ No newline at end of file +

    Optional branch

    branch?: string

    An optional branch to checkout.

    +

    Optional commitHash

    commitHash?: string

    Optional commit to checkout.

    +

    Optional projectPath

    projectPath?: string

    An optional path relative to the repo root specifying location of the Pulumi program.

    +

    stackName

    stackName: string

    The associated stack name.

    +

    Optional url

    url?: string

    The URL of the repository.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    authbranchcommitHashprojectPathstackNameurl

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemotePreviewOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemotePreviewOptions.html index 03b2ade55504..38d471f29eb6 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemotePreviewOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemotePreviewOptions.html @@ -1,4 +1,4 @@ RemotePreviewOptions | @pulumi/pulumi

    Interface RemotePreviewOptions

    Options controlling the behavior of a RemoteStack.preview operation.

    -
    interface RemotePreviewOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? +
    interface RemotePreviewOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? onOutput? -

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteRefreshOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteRefreshOptions.html index 0edb37967253..224188ed462e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteRefreshOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteRefreshOptions.html @@ -1,4 +1,4 @@ RemoteRefreshOptions | @pulumi/pulumi

    Interface RemoteRefreshOptions

    Options controlling the behavior of a RemoteStack.refresh operation.

    -
    interface RemoteRefreshOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? +
    interface RemoteRefreshOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? onOutput? -

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteUpOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteUpOptions.html index a209f6304b8a..a5f7b5c17439 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteUpOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteUpOptions.html @@ -1,4 +1,4 @@ RemoteUpOptions | @pulumi/pulumi

    Interface RemoteUpOptions

    Options controlling the behavior of a RemoteStack.up operation.

    -
    interface RemoteUpOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? +
    interface RemoteUpOptions {
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
    }

    Properties

    onEvent? onOutput? -

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional onEvent

    onEvent?: ((event) => void)

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    onEventonOutput

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteWorkspaceOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteWorkspaceOptions.html index f2d884b1adf1..82ab54122dbb 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteWorkspaceOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoteWorkspaceOptions.html @@ -1,16 +1,16 @@ RemoteWorkspaceOptions | @pulumi/pulumi

    Interface RemoteWorkspaceOptions

    Extensibility options to configure a RemoteWorkspace.

    -
    interface RemoteWorkspaceOptions {
        envVars?: {
            [key: string]: string | {
                secret: string;
            };
        };
        executorImage?: ExecutorImage;
        inheritSettings?: boolean;
        preRunCommands?: string[];
        skipInstallDependencies?: boolean;
    }

    Properties

    envVars? +
    interface RemoteWorkspaceOptions {
        envVars?: {
            [key: string]: string | {
                secret: string;
            };
        };
        executorImage?: ExecutorImage;
        inheritSettings?: boolean;
        preRunCommands?: string[];
        skipInstallDependencies?: boolean;
    }

    Properties

    envVars? executorImage? inheritSettings? preRunCommands? skipInstallDependencies?

    Properties

    Optional envVars

    envVars?: {
        [key: string]: string | {
            secret: string;
        };
    }

    Environment values scoped to the remote workspace. These will be passed to remote operations.

    -

    Type declaration

    • [key: string]: string | {
          secret: string;
      }

    Optional executorImage

    executorImage?: ExecutorImage

    The image to use for the remote executor.

    -

    Optional inheritSettings

    inheritSettings?: boolean

    Whether to inherit the deployment settings set on the stack. Defaults to +

    Type declaration

    • [key: string]: string | {
          secret: string;
      }

    Optional executorImage

    executorImage?: ExecutorImage

    The image to use for the remote executor.

    +

    Optional inheritSettings

    inheritSettings?: boolean

    Whether to inherit the deployment settings set on the stack. Defaults to false.

    -

    Optional preRunCommands

    preRunCommands?: string[]

    An optional list of arbitrary commands to run before a remote Pulumi +

    Optional preRunCommands

    preRunCommands?: string[]

    An optional list of arbitrary commands to run before a remote Pulumi operation is invoked.

    -

    Optional skipInstallDependencies

    skipInstallDependencies?: boolean

    Whether to skip the default dependency installation step. Defaults to +

    Optional skipInstallDependencies

    skipInstallDependencies?: boolean

    Whether to skip the default dependency installation step. Defaults to false.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsexecutorImageinheritSettingspreRunCommandsskipInstallDependencies

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsexecutorImageinheritSettingspreRunCommandsskipInstallDependencies

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoveOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoveOptions.html index d9ca65620ae0..2546f8aacaa8 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoveOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RemoveOptions.html @@ -1,5 +1,5 @@ -RemoveOptions | @pulumi/pulumi

    Interface RemoveOptions

    interface RemoveOptions {
        force?: boolean;
        preserveConfig?: boolean;
    }

    Properties

    force? +RemoveOptions | @pulumi/pulumi

    Interface RemoveOptions

    interface RemoveOptions {
        force?: boolean;
        preserveConfig?: boolean;
    }

    Properties

    force? preserveConfig?

    Properties

    Optional force

    force?: boolean

    Forces deletion of the stack, leaving behind any resources managed by the stack

    -

    Optional preserveConfig

    preserveConfig?: boolean

    Do not delete the corresponding Pulumi..yaml configuration file for the stack

    -

    Settings

    Member Visibility

    Theme

    On This Page

    forcepreserveConfig

    Generated using TypeDoc

    \ No newline at end of file +

    Optional preserveConfig

    preserveConfig?: boolean

    Do not delete the corresponding Pulumi..yaml configuration file for the stack

    +

    Settings

    Member Visibility

    Theme

    On This Page

    forcepreserveConfig

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RenameOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RenameOptions.html index 7b1c7a4c5683..472e1df05c52 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RenameOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RenameOptions.html @@ -1,5 +1,5 @@ RenameOptions | @pulumi/pulumi

    Interface RenameOptions

    Options controlling the behavior of a Stack.rename() operation.

    -
    interface RenameOptions {
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        onError?: ((err) => void);
        onOutput?: ((out) => void);
        showSecrets?: boolean;
        signal?: AbortSignal;
        stackName: string;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        tracing?: string;
    }

    Hierarchy (view full)

    Properties

    color? +
    interface RenameOptions {
        color?: "always" | "never" | "raw" | "auto";
        debug?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        onError?: ((err) => void);
        onOutput?: ((out) => void);
        showSecrets?: boolean;
        signal?: AbortSignal;
        stackName: string;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        tracing?: string;
    }

    Hierarchy (view full)

    Properties

    color? debug? importFile? logFlow? @@ -14,17 +14,17 @@ suppressProgress? tracing?

    Properties

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    -

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    -

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    -

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    -

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    -

    Optional onError

    onError?: ((err) => void)

    A callback to be executed when the operation produces stderr output.

    -

    Type declaration

      • (err): void

      • Parameters

        • err: string

        Returns void

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces stdout output.

    -

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the UpSummary.

    -

    Optional signal

    signal?: AbortSignal

    A signal to abort an ongoing operation.

    -

    stackName

    stackName: string

    The new name for the stack.

    -

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    -

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    -

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    colordebugimportFilelogFlowlogToStdErrlogVerbosityonErroronOutputshowSecretssignalstackNamesuppressOutputssuppressProgresstracing

    Generated using TypeDoc

    \ No newline at end of file +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    +

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    +

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    +

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    +

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    +

    Optional onError

    onError?: ((err) => void)

    A callback to be executed when the operation produces stderr output.

    +

    Type declaration

      • (err): void

      • Parameters

        • err: string

        Returns void

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces stdout output.

    +

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the UpSummary.

    +

    Optional signal

    signal?: AbortSignal

    A signal to abort an ongoing operation.

    +

    stackName

    stackName: string

    The new name for the stack.

    +

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    +

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    +

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    colordebugimportFilelogFlowlogToStdErrlogVerbosityonErroronOutputshowSecretssignalstackNamesuppressOutputssuppressProgresstracing

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RenameResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RenameResult.html index 9ab9c31109ed..a78688f6426d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RenameResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.RenameResult.html @@ -1,8 +1,8 @@ RenameResult | @pulumi/pulumi

    Interface RenameResult

    Output from renaming the Stack.

    -
    interface RenameResult {
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    stderr +
    interface RenameResult {
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    stderr stdout summary

    Properties

    stderr

    stderr: string

    The standard error output from the rename.

    -

    stdout

    stdout: string

    The standard output from the rename.

    -

    summary

    summary: UpdateSummary

    A summary of the rename.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    stderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file +

    stdout

    stdout: string

    The standard output from the rename.

    +

    summary

    summary: UpdateSummary

    A summary of the rename.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    stderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOpFailedEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOpFailedEvent.html index 9ff4483f47eb..a0c96cc2430e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOpFailedEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOpFailedEvent.html @@ -1,8 +1,8 @@ ResOpFailedEvent | @pulumi/pulumi

    Interface ResOpFailedEvent

    An event emitted when a resource operation fails. Typically a DiagnosticEvent is emitted before this event, indicating the root cause of the error.

    -
    interface ResOpFailedEvent {
        metadata: StepEventMetadata;
        status: number;
        steps: number;
    }

    Properties

    metadata +
    interface ResOpFailedEvent {
        metadata: StepEventMetadata;
        status: number;
        steps: number;
    }

    Properties

    metadata status steps

    Properties

    metadata

    metadata: StepEventMetadata

    Metadata for the event.

    -

    status

    status: number

    steps

    steps: number

    Settings

    Member Visibility

    Theme

    On This Page

    metadatastatussteps

    Generated using TypeDoc

    \ No newline at end of file +

    status

    status: number

    steps

    steps: number

    Settings

    Member Visibility

    Theme

    On This Page

    metadatastatussteps

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOutputsEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOutputsEvent.html index 57b5c6c9d6e3..e2de77e30d5f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOutputsEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResOutputsEvent.html @@ -1,5 +1,5 @@ ResOutputsEvent | @pulumi/pulumi

    Interface ResOutputsEvent

    An event emitted when a resource is finished being provisioned.

    -
    interface ResOutputsEvent {
        metadata: StepEventMetadata;
        planning?: boolean;
    }

    Properties

    metadata +
    interface ResOutputsEvent {
        metadata: StepEventMetadata;
        planning?: boolean;
    }

    Properties

    metadata planning?

    Properties

    metadata

    metadata: StepEventMetadata

    Metadata for the event.

    -

    Optional planning

    planning?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    metadataplanning

    Generated using TypeDoc

    \ No newline at end of file +

    Optional planning

    planning?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    metadataplanning

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResourcePreEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResourcePreEvent.html index 01e73e1f83e6..675b7f1144d4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResourcePreEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.ResourcePreEvent.html @@ -1,5 +1,5 @@ ResourcePreEvent | @pulumi/pulumi

    Interface ResourcePreEvent

    An event emitted before a resource is modified.

    -
    interface ResourcePreEvent {
        metadata: StepEventMetadata;
        planning?: boolean;
    }

    Properties

    metadata +
    interface ResourcePreEvent {
        metadata: StepEventMetadata;
        planning?: boolean;
    }

    Properties

    metadata planning?

    Properties

    metadata

    metadata: StepEventMetadata

    Metadata for the event.

    -

    Optional planning

    planning?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    metadataplanning

    Generated using TypeDoc

    \ No newline at end of file +

    Optional planning

    planning?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    metadataplanning

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettings.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettings.html index 996a0e054474..1b1bb71970aa 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettings.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettings.html @@ -1,6 +1,6 @@ StackSettings | @pulumi/pulumi

    Interface StackSettings

    A description of a Stack's configuration and encryption metadata.

    -
    interface StackSettings {
        config?: {
            [key: string]: StackSettingsConfigValue;
        };
        encryptedKey?: string;
        encryptionSalt?: string;
        secretsProvider?: string;
    }

    Properties

    config? +
    interface StackSettings {
        config?: {
            [key: string]: StackSettingsConfigValue;
        };
        encryptedKey?: string;
        encryptionSalt?: string;
        secretsProvider?: string;
    }

    Properties

    config? encryptedKey? encryptionSalt? secretsProvider? -

    Properties

    Optional config

    config?: {
        [key: string]: StackSettingsConfigValue;
    }

    Type declaration

    Optional encryptedKey

    encryptedKey?: string

    Optional encryptionSalt

    encryptionSalt?: string

    Optional secretsProvider

    secretsProvider?: string

    Settings

    Member Visibility

    Theme

    On This Page

    configencryptedKeyencryptionSaltsecretsProvider

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional config

    config?: {
        [key: string]: StackSettingsConfigValue;
    }

    Type declaration

    Optional encryptedKey

    encryptedKey?: string

    Optional encryptionSalt

    encryptionSalt?: string

    Optional secretsProvider

    secretsProvider?: string

    Settings

    Member Visibility

    Theme

    On This Page

    configencryptedKeyencryptionSaltsecretsProvider

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettingsSecureConfigValue.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettingsSecureConfigValue.html index 617442c390f7..4209e0459726 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettingsSecureConfigValue.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSettingsSecureConfigValue.html @@ -1,3 +1,3 @@ StackSettingsSecureConfigValue | @pulumi/pulumi

    Interface StackSettingsSecureConfigValue

    A secret stack configuration entry.

    -
    interface StackSettingsSecureConfigValue {
        secure: string;
    }

    Properties

    secure -

    Properties

    secure

    secure: string

    Settings

    Member Visibility

    Theme

    On This Page

    secure

    Generated using TypeDoc

    \ No newline at end of file +
    interface StackSettingsSecureConfigValue {
        secure: string;
    }

    Properties

    secure +

    Properties

    secure

    secure: string

    Settings

    Member Visibility

    Theme

    On This Page

    secure

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSummary.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSummary.html index 5375a8ba1da6..a689973be930 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSummary.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StackSummary.html @@ -1,8 +1,8 @@ StackSummary | @pulumi/pulumi

    Interface StackSummary

    A summary of the status of a given stack.

    -
    interface StackSummary {
        current: boolean;
        lastUpdate?: string;
        name: string;
        resourceCount?: number;
        updateInProgress?: boolean;
        url?: string;
    }

    Properties

    current +
    interface StackSummary {
        current: boolean;
        lastUpdate?: string;
        name: string;
        resourceCount?: number;
        updateInProgress?: boolean;
        url?: string;
    }

    Properties

    current lastUpdate? name resourceCount? updateInProgress? url? -

    Properties

    current

    current: boolean

    Optional lastUpdate

    lastUpdate?: string

    name

    name: string

    Optional resourceCount

    resourceCount?: number

    Optional updateInProgress

    updateInProgress?: boolean

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    currentlastUpdatenameresourceCountupdateInProgressurl

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    current

    current: boolean

    Optional lastUpdate

    lastUpdate?: string

    name

    name: string

    Optional resourceCount

    resourceCount?: number

    Optional updateInProgress

    updateInProgress?: boolean

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    currentlastUpdatenameresourceCountupdateInProgressurl

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StartDebuggingEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StartDebuggingEvent.html index 8af62234bfd5..f72839962879 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StartDebuggingEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StartDebuggingEvent.html @@ -1,4 +1,4 @@ StartDebuggingEvent | @pulumi/pulumi

    Interface StartDebuggingEvent

    An event emitted when a debugger has been started and is waiting for the user to attach to it using the DAP protocol.

    -
    interface StartDebuggingEvent {
        config: Record<string, any>;
    }

    Properties

    config -

    Properties

    config

    config: Record<string, any>

    Settings

    Member Visibility

    Theme

    On This Page

    config

    Generated using TypeDoc

    \ No newline at end of file +
    interface StartDebuggingEvent {
        config: Record<string, any>;
    }

    Properties

    config +

    Properties

    config

    config: Record<string, any>

    Settings

    Member Visibility

    Theme

    On This Page

    config

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StdoutEngineEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StdoutEngineEvent.html index d1a619467486..d3ccf4bdf432 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StdoutEngineEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StdoutEngineEvent.html @@ -1,5 +1,5 @@ StdoutEngineEvent | @pulumi/pulumi

    Interface StdoutEngineEvent

    An event emitted whenever a generic message is written, for example warnings from the pulumi CLI itself. Less common than DiagnosticEvent

    -
    interface StdoutEngineEvent {
        color: string;
        message: string;
    }

    Properties

    color +
    interface StdoutEngineEvent {
        color: string;
        message: string;
    }

    Properties

    color message -

    Properties

    color

    color: string

    message

    message: string

    Settings

    Member Visibility

    Theme

    On This Page

    colormessage

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    color

    color: string

    message

    message: string

    Settings

    Member Visibility

    Theme

    On This Page

    colormessage

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventMetadata.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventMetadata.html index bb46a372faa0..cb0daf6a15be 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventMetadata.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventMetadata.html @@ -1,7 +1,7 @@ StepEventMetadata | @pulumi/pulumi

    Interface StepEventMetadata

    StepEventMetadata describes a "step" within the Pulumi engine, which is any concrete action to migrate a set of cloud resources from one state to another.

    -
    interface StepEventMetadata {
        detailedDiff?: Record<string, PropertyDiff>;
        diffs?: string[];
        keys?: string[];
        logical?: boolean;
        new?: StepEventStateMetadata;
        old?: StepEventStateMetadata;
        op: OpType;
        provider: string;
        type: string;
        urn: string;
    }

    Properties

    detailedDiff? +
    interface StepEventMetadata {
        detailedDiff?: Record<string, PropertyDiff>;
        diffs?: string[];
        keys?: string[];
        logical?: boolean;
        new?: StepEventStateMetadata;
        old?: StepEventStateMetadata;
        op: OpType;
        provider: string;
        type: string;
        urn: string;
    }

    Properties

    detailedDiff? diffs? keys? logical? @@ -12,13 +12,13 @@ type urn

    Properties

    Optional detailedDiff

    detailedDiff?: Record<string, PropertyDiff>

    The diff for this step as a list of property paths and difference types.

    -

    Optional diffs

    diffs?: string[]

    Keys that changed with this step.

    -

    Optional keys

    keys?: string[]

    Keys causing a replacement (only applicable for "create" and "replace" Ops).

    -

    Optional logical

    logical?: boolean

    Logical is set if the step is a logical operation in the program.

    -

    Optional new

    new?: StepEventStateMetadata

    New is the state of the resource after performing the step.

    -

    Optional old

    old?: StepEventStateMetadata

    Old is the state of the resource before performing the step.

    -

    op

    op: OpType

    The type of operation being performed.

    -

    provider

    provider: string

    Provider actually performing the step.

    -

    type

    type: string

    The type of the resource being operated on.

    -

    urn

    urn: string

    The URN of the resource being operated on.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    detailedDiffdiffskeyslogicalnewoldopprovidertypeurn

    Generated using TypeDoc

    \ No newline at end of file +

    Optional diffs

    diffs?: string[]

    Keys that changed with this step.

    +

    Optional keys

    keys?: string[]

    Keys causing a replacement (only applicable for "create" and "replace" Ops).

    +

    Optional logical

    logical?: boolean

    Logical is set if the step is a logical operation in the program.

    +

    Optional new

    new?: StepEventStateMetadata

    New is the state of the resource after performing the step.

    +

    Optional old

    old?: StepEventStateMetadata

    Old is the state of the resource before performing the step.

    +

    op

    op: OpType

    The type of operation being performed.

    +

    provider

    provider: string

    Provider actually performing the step.

    +

    type

    type: string

    The type of the resource being operated on.

    +

    urn

    urn: string

    The URN of the resource being operated on.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    detailedDiffdiffskeyslogicalnewoldopprovidertypeurn

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventStateMetadata.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventStateMetadata.html index 641edc55e97a..641d3ac65991 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventStateMetadata.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.StepEventStateMetadata.html @@ -1,6 +1,6 @@ StepEventStateMetadata | @pulumi/pulumi

    Interface StepEventStateMetadata

    StepEventStateMetadata is the more detailed state information for a resource as it relates to a step(s) being performed.

    -
    interface StepEventStateMetadata {
        custom?: boolean;
        delete?: boolean;
        id: string;
        initErrors?: string[];
        inputs: Record<string, any>;
        outputs: Record<string, any>;
        parent: string;
        protect?: boolean;
        provider: string;
        retainOnDelete?: boolean;
        type: string;
        urn: string;
    }

    Properties

    custom? +
    interface StepEventStateMetadata {
        custom?: boolean;
        delete?: boolean;
        id: string;
        initErrors?: string[];
        inputs: Record<string, any>;
        outputs: Record<string, any>;
        parent: string;
        protect?: boolean;
        provider: string;
        retainOnDelete?: boolean;
        type: string;
        urn: string;
    }

    Properties

    custom? delete? id initErrors? @@ -13,16 +13,16 @@ type urn

    Properties

    Optional custom

    custom?: boolean

    Custom indicates if the resource is managed by a plugin.

    -

    Optional delete

    delete?: boolean

    Delete is true when the resource is pending deletion due to a replacement.

    -

    id

    id: string

    ID is the resource's unique ID, assigned by the resource provider (or blank if none/uncreated).

    -

    Optional initErrors

    initErrors?: string[]

    InitErrors is the set of errors encountered in the process of initializing resource.

    -

    inputs

    inputs: Record<string, any>

    Inputs contains the resource's input properties (as specified by the program). Secrets have +

    Optional delete

    delete?: boolean

    Delete is true when the resource is pending deletion due to a replacement.

    +

    id

    id: string

    ID is the resource's unique ID, assigned by the resource provider (or blank if none/uncreated).

    +

    Optional initErrors

    initErrors?: string[]

    InitErrors is the set of errors encountered in the process of initializing resource.

    +

    inputs

    inputs: Record<string, any>

    Inputs contains the resource's input properties (as specified by the program). Secrets have filtered out, and large assets have been replaced by hashes as applicable.

    -

    outputs

    outputs: Record<string, any>

    Outputs contains the resource's complete output state (as returned by the resource provider).

    -

    parent

    parent: string

    Parent is an optional parent URN that this resource belongs to.

    -

    Optional protect

    protect?: boolean

    Protect is true to "protect" this resource (protected resources cannot be deleted).

    -

    provider

    provider: string

    Provider is the resource's provider reference

    -

    Optional retainOnDelete

    retainOnDelete?: boolean

    RetainOnDelete is true if the resource is not physically deleted when it is logically deleted.

    -

    type

    type: string

    The type of the resource being operated on.

    -

    urn

    urn: string

    The URN of the resource being operated on.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    customdeleteidinitErrorsinputsoutputsparentprotectproviderretainOnDeletetypeurn

    Generated using TypeDoc

    \ No newline at end of file +

    outputs

    outputs: Record<string, any>

    Outputs contains the resource's complete output state (as returned by the resource provider).

    +

    parent

    parent: string

    Parent is an optional parent URN that this resource belongs to.

    +

    Optional protect

    protect?: boolean

    Protect is true to "protect" this resource (protected resources cannot be deleted).

    +

    provider

    provider: string

    Provider is the resource's provider reference

    +

    Optional retainOnDelete

    retainOnDelete?: boolean

    RetainOnDelete is true if the resource is not physically deleted when it is logically deleted.

    +

    type

    type: string

    The type of the resource being operated on.

    +

    urn

    urn: string

    The URN of the resource being operated on.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    customdeleteidinitErrorsinputsoutputsparentprotectproviderretainOnDeletetypeurn

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.SummaryEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.SummaryEvent.html index 086a1653cee6..89f4a1bde5ac 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.SummaryEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.SummaryEvent.html @@ -1,14 +1,14 @@ SummaryEvent | @pulumi/pulumi

    Interface SummaryEvent

    An event emitted at the end of an update, with a summary of the changes made.

    -
    interface SummaryEvent {
        durationSeconds: number;
        maybeCorrupt: boolean;
        policyPacks: Record<string, string>;
        resourceChanges: OpMap;
    }

    Properties

    durationSeconds +
    interface SummaryEvent {
        durationSeconds: number;
        maybeCorrupt: boolean;
        policyPacks: Record<string, string>;
        resourceChanges: OpMap;
    }

    Properties

    durationSeconds maybeCorrupt policyPacks resourceChanges

    Properties

    durationSeconds

    durationSeconds: number

    The number of seconds the update took to execute.

    -

    maybeCorrupt

    maybeCorrupt: boolean

    True if one or more of the resources are in an invalid state.

    -

    policyPacks

    policyPacks: Record<string, string>

    The policy packs that were run during the update. Maps PolicyPackName -> version.

    +

    maybeCorrupt

    maybeCorrupt: boolean

    True if one or more of the resources are in an invalid state.

    +

    policyPacks

    policyPacks: Record<string, string>

    The policy packs that were run during the update. Maps PolicyPackName -> version.

    Note: When this field was initially added, we forgot to add the JSON tag and are now locked into using PascalCase for this field to maintain backwards compatibility. For older clients this will map to the version, while for newer ones it will be the version tag prepended with "v".

    -

    resourceChanges

    resourceChanges: OpMap

    The count for resource changes by type.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    durationSecondsmaybeCorruptpolicyPacksresourceChanges

    Generated using TypeDoc

    \ No newline at end of file +

    resourceChanges

    resourceChanges: OpMap

    The count for resource changes by type.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    durationSecondsmaybeCorruptpolicyPacksresourceChanges

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.TokenInfomation.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.TokenInfomation.html index fa48f36ed81e..8d855399ca5f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.TokenInfomation.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.TokenInfomation.html @@ -1,5 +1,5 @@ TokenInfomation | @pulumi/pulumi

    Interface TokenInfomation

    The currently logged-in Pulumi access token.

    -
    interface TokenInfomation {
        name: string;
        organization?: string;
        team?: string;
    }

    Properties

    name +
    interface TokenInfomation {
        name: string;
        organization?: string;
        team?: string;
    }

    Properties

    name organization? team? -

    Properties

    name

    name: string

    Optional organization

    organization?: string

    Optional team

    team?: string

    Settings

    Member Visibility

    Theme

    On This Page

    nameorganizationteam

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    name

    name: string

    Optional organization

    organization?: string

    Optional team

    team?: string

    Settings

    Member Visibility

    Theme

    On This Page

    nameorganizationteam

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpOptions.html index b1c80db2f7fb..c912a5b782f7 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpOptions.html @@ -1,5 +1,5 @@ UpOptions | @pulumi/pulumi

    Interface UpOptions

    Options controlling the behavior of a Stack.up() operation.

    -
    interface UpOptions {
        attachDebugger?: boolean;
        color?: "always" | "never" | "raw" | "auto";
        continueOnError?: boolean;
        debug?: boolean;
        diff?: boolean;
        exclude?: string[];
        excludeDependents?: boolean;
        expectNoChanges?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onError?: ((err) => void);
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        plan?: string;
        policyPackConfigs?: string[];
        policyPacks?: string[];
        program?: PulumiFn;
        refresh?: boolean;
        replace?: string[];
        showSecrets?: boolean;
        signal?: AbortSignal;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        targetDependents?: boolean;
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    attachDebugger? +
    interface UpOptions {
        attachDebugger?: boolean;
        color?: "always" | "never" | "raw" | "auto";
        continueOnError?: boolean;
        debug?: boolean;
        diff?: boolean;
        exclude?: string[];
        excludeDependents?: boolean;
        expectNoChanges?: boolean;
        importFile?: string;
        logFlow?: boolean;
        logToStdErr?: boolean;
        logVerbosity?: number;
        message?: string;
        onError?: ((err) => void);
        onEvent?: ((event) => void);
        onOutput?: ((out) => void);
        parallel?: number;
        plan?: string;
        policyPackConfigs?: string[];
        policyPacks?: string[];
        program?: PulumiFn;
        refresh?: boolean;
        replace?: string[];
        showSecrets?: boolean;
        signal?: AbortSignal;
        suppressOutputs?: boolean;
        suppressProgress?: boolean;
        target?: string[];
        targetDependents?: boolean;
        tracing?: string;
        userAgent?: string;
    }

    Hierarchy (view full)

    Properties

    attachDebugger? color? continueOnError? debug? @@ -31,34 +31,34 @@ tracing? userAgent?

    Properties

    Optional attachDebugger

    attachDebugger?: boolean

    Run the process under a debugger, and pause until a debugger is attached.

    -

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    -

    Optional continueOnError

    continueOnError?: boolean

    Continue the operation to completion even if errors occur.

    -

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    -

    Optional diff

    diff?: boolean

    Display the operation as a rich diff showing the overall change.

    -

    Optional exclude

    exclude?: string[]

    Specify a set of resource URNs to exclude from operations.

    -

    Optional excludeDependents

    excludeDependents?: boolean

    Exclude dependents of targets specified with exclude.

    -

    Optional expectNoChanges

    expectNoChanges?: boolean

    Return an error if any changes occur during this operation.

    -

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    -

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    -

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    -

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    -

    Optional message

    message?: string

    Optional message to associate with the operation.

    -

    Optional onError

    onError?: ((err) => void)

    A callback to be executed when the operation produces stderr output.

    -

    Type declaration

      • (err): void

      • Parameters

        • err: string

        Returns void

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    -

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces stdout output.

    -

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    -

    Optional plan

    plan?: string

    Plan specifies the path to an update plan to use for the update.

    -

    Optional policyPackConfigs

    policyPackConfigs?: string[]

    A set of paths to JSON files containing configuration for the supplied policyPacks.

    -

    Optional policyPacks

    policyPacks?: string[]

    Run one or more policy packs as part of this operation.

    -

    Optional program

    program?: PulumiFn

    An inline (in-process) Pulumi program to execute the operation against.

    -

    Optional refresh

    refresh?: boolean

    Refresh the state of the stack's resources before this update.

    -

    Optional replace

    replace?: string[]

    Specify a set of resource URNs to replace.

    -

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the UpSummary.

    -

    Optional signal

    signal?: AbortSignal

    A signal to abort an ongoing operation.

    -

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    -

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    -

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    -

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    -

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    -

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    attachDebuggercolorcontinueOnErrordebugdiffexcludeexcludeDependentsexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonErroronEventonOutputparallelplanpolicyPackConfigspolicyPacksprogramrefreshreplaceshowSecretssignalsuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file +

    Optional color

    color?: "always" | "never" | "raw" | "auto"

    Colorize output.

    +

    Optional continueOnError

    continueOnError?: boolean

    Continue the operation to completion even if errors occur.

    +

    Optional debug

    debug?: boolean

    Print detailed debugging output during resource operations.

    +

    Optional diff

    diff?: boolean

    Display the operation as a rich diff showing the overall change.

    +

    Optional exclude

    exclude?: string[]

    Specify a set of resource URNs to exclude from operations.

    +

    Optional excludeDependents

    excludeDependents?: boolean

    Exclude dependents of targets specified with exclude.

    +

    Optional expectNoChanges

    expectNoChanges?: boolean

    Return an error if any changes occur during this operation.

    +

    Optional importFile

    importFile?: string

    Save any creates seen during the preview into an import file to use with pulumi import.

    +

    Optional logFlow

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    +

    Optional logToStdErr

    logToStdErr?: boolean

    Log to stderr instead of to files.

    +

    Optional logVerbosity

    logVerbosity?: number

    Enable verbose logging (e.g., v=3); anything >3 is very verbose.

    +

    Optional message

    message?: string

    Optional message to associate with the operation.

    +

    Optional onError

    onError?: ((err) => void)

    A callback to be executed when the operation produces stderr output.

    +

    Type declaration

      • (err): void

      • Parameters

        • err: string

        Returns void

    Optional onEvent

    onEvent?: ((event) => void)

    A callback to be executed when the operation yields an event.

    +

    Type declaration

    Optional onOutput

    onOutput?: ((out) => void)

    A callback to be executed when the operation produces stdout output.

    +

    Type declaration

      • (out): void

      • Parameters

        • out: string

        Returns void

    Optional parallel

    parallel?: number

    Allow P resource operations to run in parallel at once (1 for no parallelism).

    +

    Optional plan

    plan?: string

    Plan specifies the path to an update plan to use for the update.

    +

    Optional policyPackConfigs

    policyPackConfigs?: string[]

    A set of paths to JSON files containing configuration for the supplied policyPacks.

    +

    Optional policyPacks

    policyPacks?: string[]

    Run one or more policy packs as part of this operation.

    +

    Optional program

    program?: PulumiFn

    An inline (in-process) Pulumi program to execute the operation against.

    +

    Optional refresh

    refresh?: boolean

    Refresh the state of the stack's resources before this update.

    +

    Optional replace

    replace?: string[]

    Specify a set of resource URNs to replace.

    +

    Optional showSecrets

    showSecrets?: boolean

    Include secrets in the UpSummary.

    +

    Optional signal

    signal?: AbortSignal

    A signal to abort an ongoing operation.

    +

    Optional suppressOutputs

    suppressOutputs?: boolean

    Suppress display of stack outputs (in case they contain sensitive values).

    +

    Optional suppressProgress

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    +

    Optional target

    target?: string[]

    Specify a set of resource URNs to operate on. Other resources will not be updated.

    +

    Optional targetDependents

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    +

    Optional tracing

    tracing?: string

    Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.

    +

    Optional userAgent

    userAgent?: string

    A custom user agent to use when executing the operation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    attachDebuggercolorcontinueOnErrordebugdiffexcludeexcludeDependentsexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonErroronEventonOutputparallelplanpolicyPackConfigspolicyPacksprogramrefreshreplaceshowSecretssignalsuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpResult.html index 9d7f1f032d2f..8e92731ad6d3 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpResult.html @@ -1,10 +1,10 @@ UpResult | @pulumi/pulumi

    Interface UpResult

    The deployment output from running a Pulumi program update.

    -
    interface UpResult {
        outputs: OutputMap;
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    outputs +
    interface UpResult {
        outputs: OutputMap;
        stderr: string;
        stdout: string;
        summary: UpdateSummary;
    }

    Properties

    outputs stderr stdout summary

    Properties

    outputs

    outputs: OutputMap

    The outputs from the update.

    -

    stderr

    stderr: string

    The standard error output from the update.

    -

    stdout

    stdout: string

    The standard output from the update.

    -

    summary

    summary: UpdateSummary

    A summary of the update.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    outputsstderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file +

    stderr

    stderr: string

    The standard error output from the update.

    +

    stdout

    stdout: string

    The standard output from the update.

    +

    summary

    summary: UpdateSummary

    A summary of the update.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    outputsstderrstdoutsummary

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpdateSummary.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpdateSummary.html index 755770c2be1a..0eccf4408d18 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpdateSummary.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.UpdateSummary.html @@ -1,5 +1,5 @@ UpdateSummary | @pulumi/pulumi

    Interface UpdateSummary

    A summary of a stack operation.

    -
    interface UpdateSummary {
        Deployment?: string;
        config: ConfigMap;
        endTime: Date;
        environment: {
            [key: string]: string;
        };
        kind: UpdateKind;
        message: string;
        resourceChanges?: OpMap;
        result: automation.UpdateResult;
        startTime: Date;
        version: number;
    }

    Properties

    Deployment? +
    interface UpdateSummary {
        Deployment?: string;
        config: ConfigMap;
        endTime: Date;
        environment: {
            [key: string]: string;
        };
        kind: UpdateKind;
        message: string;
        resourceChanges?: OpMap;
        result: automation.UpdateResult;
        startTime: Date;
        version: number;
    }

    Properties

    Deployment? config endTime environment @@ -10,14 +10,14 @@ startTime version

    Properties

    Optional Deployment

    Deployment?: string

    A raw JSON blob detailing the deployment.

    -

    config

    config: ConfigMap

    The configuration used for the operation.

    -

    endTime

    endTime: Date

    The time at which the operation completed.

    -

    environment

    environment: {
        [key: string]: string;
    }

    The environment supplied to the operation.

    -

    Type declaration

    • [key: string]: string

    kind

    kind: UpdateKind

    The kind of operation to be executed/that was executed.

    -

    message

    message: string

    An optional message associated with the operation.

    -

    Optional resourceChanges

    resourceChanges?: OpMap

    A summary of the changes yielded by the operation (e.g. 4 unchanged, 3 +

    config

    config: ConfigMap

    The configuration used for the operation.

    +

    endTime

    endTime: Date

    The time at which the operation completed.

    +

    environment

    environment: {
        [key: string]: string;
    }

    The environment supplied to the operation.

    +

    Type declaration

    • [key: string]: string

    kind

    kind: UpdateKind

    The kind of operation to be executed/that was executed.

    +

    message

    message: string

    An optional message associated with the operation.

    +

    Optional resourceChanges

    resourceChanges?: OpMap

    A summary of the changes yielded by the operation (e.g. 4 unchanged, 3 created, etc.).

    -

    result

    result: automation.UpdateResult

    The operation result.

    -

    startTime

    startTime: Date

    The time at which the operation started.

    -

    version

    version: number

    The version of the stack created by the operation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    DeploymentconfigendTimeenvironmentkindmessageresourceChangesresultstartTimeversion

    Generated using TypeDoc

    \ No newline at end of file +

    result

    result: automation.UpdateResult

    The operation result.

    +

    startTime

    startTime: Date

    The time at which the operation started.

    +

    version

    version: number

    The version of the stack created by the operation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    DeploymentconfigendTimeenvironmentkindmessageresourceChangesresultstartTimeversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.WhoAmIResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.WhoAmIResult.html index b280e8f69e75..d943804974a4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.WhoAmIResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.WhoAmIResult.html @@ -1,6 +1,6 @@ WhoAmIResult | @pulumi/pulumi

    Interface WhoAmIResult

    The currently logged-in Pulumi identity.

    -
    interface WhoAmIResult {
        organizations?: string[];
        tokenInformation?: TokenInfomation;
        url?: string;
        user: string;
    }

    Properties

    organizations? +
    interface WhoAmIResult {
        organizations?: string[];
        tokenInformation?: TokenInfomation;
        url?: string;
        user: string;
    }

    Properties

    organizations? tokenInformation? url? user -

    Properties

    Optional organizations

    organizations?: string[]

    Optional tokenInformation

    tokenInformation?: TokenInfomation

    Optional url

    url?: string

    user

    user: string

    Settings

    Member Visibility

    Theme

    On This Page

    organizationstokenInformationurluser

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional organizations

    organizations?: string[]

    Optional tokenInformation

    tokenInformation?: TokenInfomation

    Optional url

    url?: string

    user

    user: string

    Settings

    Member Visibility

    Theme

    On This Page

    organizationstokenInformationurluser

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.Workspace.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.Workspace.html index 5e3d1a8c6df7..5bf227558068 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.Workspace.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/automation.Workspace.html @@ -3,7 +3,7 @@ manage the execution environment, providing various utilities such as plugin installation, environment configuration ($PULUMI_HOME), and creation, deletion, and listing of Stacks.

    -
    interface Workspace {
        envVars: {
            [key: string]: string;
        };
        program?: PulumiFn;
        pulumiCommand: PulumiCommand;
        pulumiHome?: string;
        pulumiVersion: string;
        secretsProvider?: string;
        workDir: string;
        addEnvironments(stackName, ...environments): Promise<void>;
        createStack(stackName): Promise<void>;
        exportStack(stackName): Promise<Deployment>;
        getAllConfig(stackName): Promise<ConfigMap>;
        getConfig(stackName, key, path?): Promise<ConfigValue>;
        getTag(stackName, key): Promise<string>;
        importStack(stackName, state): Promise<void>;
        installPlugin(name, version, kind?): Promise<void>;
        installPluginFromServer(name, version, server): Promise<void>;
        listEnvironments(stackName): Promise<string[]>;
        listPlugins(): Promise<PluginInfo[]>;
        listStacks(opts?): Promise<StackSummary[]>;
        listTags(stackName): Promise<TagMap>;
        postCommandCallback(stackName): Promise<void>;
        projectSettings(): Promise<ProjectSettings>;
        refreshConfig(stackName): Promise<ConfigMap>;
        removeAllConfig(stackName, keys, path?): Promise<void>;
        removeConfig(stackName, key, path?): Promise<void>;
        removeEnvironment(stackName, environment): Promise<void>;
        removePlugin(name?, versionRange?, kind?): Promise<void>;
        removeStack(stackName, opts?): Promise<void>;
        removeTag(stackName, key): Promise<void>;
        saveProjectSettings(settings): Promise<void>;
        saveStackSettings(stackName, settings): Promise<void>;
        selectStack(stackName): Promise<void>;
        serializeArgsForOp(stackName): Promise<string[]>;
        setAllConfig(stackName, config, path?): Promise<void>;
        setConfig(stackName, key, value, path?): Promise<void>;
        setTag(stackName, key, value): Promise<void>;
        stack(): Promise<undefined | StackSummary>;
        stackOutputs(stackName): Promise<OutputMap>;
        stackSettings(stackName): Promise<StackSettings>;
        whoAmI(): Promise<WhoAmIResult>;
    }

    Implemented by

    Properties

    envVars +
    interface Workspace {
        envVars: {
            [key: string]: string;
        };
        program?: PulumiFn;
        pulumiCommand: PulumiCommand;
        pulumiHome?: string;
        pulumiVersion: string;
        secretsProvider?: string;
        workDir: string;
        addEnvironments(stackName, ...environments): Promise<void>;
        createStack(stackName): Promise<void>;
        exportStack(stackName): Promise<Deployment>;
        getAllConfig(stackName): Promise<ConfigMap>;
        getConfig(stackName, key, path?): Promise<ConfigValue>;
        getTag(stackName, key): Promise<string>;
        importStack(stackName, state): Promise<void>;
        installPlugin(name, version, kind?): Promise<void>;
        installPluginFromServer(name, version, server): Promise<void>;
        listEnvironments(stackName): Promise<string[]>;
        listPlugins(): Promise<PluginInfo[]>;
        listStacks(opts?): Promise<StackSummary[]>;
        listTags(stackName): Promise<TagMap>;
        postCommandCallback(stackName): Promise<void>;
        projectSettings(): Promise<ProjectSettings>;
        refreshConfig(stackName): Promise<ConfigMap>;
        removeAllConfig(stackName, keys, path?): Promise<void>;
        removeConfig(stackName, key, path?): Promise<void>;
        removeEnvironment(stackName, environment): Promise<void>;
        removePlugin(name?, versionRange?, kind?): Promise<void>;
        removeStack(stackName, opts?): Promise<void>;
        removeTag(stackName, key): Promise<void>;
        saveProjectSettings(settings): Promise<void>;
        saveStackSettings(stackName, settings): Promise<void>;
        selectStack(stackName): Promise<void>;
        serializeArgsForOp(stackName): Promise<string[]>;
        setAllConfig(stackName, config, path?): Promise<void>;
        setConfig(stackName, key, value, path?): Promise<void>;
        setTag(stackName, key, value): Promise<void>;
        stack(): Promise<undefined | StackSummary>;
        stackOutputs(stackName): Promise<OutputMap>;
        stackSettings(stackName): Promise<StackSettings>;
        whoAmI(): Promise<WhoAmIResult>;
    }

    Implemented by

    Properties

    envVars program? pulumiCommand pulumiHome? @@ -45,129 +45,129 @@ whoAmI

    Properties

    envVars

    envVars: {
        [key: string]: string;
    }

    Environment values scoped to the current workspace. These will be supplied to every Pulumi command.

    -

    Type declaration

    • [key: string]: string

    Optional program

    program?: PulumiFn

    The inline program PulumiFn to be used for preview/update +

    Type declaration

    • [key: string]: string

    Optional program

    program?: PulumiFn

    The inline program PulumiFn to be used for preview/update operations, if any. If none is specified, the stack will refer to ProjectSettings for this information.

    -

    Readonly pulumiCommand

    pulumiCommand: PulumiCommand

    The underlying Pulumi CLI.

    -

    Optional Readonly pulumiHome

    pulumiHome?: string

    The directory override for CLI metadata if set. This customizes the +

    Readonly pulumiCommand

    pulumiCommand: PulumiCommand

    The underlying Pulumi CLI.

    +

    Optional Readonly pulumiHome

    pulumiHome?: string

    The directory override for CLI metadata if set. This customizes the location of $PULUMI_HOME where metadata is stored and plugins are installed.

    -

    Readonly pulumiVersion

    pulumiVersion: string

    The version of the underlying Pulumi CLI/engine.

    -

    Optional Readonly secretsProvider

    secretsProvider?: string

    The secrets provider to use for encryption and decryption of stack +

    Readonly pulumiVersion

    pulumiVersion: string

    The version of the underlying Pulumi CLI/engine.

    +

    Optional Readonly secretsProvider

    secretsProvider?: string

    The secrets provider to use for encryption and decryption of stack secrets.

    See

    https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providers

    -

    Readonly workDir

    workDir: string

    The working directory to run Pulumi CLI commands.

    -

    Methods

    addEnvironments

    Readonly workDir

    workDir: string

    The working directory to run Pulumi CLI commands.

    +

    Methods

    addEnvironments

    • addEnvironments(stackName, ...environments): Promise<void>

    • Adds environments to the end of a stack's import list. Imported environments are merged in order per the ESC merge rules. The list of environments behaves as if it were the import list in an anonymous environment.

      Parameters

      • stackName: string

        The stack to operate on

      • Rest ...environments: string[]

        The names of the environments to add to the stack's configuration

        -

      Returns Promise<void>

    createStack

    • createStack(stackName): Promise<void>

    • Creates and sets a new stack with the stack name, failing if one already +

    Returns Promise<void>

    createStack

    • createStack(stackName): Promise<void>

    • Creates and sets a new stack with the stack name, failing if one already exists.

      Parameters

      • stackName: string

        The stack to create.

        -

      Returns Promise<void>

    exportStack

    • exportStack(stackName): Promise<Deployment>

    • Exports the deployment state of the stack. This can be combined with +

    Returns Promise<void>

    exportStack

    getAllConfig

    • getAllConfig(stackName): Promise<ConfigMap>

    • Returns the config map for the specified stack name, scoped to the +

    Returns Promise<Deployment>

    getAllConfig

    getConfig

    • getConfig(stackName, key, path?): Promise<ConfigValue>

    • Returns the value associated with the specified stack name and key, +

    Returns Promise<ConfigMap>

    getConfig

    • getConfig(stackName, key, path?): Promise<ConfigValue>

    • Returns the value associated with the specified stack name and key, scoped to the Workspace.

      Parameters

      • stackName: string

        The stack to read config from

      • key: string

        The key to use for the config lookup

      • Optional path: boolean

        The key contains a path to a property in a map or list to get

        -

      Returns Promise<ConfigValue>

    getTag

    • getTag(stackName, key): Promise<string>

    • Returns the value associated with the specified stack name and key, +

    Returns Promise<ConfigValue>

    getTag

    • getTag(stackName, key): Promise<string>

    • Returns the value associated with the specified stack name and key, scoped to the Workspace.

      Parameters

      • stackName: string

        The stack to read tag metadata from.

      • key: string

        The key to use for the tag lookup.

        -

      Returns Promise<string>

    importStack

    • importStack(stackName, state): Promise<void>

    • Imports the specified deployment state into a pre-existing stack. This +

    Returns Promise<string>

    importStack

    • importStack(stackName, state): Promise<void>

    • Imports the specified deployment state into a pre-existing stack. This can be combined with Workspace.exportStack to edit a stack's state (such as recovery from failed deployments).

      Parameters

      • stackName: string

        The name of the stack.

      • state: Deployment

        The stack state to import.

        -

      Returns Promise<void>

    installPlugin

    • installPlugin(name, version, kind?): Promise<void>

    • Installs a plugin in the workspace from a remote server, for example a +

    Returns Promise<void>

    installPlugin

    • installPlugin(name, version, kind?): Promise<void>

    • Installs a plugin in the workspace from a remote server, for example a third-party plugin.

      Parameters

      • name: string

        The name of the plugin.

      • version: string

        The version of the plugin e.g. "v1.0.0".

      • Optional kind: string

        The kind of plugin e.g. "resource"

        -

      Returns Promise<void>

    installPluginFromServer

    • installPluginFromServer(name, version, server): Promise<void>

    • Installs a plugin in the workspace, for example to use cloud providers +

    Returns Promise<void>

    installPluginFromServer

    • installPluginFromServer(name, version, server): Promise<void>

    • Installs a plugin in the workspace, for example to use cloud providers like AWS or GCP.

      Parameters

      • name: string

        The name of the plugin.

      • version: string

        The version of the plugin e.g. "v1.0.0".

      • server: string

        The server to install the plugin into

        -

      Returns Promise<void>

    listEnvironments

    • listEnvironments(stackName): Promise<string[]>

    • Returns the list of environments associated with the specified stack +

    Returns Promise<void>

    listEnvironments

    • listEnvironments(stackName): Promise<string[]>

    • Returns the list of environments associated with the specified stack name.

      Parameters

      • stackName: string

        The stack to operate on

        -

      Returns Promise<string[]>

    listPlugins

    listStacks

    • listStacks(opts?): Promise<StackSummary[]>

    • Returns all stacks from the underlying backend based on the provided +

    Returns Promise<string[]>

    listPlugins

    listStacks

    listTags

    • listTags(stackName): Promise<TagMap>

    • Returns the tag map for the specified tag name, scoped to the current +

    Returns Promise<StackSummary[]>

    listTags

    postCommandCallback

    • postCommandCallback(stackName): Promise<void>

    • A hook executed after every command. Called with the stack name. An +

    Returns Promise<TagMap>

    postCommandCallback

    • postCommandCallback(stackName): Promise<void>

    • A hook executed after every command. Called with the stack name. An extensibility point to perform workspace cleanup (CLI operations may create/modify a Pulumi.stack.yaml)

      -

      Parameters

      • stackName: string

      Returns Promise<void>

    projectSettings

    refreshConfig

    projectSettings

    refreshConfig

    removeAllConfig

    • removeAllConfig(stackName, keys, path?): Promise<void>

    • Removes all values in the provided key list for the specified stack name.

      +

    Returns Promise<ConfigMap>

    removeAllConfig

    • removeAllConfig(stackName, keys, path?): Promise<void>

    • Removes all values in the provided key list for the specified stack name.

      Parameters

      • stackName: string

        The stack to operate on

      • keys: string[]

        The list of keys to remove from the underlying config

      • Optional path: boolean

        The keys contain a path to a property in a map or list to remove

        -

      Returns Promise<void>

    removeConfig

    • removeConfig(stackName, key, path?): Promise<void>

    • Removes the specified key-value pair on the provided stack name.

      +

    Returns Promise<void>

    removeConfig

    • removeConfig(stackName, key, path?): Promise<void>

    • Removes the specified key-value pair on the provided stack name.

      Parameters

      • stackName: string

        The stack to operate on

      • key: string

        The config key to remove

      • Optional path: boolean

        The key contains a path to a property in a map or list to remove

        -

      Returns Promise<void>

    removeEnvironment

    • removeEnvironment(stackName, environment): Promise<void>

    • Removes an environment from a stack's import list.

      +

    Returns Promise<void>

    removeEnvironment

    • removeEnvironment(stackName, environment): Promise<void>

    • Removes an environment from a stack's import list.

      Parameters

      • stackName: string

        The stack to operate on

      • environment: string

        The name of the environment to remove from the stack's configuration

        -

      Returns Promise<void>

    removePlugin

    • removePlugin(name?, versionRange?, kind?): Promise<void>

    • Removes a plugin from the workspace matching the specified name and +

    Returns Promise<void>

    removePlugin

    • removePlugin(name?, versionRange?, kind?): Promise<void>

    • Removes a plugin from the workspace matching the specified name and version.

      Parameters

      • Optional name: string

        The optional name of the plugin.

      • Optional versionRange: string

        An optional semver range to check when removing plugins matching the given name e.g. "1.0.0", ">1.0.0".

      • Optional kind: string

        The kind of plugin e.g. "resource"

        -

      Returns Promise<void>

    removeStack

    • removeStack(stackName, opts?): Promise<void>

    • Deletes the stack and all associated configuration and history.

      +

    Returns Promise<void>

    removeStack

    removeTag

    • removeTag(stackName, key): Promise<void>

    • Removes the specified key-value pair on the provided stack name.

      +
    • Optional opts: RemoveOptions

    Returns Promise<void>

    removeTag

    • removeTag(stackName, key): Promise<void>

    • Removes the specified key-value pair on the provided stack name.

      Parameters

      • stackName: string

        The stack to operate on.

      • key: string

        The tag key to remove.

        -

      Returns Promise<void>

    saveProjectSettings

    • saveProjectSettings(settings): Promise<void>

    • Overwrites the settings object in the current project. There can only be +

    Returns Promise<void>

    saveProjectSettings

    • saveProjectSettings(settings): Promise<void>

    • Overwrites the settings object in the current project. There can only be a single project per workspace. Fails if the new project name does not match the old one.

      Parameters

      Returns Promise<void>

    saveStackSettings

    • saveStackSettings(stackName, settings): Promise<void>

    • Overwrites the settings object for the stack matching the specified stack +

    Returns Promise<void>

    saveStackSettings

    • saveStackSettings(stackName, settings): Promise<void>

    • Overwrites the settings object for the stack matching the specified stack name.

      Parameters

      • stackName: string

        The name of the stack to operate on.

      • settings: StackSettings

        The settings object to save.

        -

      Returns Promise<void>

    selectStack

    • selectStack(stackName): Promise<void>

    • Selects and sets an existing stack matching the stack name, failing if +

    Returns Promise<void>

    selectStack

    • selectStack(stackName): Promise<void>

    • Selects and sets an existing stack matching the stack name, failing if none exists.

      Parameters

      • stackName: string

        The stack to select.

        -

      Returns Promise<void>

    serializeArgsForOp

    • serializeArgsForOp(stackName): Promise<string[]>

    • A hook to provide additional arguments to every CLI command before they +

    Returns Promise<void>

    serializeArgsForOp

    • serializeArgsForOp(stackName): Promise<string[]>

    • A hook to provide additional arguments to every CLI command before they are executed. Provided with the stack name, this should return a list of arguments to append to an invoked command (e.g. ["--config=...", ...]).

      -

      Parameters

      • stackName: string

      Returns Promise<string[]>

    setAllConfig

    • setAllConfig(stackName, config, path?): Promise<void>

    • Sets all values in the provided config map for the specified stack name.

      +

      Parameters

      • stackName: string

      Returns Promise<string[]>

    setAllConfig

    • setAllConfig(stackName, config, path?): Promise<void>

    • Sets all values in the provided config map for the specified stack name.

      Parameters

      • stackName: string

        The stack to operate on

      • config: ConfigMap

        The ConfigMap to upsert against the existing config

      • Optional path: boolean

        The keys contain a path to a property in a map or list to set

        -

      Returns Promise<void>

    setConfig

    • setConfig(stackName, key, value, path?): Promise<void>

    • Sets the specified key-value pair on the provided stack name.

      +

    Returns Promise<void>

    setConfig

    • setConfig(stackName, key, value, path?): Promise<void>

    • Sets the specified key-value pair on the provided stack name.

      Parameters

      • stackName: string

        The stack to operate on

      • key: string

        The config key to set

      • value: ConfigValue

        The value to set

      • Optional path: boolean

        The key contains a path to a property in a map or list to set

        -

      Returns Promise<void>

    setTag

    • setTag(stackName, key, value): Promise<void>

    • Sets the specified key-value pair on the provided stack name.

      +

    Returns Promise<void>

    setTag

    • setTag(stackName, key, value): Promise<void>

    • Sets the specified key-value pair on the provided stack name.

      Parameters

      • stackName: string

        The stack to operate on.

      • key: string

        The tag key to set.

      • value: string

        The tag value to set.

        -

      Returns Promise<void>

    stack

    stackOutputs

    • stackOutputs(stackName): Promise<OutputMap>

    • Gets the current set of Stack outputs from the last Stack.up.

      +

    Returns Promise<void>

    stack

    stackOutputs

    stackSettings

    • stackSettings(stackName): Promise<StackSettings>

    • Returns the settings object for the stack matching the specified stack +

    Returns Promise<OutputMap>

    stackSettings

    whoAmI

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsprogrampulumiCommandpulumiHomepulumiVersionsecretsProviderworkDiraddEnvironmentscreateStackexportStackgetAllConfiggetConfiggetTagimportStackinstallPlugininstallPluginFromServerlistEnvironmentslistPluginslistStackslistTagspostCommandCallbackprojectSettingsrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremovePluginremoveStackremoveTagsaveProjectSettingssaveStackSettingsselectStackserializeArgsForOpsetAllConfigsetConfigsetTagstackstackOutputsstackSettingswhoAmI

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<StackSettings>

    whoAmI

    Settings

    Member Visibility

    Theme

    On This Page

    envVarsprogrampulumiCommandpulumiHomepulumiVersionsecretsProviderworkDiraddEnvironmentscreateStackexportStackgetAllConfiggetConfiggetTagimportStackinstallPlugininstallPluginFromServerlistEnvironmentslistPluginslistStackslistTagspostCommandCallbackprojectSettingsrefreshConfigremoveAllConfigremoveConfigremoveEnvironmentremovePluginremoveStackremoveTagsaveProjectSettingssaveStackSettingsselectStackserializeArgsForOpsetAllConfigsetConfigsetTagstackstackOutputsstackSettingswhoAmI

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckFailure.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckFailure.html index a89b0fa006db..222b268bbba0 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckFailure.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckFailure.html @@ -1,7 +1,7 @@ CheckFailure | @pulumi/pulumi

    Interface CheckFailure

    CheckFailure represents a single failure in the results of a call to ResourceProvider.check.

    -
    interface CheckFailure {
        property: string;
        reason: string;
    }

    Properties

    property +
    interface CheckFailure {
        property: string;
        reason: string;
    }

    Properties

    property reason

    Properties

    Readonly property

    property: string

    The property that failed validation.

    -

    Readonly reason

    reason: string

    The reason that the property failed validation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    propertyreason

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly reason

    reason: string

    The reason that the property failed validation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    propertyreason

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckResult.html index 2a6e266e6ff9..b537fcaafc00 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CheckResult.html @@ -1,6 +1,6 @@ CheckResult | @pulumi/pulumi

    Interface CheckResult<Inputs>

    CheckResult represents the results of a call to ResourceProvider.check.

    -
    interface CheckResult<Inputs> {
        failures?: dynamic.CheckFailure[];
        inputs?: Inputs;
    }

    Type Parameters

    • Inputs = any

    Properties

    failures? +
    interface CheckResult<Inputs> {
        failures?: dynamic.CheckFailure[];
        inputs?: Inputs;
    }

    Type Parameters

    • Inputs = any

    Properties

    failures? inputs?

    Properties

    Optional Readonly failures

    failures?: dynamic.CheckFailure[]

    Any validation failures that occurred.

    -

    Optional Readonly inputs

    inputs?: Inputs

    The inputs to use, if any.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    failuresinputs

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly inputs

    inputs?: Inputs

    The inputs to use, if any.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    failuresinputs

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.Config.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.Config.html index 6abaab3a1d49..b2da23b33fb6 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.Config.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.Config.html @@ -2,12 +2,12 @@ configure method.

    Use the Config.get and Config.require methods to retrieve a configuration value by key.

    -
    interface Config {
        get(key): undefined | string;
        require(key): string;
    }

    Methods

    get +
    interface Config {
        get(key): undefined | string;
        require(key): string;
    }

    Methods

    get require

    Methods

    get

    • get(key): undefined | string

    • get retrieves a configuration value by key. Returns undefined if the key is not present.

      Parameters

      • key: string

        The key to lookup in the configuration. If no namespace is provided in the key, the project name will be used as the namespace.

        -

      Returns undefined | string

    require

    • require(key): string

    • require retrieves a configuration value by key. Returns an error if the key is not present.

      +

    Returns undefined | string

    require

    • require(key): string

    • require retrieves a configuration value by key. Returns an error if the key is not present.

      Parameters

      • key: string

        The key to lookup in the configuration. If no namespace is provided in the key, the project name will be used as the namespace.

        -

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    getrequire

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    getrequire

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ConfigureRequest.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ConfigureRequest.html index 4170400db244..6adcb80a6c0a 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ConfigureRequest.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ConfigureRequest.html @@ -1,4 +1,4 @@ ConfigureRequest | @pulumi/pulumi

    Interface ConfigureRequest

    ConfigureRequest is the input to a provider's configure method.

    -
    interface ConfigureRequest {
        config: dynamic.Config;
    }

    Properties

    config +
    interface ConfigureRequest {
        config: dynamic.Config;
    }

    Properties

    config

    Properties

    config

    config: dynamic.Config

    The stack's configuration.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    config

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    config

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CreateResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CreateResult.html index ad36440f78fa..800f326171c7 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CreateResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.CreateResult.html @@ -1,7 +1,7 @@ CreateResult | @pulumi/pulumi

    Interface CreateResult<Outputs>

    CreateResult represents the results of a call to ResourceProvider.create.

    -
    interface CreateResult<Outputs> {
        id: string;
        outs?: Outputs;
    }

    Type Parameters

    • Outputs = any

    Properties

    id +
    interface CreateResult<Outputs> {
        id: string;
        outs?: Outputs;
    }

    Type Parameters

    • Outputs = any

    Properties

    id outs?

    Properties

    Readonly id

    id: string

    The ID of the created resource.

    -

    Optional Readonly outs

    outs?: Outputs

    Any properties that were computed during creation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    idouts

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly outs

    outs?: Outputs

    Any properties that were computed during creation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    idouts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.DiffResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.DiffResult.html index a8cf15d54086..359c756bb98c 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.DiffResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.DiffResult.html @@ -1,13 +1,13 @@ DiffResult | @pulumi/pulumi

    Interface DiffResult

    DiffResult represents the results of a call to ResourceProvider.diff.

    -
    interface DiffResult {
        changes?: boolean;
        deleteBeforeReplace?: boolean;
        replaces?: string[];
        stables?: string[];
    }

    Properties

    changes? +
    interface DiffResult {
        changes?: boolean;
        deleteBeforeReplace?: boolean;
        replaces?: string[];
        stables?: string[];
    }

    Properties

    changes? deleteBeforeReplace? replaces? stables?

    Properties

    Optional Readonly changes

    changes?: boolean

    If true, this diff detected changes and suggests an update.

    -

    Optional Readonly deleteBeforeReplace

    deleteBeforeReplace?: boolean

    If true, and a replacement occurs, the resource will first be deleted +

    Optional Readonly deleteBeforeReplace

    deleteBeforeReplace?: boolean

    If true, and a replacement occurs, the resource will first be deleted before being recreated. This is to avoid potential side-by-side issues with the default create before delete behavior.

    -

    Optional Readonly replaces

    replaces?: string[]

    If this update requires a replacement, the set of properties triggering it.

    -

    Optional Readonly stables

    stables?: string[]

    An optional list of properties that will not ever change.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    changesdeleteBeforeReplacereplacesstables

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly replaces

    replaces?: string[]

    If this update requires a replacement, the set of properties triggering it.

    +

    Optional Readonly stables

    stables?: string[]

    An optional list of properties that will not ever change.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    changesdeleteBeforeReplacereplacesstables

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ReadResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ReadResult.html index fd667e98b731..72b6bab400ef 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ReadResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ReadResult.html @@ -1,7 +1,7 @@ ReadResult | @pulumi/pulumi

    Interface ReadResult<Outputs>

    ReadResult represents the results of a call to ResourceProvider.read.

    -
    interface ReadResult<Outputs> {
        id?: string;
        props?: Outputs;
    }

    Type Parameters

    • Outputs = any

    Properties

    id? +
    interface ReadResult<Outputs> {
        id?: string;
        props?: Outputs;
    }

    Type Parameters

    • Outputs = any

    Properties

    id? props?

    Properties

    Optional Readonly id

    id?: string

    The ID of the resource ready back (or blank if missing).

    -

    Optional Readonly props

    props?: Outputs

    The current property state read from the live environment.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    idprops

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly props

    props?: Outputs

    The current property state read from the live environment.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    idprops

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ResourceProvider.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ResourceProvider.html index 07b175fde3ea..77701f33dc81 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ResourceProvider.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.ResourceProvider.html @@ -1,6 +1,6 @@ ResourceProvider | @pulumi/pulumi

    Interface ResourceProvider<Inputs, Outputs>

    ResourceProvider represents an object that provides CRUD operations for a particular type of resource.

    -
    interface ResourceProvider<Inputs, Outputs> {
        check?: ((olds, news) => Promise<dynamic.CheckResult<Inputs>>);
        configure?: ((req) => Promise<void>);
        create: ((inputs) => Promise<dynamic.CreateResult<Outputs>>);
        delete?: ((id, props) => Promise<void>);
        diff?: ((id, olds, news) => Promise<dynamic.DiffResult>);
        read?: ((id, props?) => Promise<dynamic.ReadResult<Outputs>>);
        update?: ((id, olds, news) => Promise<dynamic.UpdateResult<Outputs>>);
    }

    Type Parameters

    • Inputs = any
    • Outputs = any

    Properties

    check? +
    interface ResourceProvider<Inputs, Outputs> {
        check?: ((olds, news) => Promise<dynamic.CheckResult<Inputs>>);
        configure?: ((req) => Promise<void>);
        create: ((inputs) => Promise<dynamic.CreateResult<Outputs>>);
        delete?: ((id, props) => Promise<void>);
        diff?: ((id, olds, news) => Promise<dynamic.DiffResult>);
        read?: ((id, props?) => Promise<dynamic.ReadResult<Outputs>>);
        update?: ((id, olds, news) => Promise<dynamic.UpdateResult<Outputs>>);
    }

    Type Parameters

    • Inputs = any
    • Outputs = any

    Properties

    check? configure? create delete? @@ -10,25 +10,25 @@

    Properties

    Optional check

    check?: ((olds, news) => Promise<dynamic.CheckResult<Inputs>>)

    Validates that the given property bag is valid for a resource of the given type.

    Type declaration

    Optional configure

    configure?: ((req) => Promise<void>)

    Configures the resource provider.

    -

    Type declaration

    create

    create: ((inputs) => Promise<dynamic.CreateResult<Outputs>>)

    Allocates a new instance of the provided resource and returns its unique +

    Returns Promise<dynamic.CheckResult<Inputs>>

    Optional configure

    configure?: ((req) => Promise<void>)

    Configures the resource provider.

    +

    Type declaration

    create

    create: ((inputs) => Promise<dynamic.CreateResult<Outputs>>)

    Allocates a new instance of the provided resource and returns its unique ID afterwards. If this call fails, the resource must not have been created (i.e., it is "transactional").

    Type declaration

    Optional delete

    delete?: ((id, props) => Promise<void>)

    Tears down an existing resource with the given ID. If it fails, +

    Returns Promise<dynamic.CreateResult<Outputs>>

    Optional delete

    delete?: ((id, props) => Promise<void>)

    Tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.

    Type declaration

      • (id, props): Promise<void>

      • Parameters

        • id: string

          The ID of the resource to delete.

        • props: Outputs

          The current properties on the resource.

          -

        Returns Promise<void>

    Optional diff

    diff?: ((id, olds, news) => Promise<dynamic.DiffResult>)

    Checks what impacts a hypothetical update will have on the resource's +

    Returns Promise<void>

    Optional diff

    diff?: ((id, olds, news) => Promise<dynamic.DiffResult>)

    Checks what impacts a hypothetical update will have on the resource's properties.

    Type declaration

    Optional read

    read?: ((id, props?) => Promise<dynamic.ReadResult<Outputs>>)

    Reads the current live state associated with a resource. Enough state +

    Returns Promise<dynamic.DiffResult>

    Optional read

    read?: ((id, props?) => Promise<dynamic.ReadResult<Outputs>>)

    Reads the current live state associated with a resource. Enough state must be included in the inputs to uniquely identify the resource; this is typically just the resource ID, but it may also include some properties.

    -

    Type declaration

    Optional update

    update?: ((id, olds, news) => Promise<dynamic.UpdateResult<Outputs>>)

    Updates an existing resource with new values.

    +

    Type declaration

    Optional update

    update?: ((id, olds, news) => Promise<dynamic.UpdateResult<Outputs>>)

    Updates an existing resource with new values.

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    checkconfigurecreatedeletediffreadupdate

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<dynamic.UpdateResult<Outputs>>

    Settings

    Member Visibility

    Theme

    On This Page

    checkconfigurecreatedeletediffreadupdate

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.UpdateResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.UpdateResult.html index 45a8047deeab..196c083153be 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.UpdateResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/dynamic.UpdateResult.html @@ -1,5 +1,5 @@ UpdateResult | @pulumi/pulumi

    Interface UpdateResult<Outputs>

    UpdateResult represents the results of a call to ResourceProvider.update.

    -
    interface UpdateResult<Outputs> {
        outs?: Outputs;
    }

    Type Parameters

    • Outputs = any

    Properties

    outs? +
    interface UpdateResult<Outputs> {
        outs?: Outputs;
    }

    Type Parameters

    • Outputs = any

    Properties

    outs?

    Properties

    Optional Readonly outs

    outs?: Outputs

    Any properties that were computed during updating.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    outs

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    outs

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckFailure.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckFailure.html index 133999ac4989..b8658ec5fae3 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckFailure.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckFailure.html @@ -1,7 +1,7 @@ CheckFailure | @pulumi/pulumi

    Interface CheckFailure

    CheckFailure represents a single failure in the results of a call to ResourceProvider.check.

    -
    interface CheckFailure {
        property: string;
        reason: string;
    }

    Properties

    property +
    interface CheckFailure {
        property: string;
        reason: string;
    }

    Properties

    property reason

    Properties

    Readonly property

    property: string

    The property that failed validation.

    -

    Readonly reason

    reason: string

    The reason that the property failed validation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    propertyreason

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly reason

    reason: string

    The reason that the property failed validation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    propertyreason

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckResult.html index 50603ebb95b1..6e2f2a98a8ab 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CheckResult.html @@ -1,7 +1,7 @@ CheckResult | @pulumi/pulumi

    Interface CheckResult

    CheckResult represents the results of a call to ResourceProvider.check.

    -
    interface CheckResult {
        failures?: provider.CheckFailure[];
        inputs?: any;
    }

    Properties

    failures? +
    interface CheckResult {
        failures?: provider.CheckFailure[];
        inputs?: any;
    }

    Properties

    failures? inputs?

    Properties

    Optional Readonly failures

    failures?: provider.CheckFailure[]

    Any validation failures that occurred.

    -

    Optional Readonly inputs

    inputs?: any

    The inputs to use, if any.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    failuresinputs

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly inputs

    inputs?: any

    The inputs to use, if any.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    failuresinputs

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ConstructResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ConstructResult.html index 256e5381f25b..a2b7c5d390f6 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ConstructResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ConstructResult.html @@ -1,7 +1,7 @@ ConstructResult | @pulumi/pulumi

    Interface ConstructResult

    ConstructResult represents the results of a call to ResourceProvider.construct.

    -
    interface ConstructResult {
        state: Inputs;
        urn: Input<string>;
    }

    Properties

    state +
    interface ConstructResult {
        state: Inputs;
        urn: Input<string>;
    }

    Properties

    state urn

    Properties

    Readonly state

    state: Inputs

    Any state that was computed during construction.

    -

    Readonly urn

    urn: Input<string>

    The URN of the constructed resource.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    stateurn

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly urn

    urn: Input<string>

    The URN of the constructed resource.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    stateurn

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CreateResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CreateResult.html index b6f3081c5f8d..5b05be393dde 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CreateResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.CreateResult.html @@ -1,7 +1,7 @@ CreateResult | @pulumi/pulumi

    Interface CreateResult

    CreateResult represents the results of a call to ResourceProvider.create.

    -
    interface CreateResult {
        id: string;
        outs?: any;
    }

    Properties

    id +
    interface CreateResult {
        id: string;
        outs?: any;
    }

    Properties

    id outs?

    Properties

    Readonly id

    id: string

    The ID of the created resource.

    -

    Optional Readonly outs

    outs?: any

    Any properties that were computed during creation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    idouts

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly outs

    outs?: any

    Any properties that were computed during creation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    idouts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.DiffResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.DiffResult.html index 3fb5160160fb..e921ccb042a6 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.DiffResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.DiffResult.html @@ -1,13 +1,13 @@ DiffResult | @pulumi/pulumi

    Interface DiffResult

    DiffResult represents the results of a call to ResourceProvider.diff.

    -
    interface DiffResult {
        changes?: boolean;
        deleteBeforeReplace?: boolean;
        replaces?: string[];
        stables?: string[];
    }

    Properties

    changes? +
    interface DiffResult {
        changes?: boolean;
        deleteBeforeReplace?: boolean;
        replaces?: string[];
        stables?: string[];
    }

    Properties

    changes? deleteBeforeReplace? replaces? stables?

    Properties

    Optional Readonly changes

    changes?: boolean

    If true, this diff detected changes and suggests an update.

    -

    Optional Readonly deleteBeforeReplace

    deleteBeforeReplace?: boolean

    If true, and a replacement occurs, the resource will first be deleted +

    Optional Readonly deleteBeforeReplace

    deleteBeforeReplace?: boolean

    If true, and a replacement occurs, the resource will first be deleted before being recreated. This is to avoid potential side-by-side issues with the default create before delete behavior.

    -

    Optional Readonly replaces

    replaces?: string[]

    If this update requires a replacement, the set of properties triggering it.

    -

    Optional Readonly stables

    stables?: string[]

    An optional list of properties that will not ever change.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    changesdeleteBeforeReplacereplacesstables

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly replaces

    replaces?: string[]

    If this update requires a replacement, the set of properties triggering it.

    +

    Optional Readonly stables

    stables?: string[]

    An optional list of properties that will not ever change.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    changesdeleteBeforeReplacereplacesstables

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.InvokeResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.InvokeResult.html index f2c5e43164af..e77b8ddbb0ff 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.InvokeResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.InvokeResult.html @@ -1,7 +1,7 @@ InvokeResult | @pulumi/pulumi

    Interface InvokeResult

    InvokeResult represents the results of a call to ResourceProvider.invoke.

    -
    interface InvokeResult {
        failures?: provider.CheckFailure[];
        outputs?: any;
    }

    Properties

    failures? +
    interface InvokeResult {
        failures?: provider.CheckFailure[];
        outputs?: any;
    }

    Properties

    failures? outputs?

    Properties

    Optional Readonly failures

    failures?: provider.CheckFailure[]

    Any validation failures that occurred.

    -

    Optional Readonly outputs

    outputs?: any

    The outputs returned by the invoked function, if any.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    failuresoutputs

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly outputs

    outputs?: any

    The outputs returned by the invoked function, if any.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    failuresoutputs

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ParameterizeResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ParameterizeResult.html index 831bcfda66ad..88129eda0fb2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ParameterizeResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ParameterizeResult.html @@ -2,8 +2,8 @@ ResourceProvider.parameterize. It contains the ame and version that can be used to identify the sub-package that now exists as a result of parameterization.

    -
    interface ParameterizeResult {
        name: string;
        version: string;
    }

    Properties

    name +
    interface ParameterizeResult {
        name: string;
        version: string;
    }

    Properties

    name version

    Properties

    Readonly name

    name: string

    The name of the sub-package parameterized.

    -

    Readonly version

    version: string

    The version of the sub-package parameterized.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    nameversion

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly version

    version: string

    The version of the sub-package parameterized.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    nameversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.Provider.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.Provider.html index d3f742836039..b1127614364d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.Provider.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.Provider.html @@ -1,6 +1,6 @@ Provider | @pulumi/pulumi

    Interface Provider

    Provider represents an object that implements the resources and functions for a particular Pulumi package.

    -
    interface Provider {
        call?: ((token, inputs) => Promise<InvokeResult>);
        check?: ((urn, olds, news) => Promise<provider.CheckResult>);
        construct?: ((name, type, inputs, options) => Promise<ConstructResult>);
        create?: ((urn, inputs) => Promise<provider.CreateResult>);
        delete?: ((id, urn, props) => Promise<void>);
        diff?: ((id, urn, olds, news) => Promise<provider.DiffResult>);
        getSchema?: (() => Promise<string>);
        invoke?: ((token, inputs) => Promise<InvokeResult>);
        parameterizeArgs?: ((args) => Promise<ParameterizeResult>);
        parameterizeValue?: ((name, version, value) => Promise<ParameterizeResult>);
        read?: ((id, urn, props?) => Promise<provider.ReadResult>);
        schema?: string;
        update?: ((id, urn, olds, news) => Promise<provider.UpdateResult>);
        version?: string;
    }

    Properties

    call? +
    interface Provider {
        call?: ((token, inputs) => Promise<InvokeResult>);
        check?: ((urn, olds, news) => Promise<provider.CheckResult>);
        construct?: ((name, type, inputs, options) => Promise<ConstructResult>);
        create?: ((urn, inputs) => Promise<provider.CreateResult>);
        delete?: ((id, urn, props) => Promise<void>);
        diff?: ((id, urn, olds, news) => Promise<provider.DiffResult>);
        getSchema?: (() => Promise<string>);
        invoke?: ((token, inputs) => Promise<InvokeResult>);
        parameterizeArgs?: ((args) => Promise<ParameterizeResult>);
        parameterizeValue?: ((name, version, value) => Promise<ParameterizeResult>);
        read?: ((id, urn, props?) => Promise<provider.ReadResult>);
        schema?: string;
        update?: ((id, urn, olds, news) => Promise<provider.UpdateResult>);
        version?: string;
    }

    Properties

    call? check? construct? create? @@ -17,48 +17,48 @@

    Properties

    Optional call

    call?: ((token, inputs) => Promise<InvokeResult>)

    Calls the indicated method.

    Type declaration

      • (token, inputs): Promise<InvokeResult>

      • Parameters

        • token: string

          The token of the method to call.

        • inputs: Inputs

          The inputs to the method.

          -

        Returns Promise<InvokeResult>

    Optional check

    check?: ((urn, olds, news) => Promise<provider.CheckResult>)

    Validates that the given property bag is valid for a resource of the +

    Returns Promise<InvokeResult>

    Optional check

    check?: ((urn, olds, news) => Promise<provider.CheckResult>)

    Validates that the given property bag is valid for a resource of the given type.

    Type declaration

      • (urn, olds, news): Promise<provider.CheckResult>

      • Parameters

        • urn: string
        • olds: any

          The old input properties to use for validation.

        • news: any

          The new input properties to use for validation.

          -

        Returns Promise<provider.CheckResult>

    Optional construct

    construct?: ((name, type, inputs, options) => Promise<ConstructResult>)

    Creates a new component resource.

    +

    Returns Promise<provider.CheckResult>

    Optional construct

    construct?: ((name, type, inputs, options) => Promise<ConstructResult>)

    Creates a new component resource.

    Type declaration

    Optional create

    create?: ((urn, inputs) => Promise<provider.CreateResult>)

    Allocates a new instance of the provided resource and returns its unique +

    Returns Promise<ConstructResult>

    Optional create

    create?: ((urn, inputs) => Promise<provider.CreateResult>)

    Allocates a new instance of the provided resource and returns its unique ID afterwards. If this call fails, the resource must not have been created (i.e., it is "transactional").

    Type declaration

    Optional delete

    delete?: ((id, urn, props) => Promise<void>)

    Tears down an existing resource with the given ID. If it fails, the +

    Returns Promise<provider.CreateResult>

    Optional delete

    delete?: ((id, urn, props) => Promise<void>)

    Tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.

    Type declaration

      • (id, urn, props): Promise<void>

      • Parameters

        • id: string

          The ID of the resource to delete.

        • urn: string
        • props: any

          The current properties on the resource.

          -

        Returns Promise<void>

    Optional diff

    diff?: ((id, urn, olds, news) => Promise<provider.DiffResult>)

    Checks what impacts a hypothetical update will have on the resource's properties.

    +

    Returns Promise<void>

    Optional diff

    diff?: ((id, urn, olds, news) => Promise<provider.DiffResult>)

    Checks what impacts a hypothetical update will have on the resource's properties.

    Type declaration

      • (id, urn, olds, news): Promise<provider.DiffResult>

      • Parameters

        • id: string

          The ID of the resource to diff.

        • urn: string
        • olds: any

          The old values of properties to diff.

        • news: any

          The new values of properties to diff.

          -

        Returns Promise<provider.DiffResult>

    Optional getSchema

    getSchema?: (() => Promise<string>)

    Gets the JSON-encoded schema for this provider's package. +

    Returns Promise<provider.DiffResult>

    Optional getSchema

    getSchema?: (() => Promise<string>)

    Gets the JSON-encoded schema for this provider's package. Implementations can lazily load or generate the schema when needed.

    Type declaration

      • (): Promise<string>

      • Returns Promise<string>

    Returns

    A promise that resolves to the JSON-encoded schema string.

    -

    Optional invoke

    invoke?: ((token, inputs) => Promise<InvokeResult>)

    Calls the indicated function.

    +

    Optional invoke

    invoke?: ((token, inputs) => Promise<InvokeResult>)

    Calls the indicated function.

    Type declaration

      • (token, inputs): Promise<InvokeResult>

      • Parameters

        • token: string

          The token of the function to call.

        • inputs: any

          The inputs to the function.

          -

        Returns Promise<InvokeResult>

    Optional parameterizeArgs

    parameterizeArgs?: ((args) => Promise<ParameterizeResult>)

    Parameterizes a sub-package.

    +

    Returns Promise<InvokeResult>

    Optional parameterizeArgs

    parameterizeArgs?: ((args) => Promise<ParameterizeResult>)

    Parameterizes a sub-package.

    Type declaration

      • (args): Promise<ParameterizeResult>

      • Parameters

        • args: string[]

          A parameter value, represented as an array of strings, as might be provided by a command-line invocation, such as that used to generate an SDK.

          -

        Returns Promise<ParameterizeResult>

    Optional parameterizeValue

    parameterizeValue?: ((name, version, value) => Promise<ParameterizeResult>)

    Parameterizes a sub-package.

    +

    Returns Promise<ParameterizeResult>

    Optional parameterizeValue

    parameterizeValue?: ((name, version, value) => Promise<ParameterizeResult>)

    Parameterizes a sub-package.

    Type declaration

      • (name, version, value): Promise<ParameterizeResult>

      • Parameters

        • name: string

          The sub-package name for this sub-schema parameterization.

        • version: string

          The sub-package version for this sub-schema parameterization.

        • value: string

          The embedded value from the sub-package.

          -

        Returns Promise<ParameterizeResult>

    Optional read

    read?: ((id, urn, props?) => Promise<provider.ReadResult>)

    Reads the current live state associated with a resource. Enough state +

    Returns Promise<ParameterizeResult>

    Optional read

    read?: ((id, urn, props?) => Promise<provider.ReadResult>)

    Reads the current live state associated with a resource. Enough state must be included in the inputs to uniquely identify the resource; this is typically just the resource ID, but it may also include some properties.

    -

    Type declaration

    Optional schema

    schema?: string

    The JSON-encoded schema for this provider's package.

    -

    Optional update

    update?: ((id, urn, olds, news) => Promise<provider.UpdateResult>)

    Update updates an existing resource with new values.

    +

    Type declaration

    Optional schema

    schema?: string

    The JSON-encoded schema for this provider's package.

    +

    Optional update

    update?: ((id, urn, olds, news) => Promise<provider.UpdateResult>)

    Update updates an existing resource with new values.

    Type declaration

      • (id, urn, olds, news): Promise<provider.UpdateResult>

      • Parameters

        • id: string

          The ID of the resource to update.

        • urn: string
        • olds: any

          The old values of properties to update.

        • news: any

          The new values of properties to update.

          -

        Returns Promise<provider.UpdateResult>

    Optional version

    version?: string

    The version of the provider. Must be valid semver.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    callcheckconstructcreatedeletediffgetSchemainvokeparameterizeArgsparameterizeValuereadschemaupdateversion

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<provider.UpdateResult>

    Optional version

    version?: string

    The version of the provider. Must be valid semver.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    callcheckconstructcreatedeletediffgetSchemainvokeparameterizeArgsparameterizeValuereadschemaupdateversion

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ReadResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ReadResult.html index 95d87be1b480..a7ccfcfce6e0 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ReadResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.ReadResult.html @@ -1,9 +1,9 @@ ReadResult | @pulumi/pulumi

    Interface ReadResult

    ReadResult represents the results of a call to ResourceProvider.read.

    -
    interface ReadResult {
        id?: string;
        inputs?: any;
        props?: any;
    }

    Properties

    id? +
    interface ReadResult {
        id?: string;
        inputs?: any;
        props?: any;
    }

    Properties

    id? inputs? props?

    Properties

    Optional Readonly id

    id?: string

    The ID of the resource ready back (or blank if missing).

    -

    Optional Readonly inputs

    inputs?: any

    The inputs that would lead to the current resource state when importing it.

    -

    Optional Readonly props

    props?: any

    The current property state read from the live environment.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    idinputsprops

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly inputs

    inputs?: any

    The inputs that would lead to the current resource state when importing it.

    +

    Optional Readonly props

    props?: any

    The current property state read from the live environment.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    idinputsprops

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.UpdateResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.UpdateResult.html index 49f6e8446e24..817a9d8d1a03 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.UpdateResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/provider.UpdateResult.html @@ -1,5 +1,5 @@ UpdateResult | @pulumi/pulumi

    Interface UpdateResult

    UpdateResult represents the results of a call to ResourceProvider.update.

    -
    interface UpdateResult {
        outs?: any;
    }

    Properties

    outs? +
    interface UpdateResult {
        outs?: any;
    }

    Properties

    outs?

    Properties

    Optional Readonly outs

    outs?: any

    Any properties that were computed during updating.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    outs

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    outs

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.CodePathOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.CodePathOptions.html index 85104a2c2499..a7b002e09070 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.CodePathOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.CodePathOptions.html @@ -1,5 +1,5 @@ CodePathOptions | @pulumi/pulumi

    Interface CodePathOptions

    Options for controlling what gets returned by computeCodePaths.

    -
    interface CodePathOptions {
        extraExcludePackages?: string[];
        extraIncludePackages?: string[];
        extraIncludePaths?: string[];
        logResource?: Resource;
    }

    Properties

    extraExcludePackages? +
    interface CodePathOptions {
        extraExcludePackages?: string[];
        extraIncludePackages?: string[];
        extraIncludePaths?: string[];
        logResource?: Resource;
    }

    Properties

    extraExcludePackages? extraIncludePackages? extraIncludePaths? logResource? @@ -7,11 +7,11 @@ This can be used when clients want to trim down the size of a closure, and they know that some package won't ever actually be needed at runtime, but is still a dependency of some package that is being used at runtime.

    -

    Optional extraIncludePackages

    extraIncludePackages?: string[]

    Extra packages to include when producing the assets for a serialized +

    Optional extraIncludePackages

    extraIncludePackages?: string[]

    Extra packages to include when producing the assets for a serialized closure. This can be useful if the packages are acquired in a way that the serialization code does not understand. For example, if there was some sort of module that was pulled in based off of a computed string.

    -

    Optional extraIncludePaths

    extraIncludePaths?: string[]

    Local file/directory paths that we always want to include when producing +

    Optional extraIncludePaths

    extraIncludePaths?: string[]

    Local file/directory paths that we always want to include when producing the assets to be included for a serialized closure.

    -

    Optional logResource

    logResource?: Resource

    The resource to log any errors we encounter against.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    extraExcludePackagesextraIncludePackagesextraIncludePathslogResource

    Generated using TypeDoc

    \ No newline at end of file +

    Optional logResource

    logResource?: Resource

    The resource to log any errors we encounter against.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    extraExcludePackagesextraIncludePackagesextraIncludePathslogResource

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockCallArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockCallArgs.html index 6e7ddd78c84b..6f1ee09be144 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockCallArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockCallArgs.html @@ -1,10 +1,10 @@ MockCallArgs | @pulumi/pulumi

    Interface MockCallArgs

    MockResourceArgs is used to construct call mocks.

    -
    interface MockCallArgs {
        inputs: any;
        provider?: string;
        token: string;
    }

    Properties

    inputs +
    interface MockCallArgs {
        inputs: any;
        provider?: string;
        token: string;
    }

    Properties

    inputs provider? token

    Properties

    inputs

    inputs: any

    The arguments provided to the function call.

    -

    Optional provider

    provider?: string

    If provided, the identifier of the provider instance being used to make +

    Optional provider

    provider?: string

    If provided, the identifier of the provider instance being used to make the call.

    -

    token

    token: string

    The token that indicates which function is being called. This token is of +

    token

    token: string

    The token that indicates which function is being called. This token is of the form "package:module:function".

    -

    Settings

    Member Visibility

    Theme

    On This Page

    inputsprovidertoken

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    inputsprovidertoken

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockResourceArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockResourceArgs.html index cf454a98071d..89d7a3a56896 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockResourceArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.MockResourceArgs.html @@ -1,5 +1,5 @@ MockResourceArgs | @pulumi/pulumi

    Interface MockResourceArgs

    MockResourceArgs is used to construct a new resource mock.

    -
    interface MockResourceArgs {
        custom?: boolean;
        id?: string;
        inputs: any;
        name: string;
        provider?: string;
        type: string;
    }

    Properties

    custom? +
    interface MockResourceArgs {
        custom?: boolean;
        id?: string;
        inputs: any;
        name: string;
        provider?: string;
        type: string;
    }

    Properties

    custom? id? inputs name @@ -7,12 +7,12 @@ type

    Properties

    Optional custom

    custom?: boolean

    Specifies whether or not the resource is Custom (i.e. managed by a resource provider).

    -

    Optional id

    id?: string

    If provided, the physical identifier of an existing resource to read or +

    Optional id

    id?: string

    If provided, the physical identifier of an existing resource to read or import.

    -

    inputs

    inputs: any

    The inputs for the resource.

    -

    name

    name: string

    The logical name of the resource instance.

    -

    Optional provider

    provider?: string

    If provided, the identifier of the provider instance being used to manage +

    inputs

    inputs: any

    The inputs for the resource.

    +

    name

    name: string

    The logical name of the resource instance.

    +

    Optional provider

    provider?: string

    If provided, the identifier of the provider instance being used to manage this resource.

    -

    type

    type: string

    The token that indicates which resource type is being constructed. This +

    type

    type: string

    The token that indicates which resource type is being constructed. This token is of the form "package:module:type".

    -

    Settings

    Member Visibility

    Theme

    On This Page

    customidinputsnameprovidertype

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    customidinputsnameprovidertype

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Mocks.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Mocks.html index e570d843de0b..27551c002fc2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Mocks.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Mocks.html @@ -2,12 +2,12 @@ implemented by the Pulumi engine with their own implementations. This can be used during testing to ensure that calls to provider functions and resource constructors return predictable values.

    -
    interface Mocks {
        call(args): MockCallResult | Promise<MockCallResult>;
        newResource(args): MockResourceResult | Promise<MockResourceResult>;
    }

    Methods

    call +
    interface Mocks {
        call(args): MockCallResult | Promise<MockCallResult>;
        newResource(args): MockResourceResult | Promise<MockResourceResult>;
    }

    Methods

    call newResource

    Methods

    call

    newResource

    Returns MockCallResult | Promise<MockCallResult>

    newResource

    Settings

    Member Visibility

    Theme

    On This Page

    callnewResource

    Generated using TypeDoc

    \ No newline at end of file +

    Returns MockResourceResult | Promise<MockResourceResult>

    Settings

    Member Visibility

    Theme

    On This Page

    callnewResource

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Options.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Options.html index 35a90036257c..e78e768ccd20 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Options.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.Options.html @@ -1,6 +1,6 @@ Options | @pulumi/pulumi

    Interface Options

    Options is a bag of settings that controls the behavior of previews and deployments.

    -
    interface Options {
        cacheDynamicProviders?: boolean;
        dryRun?: boolean;
        engineAddr?: string;
        legacyApply?: boolean;
        monitorAddr?: string;
        organization?: string;
        parallel?: number;
        project?: string;
        rootDirectory?: string;
        stack?: string;
        syncDir?: string;
        testModeEnabled?: boolean;
    }

    Properties

    cacheDynamicProviders? +
    interface Options {
        cacheDynamicProviders?: boolean;
        dryRun?: boolean;
        engineAddr?: string;
        legacyApply?: boolean;
        monitorAddr?: string;
        organization?: string;
        parallel?: number;
        project?: string;
        rootDirectory?: string;
        stack?: string;
        syncDir?: string;
        testModeEnabled?: boolean;
    }

    Properties

    cacheDynamicProviders? dryRun? engineAddr? legacyApply? @@ -13,16 +13,16 @@ syncDir? testModeEnabled?

    Properties

    Optional Readonly cacheDynamicProviders

    cacheDynamicProviders?: boolean

    True if we will cache serialized dynamic providers on the program side.

    -

    Optional Readonly dryRun

    dryRun?: boolean

    Whether we are performing a preview (true) or a real deployment (false).

    -

    Optional Readonly engineAddr

    engineAddr?: string

    A connection string to the engine's RPC, in case we need to reestablish.

    -

    Optional Readonly legacyApply

    legacyApply?: boolean

    True if we will resolve missing outputs to inputs during preview.

    -

    Optional Readonly monitorAddr

    monitorAddr?: string

    A connection string to the monitor's RPC, in case we need to reestablish.

    -

    Optional Readonly organization

    organization?: string

    The name of the current organization.

    -

    Optional Readonly parallel

    parallel?: number

    The degree of parallelism for resource operations (default is serial).

    -

    Optional Readonly project

    project?: string

    The name of the current project.

    -

    Optional Readonly rootDirectory

    rootDirectory?: string

    The root directory of the current project. This is the location of the Pulumi.yaml file.

    -

    Optional Readonly stack

    stack?: string

    The name of the current stack being deployed into.

    -

    Optional Readonly syncDir

    syncDir?: string

    A directory containing the send/receive files for making synchronous +

    Optional Readonly dryRun

    dryRun?: boolean

    Whether we are performing a preview (true) or a real deployment (false).

    +

    Optional Readonly engineAddr

    engineAddr?: string

    A connection string to the engine's RPC, in case we need to reestablish.

    +

    Optional Readonly legacyApply

    legacyApply?: boolean

    True if we will resolve missing outputs to inputs during preview.

    +

    Optional Readonly monitorAddr

    monitorAddr?: string

    A connection string to the monitor's RPC, in case we need to reestablish.

    +

    Optional Readonly organization

    organization?: string

    The name of the current organization.

    +

    Optional Readonly parallel

    parallel?: number

    The degree of parallelism for resource operations (default is serial).

    +

    Optional Readonly project

    project?: string

    The name of the current project.

    +

    Optional Readonly rootDirectory

    rootDirectory?: string

    The root directory of the current project. This is the location of the Pulumi.yaml file.

    +

    Optional Readonly stack

    stack?: string

    The name of the current stack being deployed into.

    +

    Optional Readonly syncDir

    syncDir?: string

    A directory containing the send/receive files for making synchronous invokes to the engine.

    -

    Optional Readonly testModeEnabled

    testModeEnabled?: boolean

    True if we're in testing mode (allows execution without the CLI).

    -

    Settings

    Member Visibility

    Theme

    On This Page

    cacheDynamicProvidersdryRunengineAddrlegacyApplymonitorAddrorganizationparallelprojectrootDirectorystacksyncDirtestModeEnabled

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly testModeEnabled

    testModeEnabled?: boolean

    True if we're in testing mode (allows execution without the CLI).

    +

    Settings

    Member Visibility

    Theme

    On This Page

    cacheDynamicProvidersdryRunengineAddrlegacyApplymonitorAddrorganizationparallelprojectrootDirectorystacksyncDirtestModeEnabled

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourceModule.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourceModule.html index 3e92d3ab88fd..b101082f9056 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourceModule.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourceModule.html @@ -1,5 +1,5 @@ ResourceModule | @pulumi/pulumi

    Interface ResourceModule

    A ResourceModule is a type that understands how to construct resources given a name, type, args, and URN.

    -
    interface ResourceModule {
        version?: string;
        construct(name, type, urn): Resource;
    }

    Properties

    version? +
    interface ResourceModule {
        version?: string;
        construct(name, type, urn): Resource;
    }

    Properties

    version?

    Methods

    construct -

    Properties

    Optional Readonly version

    version?: string

    Methods

    construct

    Settings

    Member Visibility

    Theme

    On This Page

    versionconstruct

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Readonly version

    version?: string

    Methods

    construct

    Settings

    Member Visibility

    Theme

    On This Page

    versionconstruct

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourcePackage.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourcePackage.html index dda71b3fb964..20d1a95ebbf2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourcePackage.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.ResourcePackage.html @@ -1,5 +1,5 @@ ResourcePackage | @pulumi/pulumi

    Interface ResourcePackage

    A ResourcePackage is a type that understands how to construct resource providers given a name, type, args, and URN.

    -
    interface ResourcePackage {
        version?: string;
        constructProvider(name, type, urn): ProviderResource;
    }

    Properties

    version? +
    interface ResourcePackage {
        version?: string;
        constructProvider(name, type, urn): ProviderResource;
    }

    Properties

    version?

    Methods

    constructProvider -

    Properties

    Optional Readonly version

    version?: string

    Methods

    constructProvider

    Settings

    Member Visibility

    Theme

    On This Page

    versionconstructProvider

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Readonly version

    version?: string

    Methods

    constructProvider

    Settings

    Member Visibility

    Theme

    On This Page

    versionconstructProvider

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializationOptions.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializationOptions.html index 7de1910ff9c3..c981b649f1a9 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializationOptions.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializationOptions.html @@ -1,11 +1,11 @@ SerializationOptions | @pulumi/pulumi

    Interface SerializationOptions

    Controls the serialization of RPC structures.

    -
    interface SerializationOptions {
        excludeResourceReferencesFromDependencies?: boolean;
        keepOutputValues?: boolean;
    }

    Properties

    excludeResourceReferencesFromDependencies? +
    interface SerializationOptions {
        excludeResourceReferencesFromDependencies?: boolean;
        keepOutputValues?: boolean;
    }

    Properties

    excludeResourceReferencesFromDependencies? keepOutputValues?

    Properties

    Optional excludeResourceReferencesFromDependencies

    excludeResourceReferencesFromDependencies?: boolean

    True if we should exclude resource references from the set of dependencies identified during serialization. This is useful for remote components where we want propertyDependencies to be empty for a property that only contains resource references. If the monitor does not support resource references, this will have no effect.

    -

    Optional keepOutputValues

    keepOutputValues?: boolean

    True if we are keeping output values. If the monitor does not support +

    Optional keepOutputValues

    keepOutputValues?: boolean

    True if we are keeping output values. If the monitor does not support output values, they will not be kept, even when this is set to true.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    excludeResourceReferencesFromDependencieskeepOutputValues

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    excludeResourceReferencesFromDependencieskeepOutputValues

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializeFunctionArgs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializeFunctionArgs.html index 33c7c319928d..b0c1d6b352ae 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializeFunctionArgs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializeFunctionArgs.html @@ -1,6 +1,6 @@ SerializeFunctionArgs | @pulumi/pulumi

    Interface SerializeFunctionArgs

    SerializeFunctionArgs are arguments used to serialize a JavaScript function.

    -
    interface SerializeFunctionArgs {
        allowSecrets?: boolean;
        exportName?: string;
        isFactoryFunction?: boolean;
        logResource?: Resource;
        serialize?: ((o) => boolean);
    }

    Properties

    allowSecrets? +
    interface SerializeFunctionArgs {
        allowSecrets?: boolean;
        exportName?: string;
        isFactoryFunction?: boolean;
        logResource?: Resource;
        serialize?: ((o) => boolean);
    }

    Properties

    allowSecrets? exportName? isFactoryFunction? logResource? @@ -12,16 +12,16 @@ containsSecrets property on the returned SerializedFunction object will indicate whether secrets were serialized into the function text.

    -

    Optional exportName

    exportName?: string

    The name to export from the module defined by the generated module text. +

    Optional exportName

    exportName?: string

    The name to export from the module defined by the generated module text. Defaults to handler.

    -

    Optional isFactoryFunction

    isFactoryFunction?: boolean

    True if this is a function which, when invoked, will produce the actual +

    Optional isFactoryFunction

    isFactoryFunction?: boolean

    True if this is a function which, when invoked, will produce the actual entrypoint function. Useful for when serializing a function that has high startup cost that we'd ideally only run once. The signature of this function should be () => (provider_handler_args...) => provider_result.

    This will then be emitted as exports.[exportName] = serialized_func_name();

    In other words, the function will be invoked (once) and the resulting inner function will be what is exported.

    -

    Optional logResource

    logResource?: Resource

    The resource to log any errors we encounter against.

    -

    Optional serialize

    serialize?: ((o) => boolean)

    A function to prevent serialization of certain objects captured during +

    Optional logResource

    logResource?: Resource

    The resource to log any errors we encounter against.

    +

    Optional serialize

    serialize?: ((o) => boolean)

    A function to prevent serialization of certain objects captured during the serialization. Primarily used to prevent potential cycles.

    -

    Type declaration

      • (o): boolean

      • Parameters

        • o: any

        Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    allowSecretsexportNameisFactoryFunctionlogResourceserialize

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

      • (o): boolean

      • Parameters

        • o: any

        Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    allowSecretsexportNameisFactoryFunctionlogResourceserialize

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializedFunction.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializedFunction.html index c3b7adb3488b..a2f4c2df8874 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializedFunction.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SerializedFunction.html @@ -1,12 +1,12 @@ SerializedFunction | @pulumi/pulumi

    Interface SerializedFunction

    SerializedFunction is a representation of a serialized JavaScript function.

    -
    interface SerializedFunction {
        containsSecrets: boolean;
        exportName: string;
        text: string;
    }

    Properties

    containsSecrets +
    interface SerializedFunction {
        containsSecrets: boolean;
        exportName: string;
        text: string;
    }

    Properties

    containsSecrets exportName text

    Properties

    containsSecrets

    containsSecrets: boolean

    True if the serialized function text includes serialized secrets.

    -

    exportName

    exportName: string

    The name of the exported module member.

    -

    text

    text: string

    The text of a JavaScript module which exports a single name bound to an +

    exportName

    exportName: string

    The name of the exported module member.

    +

    text

    text: string

    The text of a JavaScript module which exports a single name bound to an appropriate value. In the case of a normal function, this value will just be serialized function. In the case of a factory function this value will be the result of invoking the factory function.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    containsSecretsexportNametext

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    containsSecretsexportNametext

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SourcePosition.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SourcePosition.html index 9a5bb94441d6..2c6e088ed932 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SourcePosition.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/interfaces/runtime.SourcePosition.html @@ -1,4 +1,4 @@ -SourcePosition | @pulumi/pulumi

    Interface SourcePosition

    interface SourcePosition {
        column: number;
        line: number;
        uri: string;
    }

    Properties

    column +SourcePosition | @pulumi/pulumi

    Interface SourcePosition

    interface SourcePosition {
        column: number;
        line: number;
        uri: string;
    }

    Properties

    column line uri -

    Properties

    column

    column: number

    line

    line: number

    uri

    uri: string

    Settings

    Member Visibility

    Theme

    On This Page

    columnlineuri

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    column

    column: number

    line

    line: number

    uri

    uri: string

    Settings

    Member Visibility

    Theme

    On This Page

    columnlineuri

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/asset.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/asset.html index 642beacf334a..001f91f740d2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/asset.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/asset.html @@ -1,4 +1,4 @@ -asset | @pulumi/pulumi

    Namespace asset

    Index

    Classes

    Archive +asset | @pulumi/pulumi

    Namespace asset

    Index

    Classes

    Archive Asset AssetArchive FileArchive diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/automation.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/automation.html index 9b99621e8ee3..9d81b1e105bf 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/automation.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/automation.html @@ -1,4 +1,4 @@ -automation | @pulumi/pulumi

    Namespace automation

    Index

    Enumerations

    DiffKind +automation | @pulumi/pulumi

    Namespace automation

    Index

    Enumerations

    DiffKind

    Classes

    CommandError ConcurrentUpdateError LocalWorkspace diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/dynamic.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/dynamic.html index 59c11d9f9db4..4b88e9dcea81 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/dynamic.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/dynamic.html @@ -1,4 +1,4 @@ -dynamic | @pulumi/pulumi

    Namespace dynamic

    Index

    Classes

    Resource +dynamic | @pulumi/pulumi

    Namespace dynamic

    Index

    Classes

    Resource

    Interfaces

    CheckFailure CheckResult Config diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/iterable.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/iterable.html index a7f417f73e20..ee532e87dcf2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/iterable.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/iterable.html @@ -1,3 +1,3 @@ -iterable | @pulumi/pulumi

    Namespace iterable

    Index

    Functions

    groupBy +iterable | @pulumi/pulumi

    Namespace iterable

    Index

    Functions

    groupBy toObject

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/log.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/log.html index 310fce9c860f..080b1f1e0477 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/log.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/log.html @@ -1,4 +1,4 @@ -log | @pulumi/pulumi

    Namespace log

    Index

    Functions

    debug +log | @pulumi/pulumi

    Namespace log

    Index

    Functions

    debug error hasErrors info diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/provider.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/provider.html index 9e28c2a75068..ea280e7c485b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/provider.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/provider.html @@ -1,4 +1,4 @@ -provider | @pulumi/pulumi

    Namespace provider

    Index

    Interfaces

    CheckFailure +provider | @pulumi/pulumi

    Namespace provider

    Index

    Interfaces

    CheckFailure CheckResult ConstructResult CreateResult diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/runtime.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/runtime.html index 4215ee1bee01..a84d943c920d 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/runtime.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/runtime.html @@ -1,4 +1,4 @@ -runtime | @pulumi/pulumi

    Namespace runtime

    Index

    Classes

    Stack +runtime | @pulumi/pulumi

    Namespace runtime

    Index

    Classes

    Stack

    Interfaces

    CodePathOptions MockCallArgs MockResourceArgs diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/utils.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/utils.html index 8ac05922b2f4..0b2ec303e3a1 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/utils.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/modules/utils.html @@ -1 +1 @@ -utils | @pulumi/pulumi

    Namespace utils

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +utils | @pulumi/pulumi

    Namespace utils

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ID.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ID.html index 42e5adf4c307..d5ba5dbdb4aa 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ID.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ID.html @@ -1 +1 @@ -ID | @pulumi/pulumi

    Type alias ID

    ID: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ID | @pulumi/pulumi

    Type alias ID

    ID: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Input.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Input.html index c91f17d41073..452a51dce35b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Input.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Input.html @@ -1,4 +1,4 @@ Input | @pulumi/pulumi

    Type alias Input<T>

    Input<T>: T | Promise<T> | OutputInstance<T>

    Input is a property input for a resource. It may be a promptly available T, a promise for one, or the Output from a existing Resource.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Inputs.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Inputs.html index f99023ec0aa6..b294d83bbc48 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Inputs.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Inputs.html @@ -1,3 +1,3 @@ Inputs | @pulumi/pulumi

    Type alias Inputs

    Inputs: Record<string, Input<any>>

    Inputs is a map of property name to property input, one for each resource property value.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/InvokeTransform.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/InvokeTransform.html index 582b5df8a5f9..5bed92127fe0 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/InvokeTransform.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/InvokeTransform.html @@ -6,4 +6,4 @@ in place of the original call to the Invoke. If the transform returns nil, this indicates that the Invoke

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Lifted.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Lifted.html index 2b0e0082dbd5..e5926843cad3 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Lifted.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Lifted.html @@ -19,4 +19,4 @@

    Instead, you still need to write;

         const o: Output<string> = ...;
         const c: Output<number> = o.apply(v => v.charCodeAt(0));
    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedArray.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedArray.html index 82aa65afe653..ca0a39f03522 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedArray.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedArray.html @@ -1,3 +1,3 @@ LiftedArray | @pulumi/pulumi

    Type alias LiftedArray<T>

    LiftedArray<T>: {
        length: Output<number>;
        [n: number]: Output<T>;
    }

    Type Parameters

    • T

    Type declaration

    • [n: number]: Output<T>
    • Readonly length: Output<number>

      Gets the length of the array. This is a number one higher than the highest element defined in an array.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedObject.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedObject.html index 29af4a321728..d9836cdd7060 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedObject.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/LiftedObject.html @@ -1 +1 @@ -LiftedObject | @pulumi/pulumi

    Type alias LiftedObject<T, K>

    LiftedObject<T, K>: {
        [P in K]: IsStrictlyAny<T[P]> extends true
            ? Output<any>
            : T[P] extends OutputInstance<infer T1>
                ? Output<T1>
                : T[P] extends Promise<infer T2>
                    ? Output<T2>
                    : Output<T[P]>
    }

    Type Parameters

    • T
    • K extends keyof T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +LiftedObject | @pulumi/pulumi

    Type alias LiftedObject<T, K>

    LiftedObject<T, K>: {
        [P in K]: IsStrictlyAny<T[P]> extends true
            ? Output<any>
            : T[P] extends OutputInstance<infer T1>
                ? Output<T1>
                : T[P] extends Promise<infer T2>
                    ? Output<T2>
                    : Output<T[P]>
    }

    Type Parameters

    • T
    • K extends keyof T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Output.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Output.html index 6147ab2a7a53..3c41b4afd3b5 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Output.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Output.html @@ -27,4 +27,4 @@

    Instead of having to write:

         const o: Output<{ name: string, age: number, orders: Order[] }> = ...;
         const name : Output<string> = o.apply(v => v.name);
         const age  : Output<number> = o.apply(v => v.age);
         const first: Output<Order> = o.apply(v => v.orders[0]);
    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransform.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransform.html index adb90b0bd572..a65ea87ba6d8 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransform.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransform.html @@ -6,4 +6,4 @@ place of the original call to the Resource constructor. If the transform returns undefined, this indicates that the resource will not be transformed.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransformation.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransformation.html index 806c7b27f266..f25fcfa437dc 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransformation.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/ResourceTransformation.html @@ -6,4 +6,4 @@ and opts were passed in place of the original call to the Resource constructor. If the transformation returns undefined, this indicates that the resource will not be transformed.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/URN.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/URN.html index 63879746a7f2..8b1cb54f2497 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/URN.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/URN.html @@ -1 +1 @@ -URN | @pulumi/pulumi

    Type alias URN

    URN: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +URN | @pulumi/pulumi

    Type alias URN

    URN: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Unwrap.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Unwrap.html index 611addcd40ac..83dd7bc357f0 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Unwrap.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/Unwrap.html @@ -16,4 +16,4 @@ Or, it should start with an output and call apply on it, passing in an async function. This will also collapse and just produce an output.

    In other words, this should not be used as the shape of an object: { a: Promise<Output<...>> }. It should always either be { a: Promise<NonOutput> } or just { a: Output<...> }.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrapSimple.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrapSimple.html index 6f40c1260b9c..65200abb8d5b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrapSimple.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrapSimple.html @@ -1,2 +1,2 @@ UnwrapSimple | @pulumi/pulumi

    Type alias UnwrapSimple<T>

    UnwrapSimple<T>: T extends primitive
        ? T
        : T extends Resource
            ? T
            : T extends [any, ...any[]]
                ? UnwrappedObject<T>
                : T extends (infer U)[]
                    ? UnwrappedArray<U>
                    : T extends object
                        ? UnwrappedObject<T>
                        : never

    Handles encountering basic types when unwrapping.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedArray.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedArray.html index 834198d8dbd1..dde010f64a70 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedArray.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedArray.html @@ -1 +1 @@ -UnwrappedArray | @pulumi/pulumi

    Type alias UnwrappedArray<T>

    UnwrappedArray<T>: Unwrap<T>[]

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +UnwrappedArray | @pulumi/pulumi

    Type alias UnwrappedArray<T>

    UnwrappedArray<T>: Unwrap<T>[]

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedObject.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedObject.html index ef5b9904e26f..3a30916c52b2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedObject.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/UnwrappedObject.html @@ -1 +1 @@ -UnwrappedObject | @pulumi/pulumi

    Type alias UnwrappedObject<T>

    UnwrappedObject<T>: {
        [P in keyof T]: Unwrap<T[P]>
    }

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +UnwrappedObject | @pulumi/pulumi

    Type alias UnwrappedObject<T>

    UnwrappedObject<T>: {
        [P in keyof T]: Unwrap<T[P]>
    }

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/asset.AssetMap.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/asset.AssetMap.html index 8fc2a4f3ed24..dcd2227373e4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/asset.AssetMap.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/asset.AssetMap.html @@ -1,2 +1,2 @@ AssetMap | @pulumi/pulumi

    Type alias AssetMap

    AssetMap: {
        [name: string]: Asset | Archive;
    }

    A map of assets.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.CancelEvent.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.CancelEvent.html index 8fdd9a0e386e..8c5aa7ae0762 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.CancelEvent.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.CancelEvent.html @@ -1,3 +1,3 @@ CancelEvent | @pulumi/pulumi

    Type alias CancelEvent

    CancelEvent: {}

    CancelEvent is emitted when the user initiates a cancellation of the update in progress, or the update successfully completes.

    -

    Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ConfigMap.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ConfigMap.html index a196fd69a8f3..a9a213fdcf1e 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ConfigMap.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ConfigMap.html @@ -1,2 +1,2 @@ ConfigMap | @pulumi/pulumi

        Type alias ConfigMap

        ConfigMap: {
            [key: string]: ConfigValue;
        }

        A map of configuration values.

        -

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpMap.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpMap.html index 054b123e5e8f..e4505c51972b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpMap.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpMap.html @@ -1,2 +1,2 @@ OpMap | @pulumi/pulumi

        Type alias OpMap

        OpMap: {
            [key in OpType]?: number
        }

        A map of operation types and their corresponding counts.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpType.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpType.html index e8d81c425c5d..5d464951f751 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpType.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OpType.html @@ -1,2 +1,2 @@ OpType | @pulumi/pulumi

        Type alias OpType

        OpType: "same" | "create" | "update" | "delete" | "replace" | "create-replacement" | "delete-replaced" | "read" | "read-replacement" | "refresh" | "discard" | "discard-replaced" | "remove-pending-replace" | "import" | "import-replacement"

        The granular CRUD operation performed on a particular resource during an update.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OutputMap.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OutputMap.html index 50dff7a17ef5..bb36db4e9eb6 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OutputMap.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.OutputMap.html @@ -1,3 +1,3 @@ OutputMap | @pulumi/pulumi

        Type alias OutputMap

        OutputMap: {
            [key: string]: OutputValue;
        }

        A set of outputs, keyed by name, that might be returned by a Pulumi program as part of a stack operation.

        -

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PluginKind.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PluginKind.html index 9e2446c957b1..c4fc9d11eee9 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PluginKind.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PluginKind.html @@ -1 +1 @@ -PluginKind | @pulumi/pulumi

        Type alias PluginKind

        PluginKind: "analyzer" | "language" | "resource"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PluginKind | @pulumi/pulumi

        Type alias PluginKind

        PluginKind: "analyzer" | "language" | "resource"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ProjectRuntime.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ProjectRuntime.html index 7205623cca93..d8ec3378206b 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ProjectRuntime.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.ProjectRuntime.html @@ -1,2 +1,2 @@ ProjectRuntime | @pulumi/pulumi

        Type alias ProjectRuntime

        ProjectRuntime: "nodejs" | "go" | "python" | "dotnet"

        Supported Pulumi program language runtimes.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PulumiFn.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PulumiFn.html index c18a43782a99..3fa7cea3cefd 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PulumiFn.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.PulumiFn.html @@ -1,2 +1,2 @@ PulumiFn | @pulumi/pulumi

        Type alias PulumiFn

        PulumiFn: (() => Promise<Record<string, any> | void>)

        A Pulumi program as an inline function (in process).

        -

        Type declaration

          • (): Promise<Record<string, any> | void>

          • Returns Promise<Record<string, any> | void>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

          • (): Promise<Record<string, any> | void>

          • Returns Promise<Record<string, any> | void>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.RawJSON.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.RawJSON.html index 58434f5508a8..e3b836dc85d6 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.RawJSON.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.RawJSON.html @@ -1,2 +1,2 @@ RawJSON | @pulumi/pulumi

        Type alias RawJSON

        RawJSON: string

        An unstructured JSON string used for back-compat with versioned APIs (such as Deployment).

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.StackSettingsConfigValue.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.StackSettingsConfigValue.html index 1d914084f470..04a1df2742da 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.StackSettingsConfigValue.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.StackSettingsConfigValue.html @@ -1,2 +1,2 @@ StackSettingsConfigValue | @pulumi/pulumi

        Type alias StackSettingsConfigValue

        StackSettingsConfigValue: string | StackSettingsSecureConfigValue | any

        A stack configuration entry.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.TagMap.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.TagMap.html index bd6a12fdf0c5..a940cb286cfd 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.TagMap.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.TagMap.html @@ -1,3 +1,3 @@ TagMap | @pulumi/pulumi

        Type alias TagMap

        TagMap: {
            [key: string]: string;
        }

        A TagMap is a key-value map of tag metadata associated with a Stack.

        -

        Type declaration

        • [key: string]: string

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        • [key: string]: string

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateKind.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateKind.html index 5f6183a25838..caaebd8caa2a 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateKind.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateKind.html @@ -1,2 +1,2 @@ UpdateKind | @pulumi/pulumi

        Type alias UpdateKind

        UpdateKind: "update" | "preview" | "refresh" | "rename" | "destroy" | "import"

        The kind of update that was performed on the stack.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateResult.html index 507d199f7c5a..5b61bb4c676f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/automation.UpdateResult.html @@ -1,2 +1,2 @@ UpdateResult | @pulumi/pulumi

        Type alias UpdateResult

        UpdateResult: "not-started" | "in-progress" | "succeeded" | "failed"

        Represents the current status of a given update.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockCallResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockCallResult.html index 4441463899dc..f8885c0f1ec4 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockCallResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockCallResult.html @@ -1,2 +1,2 @@ MockCallResult | @pulumi/pulumi

        Type alias MockCallResult

        MockCallResult: Record<string, any>

        MockCallResult is the result of a call mock.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockResourceResult.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockResourceResult.html index 2432c4ab5383..5e4d897af2b7 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockResourceResult.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.MockResourceResult.html @@ -1,4 +1,4 @@ MockResourceResult | @pulumi/pulumi

        Type alias MockResourceResult

        MockResourceResult: {
            id: string | undefined;
            state: Record<string, any>;
        }

        MockResourceResult is the result of a new resource mock, returning a physical identifier and the output properties for the resource being constructed.

        -

        Type declaration

        • id: string | undefined
        • state: Record<string, any>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        • id: string | undefined
        • state: Record<string, any>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.OutputResolvers.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.OutputResolvers.html index 1b4882594cb8..324ca17e6119 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.OutputResolvers.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/types/runtime.OutputResolvers.html @@ -1 +1 @@ -OutputResolvers | @pulumi/pulumi

        Type alias OutputResolvers

        OutputResolvers: Record<string, ((value, isStable, isSecret, deps?, err?) => void)>

        Type declaration

          • (value, isStable, isSecret, deps?, err?): void

          • Parameters

            • value: any
            • isStable: boolean
            • isSecret: boolean
            • Optional deps: Resource[]
            • Optional err: Error

            Returns void

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +OutputResolvers | @pulumi/pulumi

        Type alias OutputResolvers

        OutputResolvers: Record<string, ((value, isStable, isSecret, deps?, err?) => void)>

        Type declaration

          • (value, isStable, isSecret, deps?, err?): void

          • Parameters

            • value: any
            • isStable: boolean
            • isSecret: boolean
            • Optional deps: Resource[]
            • Optional err: Error

            Returns void

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/Output-1.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/Output-1.html index 649368b6c273..6c14ee5e12f5 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/Output-1.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/Output-1.html @@ -1 +1 @@ -Output | @pulumi/pulumi

        Variable Output

        Output: OutputConstructor

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +Output | @pulumi/pulumi

        Variable Output

        Output: OutputConstructor

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/rootStackResource.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/rootStackResource.html index 485cb561edbb..181f7234ff91 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/rootStackResource.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/rootStackResource.html @@ -9,4 +9,4 @@

        However, the former form is preferable as it is more self-descriptive, while the latter may look a bit confusing and may incorrectly look like something that could be removed without changing semantics.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.excessiveDebugOutput.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.excessiveDebugOutput.html index 43073bddcf7d..e9273fe890a8 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.excessiveDebugOutput.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.excessiveDebugOutput.html @@ -1,3 +1,3 @@ excessiveDebugOutput | @pulumi/pulumi

        Variable excessiveDebugOutputConst

        excessiveDebugOutput: boolean = false

        excessiveDebugOutput enables, well, pretty excessive debug output pertaining to resources and properties.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.rootPulumiStackTypeName.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.rootPulumiStackTypeName.html index 05d3c73694fd..f14f93497592 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.rootPulumiStackTypeName.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.rootPulumiStackTypeName.html @@ -1,4 +1,4 @@ rootPulumiStackTypeName | @pulumi/pulumi

        Variable rootPulumiStackTypeNameConst

        rootPulumiStackTypeName: "pulumi:pulumi:Stack" = "pulumi:pulumi:Stack"

        The type name that should be used to construct the root component in the tree of Pulumi resources allocated by a deployment. This must be kept up to date with github.com/pulumi/pulumi/sdk/v3/go/common/resource/stack.RootStackType.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialArchiveSig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialArchiveSig.html index 43dd35573ef4..833fe0530cfc 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialArchiveSig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialArchiveSig.html @@ -1,4 +1,4 @@ specialArchiveSig | @pulumi/pulumi

        Variable specialArchiveSigConst

        specialArchiveSig: "0def7320c3a5731c473e5ecbe6d01bc7" = "0def7320c3a5731c473e5ecbe6d01bc7"

        specialArchiveSig is a randomly assigned hash used to identify archives in maps.

        See

        sdk/go/common/resource/asset.go.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialAssetSig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialAssetSig.html index a938ae0f2fcc..614603257476 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialAssetSig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialAssetSig.html @@ -1,4 +1,4 @@ specialAssetSig | @pulumi/pulumi

        Variable specialAssetSigConst

        specialAssetSig: "c44067f5952c0a294b673a41bacd8c17" = "c44067f5952c0a294b673a41bacd8c17"

        specialAssetSig is a randomly assigned hash used to identify assets in maps.

        See

        sdk/go/common/resource/asset.go.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialOutputValueSig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialOutputValueSig.html index 5e2d92c05638..863eec1a554f 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialOutputValueSig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialOutputValueSig.html @@ -1,4 +1,4 @@ specialOutputValueSig | @pulumi/pulumi

        Variable specialOutputValueSigConst

        specialOutputValueSig: "d0e6a833031e9bbcd3f4e8bde6ca49a4" = "d0e6a833031e9bbcd3f4e8bde6ca49a4"

        specialOutputValueSig is a randomly assigned hash used to identify outputs in maps.

        See

        sdk/go/common/resource/properties.go.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialResourceSig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialResourceSig.html index cb88da785df9..5b13c37ce2c6 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialResourceSig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialResourceSig.html @@ -1,4 +1,4 @@ specialResourceSig | @pulumi/pulumi

        Variable specialResourceSigConst

        specialResourceSig: "5cf8f73096256a8f31e491e813e4eb8e" = "5cf8f73096256a8f31e491e813e4eb8e"

        specialResourceSig is a randomly assigned hash used to identify resources in maps.

        See

        sdk/go/common/resource/properties.go.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSecretSig.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSecretSig.html index 9982ba5b87c6..d9b8d95b4763 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSecretSig.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSecretSig.html @@ -1,4 +1,4 @@ specialSecretSig | @pulumi/pulumi

        Variable specialSecretSigConst

        specialSecretSig: "1b47061264138c4ac30d75fd1eb44270" = "1b47061264138c4ac30d75fd1eb44270"

        specialSecretSig is a randomly assigned hash used to identify secrets in maps.

        See

        sdk/go/common/resource/properties.go.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSigKey.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSigKey.html index 55c46331abaa..483513dbeec2 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSigKey.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.specialSigKey.html @@ -1,4 +1,4 @@ specialSigKey | @pulumi/pulumi

        Variable specialSigKeyConst

        specialSigKey: "4dabf18193072939515e22adb298388d" = "4dabf18193072939515e22adb298388d"

        specialSigKey is sometimes used to encode type identity inside of a map.

        See

        sdk/go/common/resource/properties.go.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.unknownValue.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.unknownValue.html index 2a3ff2892eb0..a10d08a49f48 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.unknownValue.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/runtime.unknownValue.html @@ -1,2 +1,2 @@ unknownValue | @pulumi/pulumi

        Variable unknownValueConst

        unknownValue: "04da6b54-80e4-46f7-96ec-b56ff0331ba9" = "04da6b54-80e4-46f7-96ec-b56ff0331ba9"

        Unknown values are encoded as a distinguished string value.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/unknown.html b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/unknown.html index 3d2648aed1bd..fb3ce2397422 100644 --- a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/unknown.html +++ b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/pulumi/variables/unknown.html @@ -1,2 +1,2 @@ unknown | @pulumi/pulumi

        Variable unknownConst

        unknown: Unknown = ...

        unknown is the singleton Unknown value.

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/static/latest-version b/static/latest-version index fd053f652c07..a9c5754c6502 100644 --- a/static/latest-version +++ b/static/latest-version @@ -1 +1 @@ -3.167.0 \ No newline at end of file +3.168.0 \ No newline at end of file