Interface ImportOptions

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

interface ImportOptions {
    color?: "always" | "never" | "raw" | "auto";
    configFile?: string;
    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? configFile? converter? converterArgs? debug? generateCode? importFile? logFlow? logToStdErr? logVerbosity? message? nameTable? onOutput? protect? resources? showSecrets? 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 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

colorconfigFileconverterconverterArgsdebuggenerateCodeimportFilelogFlowlogToStdErrlogVerbositymessagenameTableonOutputprotectresourcesshowSecretssuppressOutputssuppressProgresstracing

Generated using TypeDoc