Skip to content

AppProps

Initialization props for apps.

Initializer

import { AppProps } from '@alicloud/ros-cdk-core'
const appProps: AppProps = { ... }

Properties

Name Type Description
autoSynth boolean Automatically call 'synth()' before the program exits.
context {[ key: string ]: string} Additional context values for the application.
outdir string The output directory into which to emit synthesized artifacts.
runtimeInfo boolean Include runtime versioning information.
stackTraces boolean Include construct creation stack trace.
treeMetadata boolean Include construct tree metadata as part of the Cloud Assembly.

autoSynthOptional

public readonly autoSynth: boolean;
  • Type: boolean

Automatically call 'synth()' before the program exits.

If you set this, you don't have to call 'synth()' explicitly. Note that this feature is only available for certain programming languages, and calling 'synth()' is still recommended.

Default true if running via CDK CLI ('CDK_OUTDIR' is set), 'false' otherwise


contextOptional

public readonly context: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
  • Default: no additional context

Additional context values for the application.

Context set by the CLI or the 'context' key in 'cdk.json' has precedence.

Context can be read from any construct using 'node.getContext(key)'.


outdirOptional

public readonly outdir: string;
  • Type: string

The output directory into which to emit synthesized artifacts.

Default - If this value is not set, considers the environment variable 'CDK_OUTDIR'. If 'CDK_OUTDIR' is not defined, uses a temp directory.


runtimeInfoOptional

public readonly runtimeInfo: boolean;
  • Type: boolean
  • Default: true runtime info is included unless related comtext is set.

Include runtime versioning information.


stackTracesOptional

public readonly stackTraces: boolean;
  • Type: boolean
  • Default: true stack traces are included unless related context is set.

Include construct creation stack trace.


treeMetadataOptional

public readonly treeMetadata: boolean;
  • Type: boolean
  • Default: true

Include construct tree metadata as part of the Cloud Assembly.