Interface RefreshOptions

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

interface RefreshOptions {
    clearPendingCreates?: boolean;
    color?: "always" | "never" | "raw" | "auto";
    configFile?: string;
    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? configFile? debug? exclude? excludeDependents? expectNoChanges? importFile? logFlow? logToStdErr? logVerbosity? message? onError? onEvent? onOutput? parallel? previewOnly? runProgram? showSecrets? signal? suppressOutputs? suppressProgress? target? targetDependents? 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 configFile

configFile?: string

Use the configuration values in the specified file rather than detecting the file name.

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.

Deprecated

Use previewRefresh instead.

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

clearPendingCreatescolorconfigFiledebugexcludeexcludeDependentsexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonErroronEventonOutputparallelpreviewOnlyrunProgramshowSecretssignalsuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

Generated using TypeDoc