@pulumi/pulumi - v3.253.0
    Preparing search index...

    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: string) => void;
        onEvent?: (event: EngineEvent) => void;
        onOutput?: (out: string) => 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 Summary)

    Index

    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

    clearPendingCreates?: boolean

    Clear all pending creates, dropping them from the state

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

    Colorize output.

    configFile?: string

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

    debug?: boolean

    Print detailed debugging output during resource operations.

    exclude?: string[]

    Specify a set of resource URNs to exclude from operations.

    excludeDependents?: boolean

    Exclude dependents of targets specified with exclude.

    expectNoChanges?: boolean

    Return an error if any changes occur during this operation.

    importFile?: string

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

    logFlow?: boolean

    Flow log settings to child processes (like plugins)

    logToStdErr?: boolean

    Log to stderr instead of to files.

    logVerbosity?: number

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

    message?: string

    Optional message to associate with the operation.

    onError?: (err: string) => void

    A callback to be executed when the operation produces stderr output.

    onEvent?: (event: EngineEvent) => void

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

    onOutput?: (out: string) => void

    A callback to be executed when the operation produces stdout output.

    parallel?: number

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

    previewOnly?: boolean

    Only show a preview of the refresh, but don't perform the refresh itself.

    Use previewRefresh instead.

    runProgram?: boolean

    Run the program in the workspace to perform the refresh.

    showSecrets?: boolean

    Include secrets in the operation summary.

    signal?: AbortSignal

    A signal to abort an ongoing operation.

    suppressOutputs?: boolean

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

    suppressProgress?: boolean

    Suppress display of periodic progress dots.

    target?: string[]

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

    targetDependents?: boolean

    Operate on dependent targets discovered but not specified in targets.

    tracing?: string

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

    userAgent?: string

    A custom user agent to use when executing the operation.

    Settings

    Member Visibility

    On This Page

    Properties