aws-cdk

variable aliases

const aliases: string[];

variable CI

let CI: boolean;

variable command

const command: string;

variable describe

const describe: string;

variable logLevel

let logLevel: LogLevel;

function availableInitTemplates

availableInitTemplates: () => Promise<InitTemplate[]>;

function cached

cached: <A extends object, B>(obj: A, sym: symbol, fn: () => B) => B;

• Deprecated

function cli

cli: (args?: string[]) => void;

function data

data: (fmt: string, ...args: unknown[]) => void;

function debug

debug: (fmt: string, ...args: unknown[]) => false | void;

function enableTracing

enableTracing: (_enabled: boolean) => void;

• Enable tracing in the CDK

  Deprecated

  cannot be enabled from outside the CDK

function error

error: (fmt: string, ...args: unknown[]) => void;

function exec

exec: (args: string[], synthesizer?: Synthesizer) => Promise<number | void>;

function execProgram

execProgram: (
    aws: SdkProvider,
    ioHelper: IoHelper,
    config: Configuration
) => Promise<ExecProgramResult>;

• Invokes the cloud executable and returns JSON output

function formatAsBanner

formatAsBanner: (msgs: string[]) => string[];

• Returns a set of strings when printed on the console produces a banner msg. The message is in the following format - ******************** *** msg line x *** *** msg line xyz *** ********************

  Spec: - The width of every line is equal, dictated by the longest message string - The first and last lines are '*'s for the full length of the line - Each line in between is prepended with '*** ' and appended with ' ***' - The text is indented left, i.e. whitespace is right-padded when the length is shorter than the longest.

  Parameter msgs

  array of strings containing the message lines to be printed in the banner. Returns empty string if array is empty.

  Returns

  array of strings containing the message formatted as a banner

function highlight

highlight: (fmt: string, ...args: unknown[]) => void;

function increaseVerbosity

increaseVerbosity: () => void;

function prefix

prefix: (prefixString: string, fn: LoggerFunction) => LoggerFunction;

• Create a logger output that features a constant prefix string.

  Parameter prefixString

  the prefix string to be appended before any log entry.

  Parameter fn

  the logger function to be used (typically one of the other functions in this module)

  Returns

  a new LoggerFunction.

function print

print: (fmt: string, ...args: unknown[]) => void;

function rootDir

rootDir: { (): string; (fail: true): string; (fail: false): string };

• From the current file, find the directory that contains the CLI's package.json

  Can't use __dirname in production code, as the CLI will get bundled as it's released and __dirname will refer to a different location in the .ts form as it will in the final executing form.

function setCI

setCI: (newCI: boolean) => void;

function setLogLevel

setLogLevel: (newLogLevel: LogLevel) => void;

function success

success: (fmt: string, ...args: unknown[]) => void;

function trace

trace: (fmt: string, ...args: unknown[]) => false | void;

function versionNumber

versionNumber: () => string;

function warning

warning: (fmt: string, ...args: unknown[]) => void;

function withCorkedLogging

withCorkedLogging: <A>(block: () => Promise<A>) => Promise<A>;

type LoggerFunction

type LoggerFunction = (fmt: string, ...args: unknown[]) => void;