Interface RenameOptions

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

interface RenameOptions {
    color?: "always" | "never" | "raw" | "auto";
    configFile?: string;
    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? configFile? debug? importFile? logFlow? logToStdErr? logVerbosity? onError? onOutput? showSecrets? signal? stackName suppressOutputs? suppressProgress? tracing?

Properties

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 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

colorconfigFiledebugimportFilelogFlowlogToStdErrlogVerbosityonErroronOutputshowSecretssignalstackNamesuppressOutputssuppressProgresstracing

Generated using TypeDoc