Interface UpOptions

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

interface UpOptions {
    color?: "always" | "never" | "raw" | "auto";
    continueOnError?: boolean;
    debug?: boolean;
    diff?: boolean;
    expectNoChanges?: boolean;
    importFile?: string;
    logFlow?: boolean;
    logToStdErr?: boolean;
    logVerbosity?: number;
    message?: string;
    onEvent?: ((event) => void);
    onOutput?: ((out) => void);
    parallel?: number;
    plan?: string;
    policyPackConfigs?: string[];
    policyPacks?: string[];
    program?: PulumiFn;
    refresh?: boolean;
    replace?: string[];
    showSecrets?: boolean;
    suppressOutputs?: boolean;
    suppressProgress?: boolean;
    target?: string[];
    targetDependents?: boolean;
    tracing?: string;
    userAgent?: string;
}

Hierarchy (view full)

Properties

color? continueOnError? debug? diff? expectNoChanges? importFile? logFlow? logToStdErr? logVerbosity? message? onEvent? onOutput? parallel? plan? policyPackConfigs? policyPacks? program? refresh? replace? showSecrets? suppressOutputs? suppressProgress? target? targetDependents? tracing? userAgent?

Properties

Optional color

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

Colorize output.

Optional continueOnError

continueOnError?: boolean

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

Optional debug

debug?: boolean

Print detailed debugging output during resource operations

Optional diff

diff?: boolean

Optional expectNoChanges

expectNoChanges?: boolean

Optional importFile

importFile?: string

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

Optional logFlow

logFlow?: boolean

Flow log settings to child processes (like plugins)

Optional logToStdErr

logToStdErr?: boolean

Log to stderr instead of to files

Optional logVerbosity

logVerbosity?: number

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

Optional message

message?: string

Optional onEvent

onEvent?: ((event) => void)

Type declaration

Optional onOutput

onOutput?: ((out) => void)

Type declaration

    • (out): void

    • Parameters

      • out: string

      Returns void

Optional parallel

parallel?: number

Optional plan

plan?: string

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

Optional policyPackConfigs

policyPackConfigs?: string[]

Optional policyPacks

policyPacks?: string[]

Optional program

program?: PulumiFn

Optional refresh

refresh?: boolean

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

Optional replace

replace?: string[]

Optional showSecrets

showSecrets?: boolean

Include secrets in the UpSummary.

Optional suppressOutputs

suppressOutputs?: boolean

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

Optional suppressProgress

suppressProgress?: boolean

Suppress display of periodic progress dots

Optional target

target?: string[]

Optional targetDependents

targetDependents?: boolean

Optional tracing

tracing?: string

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

Optional userAgent

userAgent?: string

Settings

Member Visibility

Theme

On This Page

colorcontinueOnErrordebugdiffexpectNoChangesimportFilelogFlowlogToStdErrlogVerbositymessageonEventonOutputparallelplanpolicyPackConfigspolicyPacksprogramrefreshreplaceshowSecretssuppressOutputssuppressProgresstargettargetDependentstracinguserAgent

Generated using TypeDoc